ksyun-sdk-node 1.0.1

package/src/base/BaseClient.js

@@ -0,0 +1,92 @@
+const getSignedParams = require('../lib/sign.js').getSignedParams
+const fetch = require('../lib/fetch.js')
+const dayjs = require('dayjs')
+const utc = require('dayjs/plugin/utc.js')
+const qs = require('qs')
+
+dayjs.extend(utc)
+
+module.exports = class BaseClient {
+    _baseConfig = {}
+    _apiList = {}
+    constructor (clientConfig) {
+        this.ak = clientConfig.credential.secretId,
+        this.sk = clientConfig.credential.secretKey
+        this.region = clientConfig.region
+        this.httpProfile = clientConfig.httpProfile || {}
+
+        if (!this.ak || !this.sk) {
+            throw new Error('secretId and secretKey are required')
+        }
+    }
+    /**
+     * 发起请求
+     * @param {string} apiAction 接口名
+     * @param {object} data 参数 { body, query }
+     */
+    request (apiAction, params = {}) {
+
+        let apiConfig = this._apiList[apiAction]
+        let publicParams = {
+            Accesskey: this.ak,
+            Service: this._baseConfig.config.credentials.service,
+            Action: apiAction,
+            Version: apiConfig.config.query.Version,
+            Timestamp: dayjs().utc().format('YYYY-MM-DDThh:mm:ss')+'Z',
+            SignatureVersion: '1.0',
+            SignatureMethod: 'HMAC-SHA256',
+            Region: this.region || this._baseConfig.config.credentials.region,
+        }
+
+        let combainParams = {
+            ...publicParams,
+            ...params
+        }
+
+        let signedParams = getSignedParams(combainParams, this.sk)
+
+        let protocol = this.httpProfile.protocol || this._baseConfig.protocol
+        let endpoint = this.httpProfile.endpoint || this._baseConfig.endpoint
+        let method = this.httpProfile.method || apiConfig.method
+
+        let url = `${protocol}${endpoint}${apiConfig.url}`
+        if (['GET', 'DELETE', 'OPTION', 'HEAD'].includes(method.toUpperCase())) {
+            url += `?${qs.stringify(signedParams)}`
+        }
+        let headers = {
+            ...(this._baseConfig.config.headers || {}),
+            ...(apiConfig.config.headers || {}),
+            // 目前kop只支持application/x-www-form-urlencoded类型的签名解析
+            'Content-Type': 'application/x-www-form-urlencoded',
+        }
+        let body = this.getBody(method, headers['Content-Type'], signedParams)
+
+        let timeoutSecond = this.httpProfile.timeout || this._baseConfig.config.timeout
+        return fetch(url, {
+            method: method,
+            timeout: timeoutSecond * 1000,
+            headers,
+            body
+        })
+    }
+    /**
+     * 获取body
+     * @param {string} method 请求类型
+     * @param {string} contentType
+     * @param {object} signedParams 参数对象
+     * @returns {string}
+     */
+    getBody (method, contentType, signedParams) {
+        if (!['POST', 'PUT'].includes(method.toUpperCase())) {
+            return undefined
+        }
+        // 目前只有下面这两种
+        if (contentType == 'application/x-www-form-urlencoded') {
+            return qs.stringify(signedParams)
+        }
+        if (contentType == 'application/json') {
+            return JSON.stringify(signedParams)
+        }
+        return JSON.stringify(signedParams)
+    }
+}

package/src/index.js

@@ -0,0 +1,34 @@
+const fs = require('fs')
+const path = require('path')
+
+// /xxx/node-sdk/src/service
+let servicePath = path.resolve(__dirname, './service')
+// [Iam, Kec]
+let serviceDirs = fs.readdirSync(servicePath)
+
+/**
+ * {
+ *    Iam: {
+ *       v20150101: Client
+ *    }
+ * }
+ */
+module.exports = serviceDirs.reduce((acc, serviceDir) => {
+   // /xxx/node-sdk/src/service/iam
+   let versionPath = path.resolve(servicePath, serviceDir)
+   if (fs.statSync(versionPath).isDirectory()) {
+      // [v20151101, v20160606]
+      let versionDirs = fs.readdirSync(versionPath)
+      // acc.Iam
+      acc[serviceDir] = versionDirs.reduce((accVersion, versionDir) => {
+         // /xxx/node-sdk/src/service/iam/v20151101/index.js
+         let filePath = path.resolve(versionPath, versionDir, 'index.js')
+         if (fs.existsSync(filePath)) {
+            // accVersion.v20151101
+            accVersion[versionDir] = require(filePath)
+         }
+         return accVersion
+      }, {})
+   }
+   return acc
+}, {})

package/src/lib/fetch.js

@@ -0,0 +1,35 @@
+const nodeFetch = require('node-fetch')
+const AbortController = require('abort-controller')
+// const HttpsProxyAgent = require('https-proxy-agent')
+
+
+let proxyConfig = {}
+
+// if (process.env.isKscSdkTest) {
+    // 本地代理
+    // proxyConfig = {
+    //     agent: new HttpsProxyAgent('http://localhost:9090')
+    // }
+// }
+
+module.exports = function (url, options) {
+    const controller = new AbortController();
+    if (options.timeout) {
+        setTimeout(() => {
+            controller.abort();
+        }, options.timeout);
+    }
+
+    return nodeFetch(url, {
+        signal: controller.signal,
+        ...proxyConfig,
+        ...options
+    })
+    .catch(err => {
+        if (err.type == 'aborted') {
+            return new Error('timeout')
+        } else {
+            throw err
+        }
+    })
+}

package/src/lib/sign.js

@@ -0,0 +1,148 @@
+const crypto = require("crypto-js")
+// const qs = require("qs")
+
+module.exports = {
+    getSignedParams,
+    fixedEncodeURIComponent,
+    getFlatParams,
+    flatObj,
+    getFormatParams,
+    isArrayOrObjectNotNull
+}
+
+/**
+ * 简化版签名算法
+ * @param {*} params 参数
+ * @param {*} sk
+ */
+function getSignedParams(params, sk) {
+    if (!sk) {
+        throw new Error('need sk')
+    }
+    // 第零点一步：参数扁平化处理
+    let flatParams = getFlatParams(params)
+    // 第零点二步：去除值为null的参数, boolean转字符串
+    flatParams = getFormatParams(flatParams)
+    // 第一步：请求参数排序 请求参数包括公共参数和业务参数，不包含公共参数Signature。 排序规则以参数名按照字典排序.
+    let sortParamKeys = Object.keys(flatParams).sort()
+    // 第二步：请求参数编码
+    // 使用UTF-8字符集按照RFC3986规则编码请求参数和参数取值
+    // 第三步：请求参数拼接成CanonicalizedQueryString
+    // 每对URLEncode后的参数名称和参数值，用=进行连接。每对之间使用&进行连接。得到规范化请求字符串CanonicalizedQueryString
+    let canonicalizedQueryString = sortParamKeys.map(key => {
+        let value = flatParams[key]
+        return `${fixedEncodeURIComponent(key)}=${fixedEncodeURIComponent(value)}`
+    }).join('&')
+
+    // 参见源码得qs的处理顺序-符合流程：1. 去除null 2. 排序、3. 编码 4. 按照url参数拼接
+    // let canonicalizedQueryString = qs.stringify(flatParams, {
+    //     sort: (a, b) => a.localeCompare(b),
+    //     format : 'RFC3986',
+    //     skipNulls: true,
+    //     arrayFormat: 'indices', // 数组转成a[0]
+    //     allowDots: true, // 对象转成a.b.c
+    //  } )
+
+    // 计算签名。
+    let sign = crypto.HmacSHA256(canonicalizedQueryString, sk).toString()
+
+    // 添加到请求参数
+    return {
+        ...flatParams,
+        Signature: sign
+    }
+}
+
+/**
+ * RFC 3986
+ * https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
+ * @param {*} str
+ * @returns
+ */
+function fixedEncodeURIComponent(str) {
+    // encodeURIComponent比RFC 3986少了!'()*这个几个字符的转义
+    return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {
+        return '%' + c.charCodeAt(0).toString(16).toUpperCase();
+    });
+}
+
+/**
+ * 格式化参数，对Array,Filter(Object),Object类型做扁平处理
+ * @example
+ * 转换前：{ arr: [1,2], filter: {1: {a: 1}} }
+ * 转换后：{ 'arr[0]':1, 'arr[1]':2, 'filter.1.a': 1 }
+ * @param {string} apiAction 接口名
+ * @param {object} params 参数值
+ * @returns 格式化后的参数
+ */
+ function getFlatParams (params) {
+    let res = {}
+    Object.keys(params).forEach(key => {
+        let value = params[key]
+        if (isArrayOrObjectNotNull(value)) {
+            res = {
+                ...res,
+                ...flatObj(key, params[key])
+            }
+        } else {
+            res[key] = value
+        }
+    })
+    return res
+}
+
+/**
+ * 扁平化对象
+ * @param {string} pKey key
+ * @param {*} value 对象或者数组，非null
+ * @returns
+ */
+function flatObj (pKey, value) {
+    let res = {}
+    let prefixName = ''
+
+    Object.keys(value).forEach((key) => {
+        if (Array.isArray(value)) {
+            prefixName = `${pKey}[${key}]`
+        } else {
+            prefixName = `${pKey}.${key}`
+        }
+        let childValue = value[key]
+        if (isArrayOrObjectNotNull(childValue)) {
+            res = {
+                ...res,
+                ...flatObj(prefixName, childValue)
+            }
+        } else {
+            res[prefixName] = childValue
+        }
+    })
+    return res
+}
+
+/**
+ * 1. 剔除null、undefined,
+ * 2. boolean转字符串
+ * @param {object} params 参数对象
+ * @returns {object}
+ */
+function getFormatParams (params) {
+    Object.keys(params).forEach(key => {
+        if (params[key] == null) {
+            delete params[key]
+        }
+        if (Object.prototype.toString.call(params[key]) == '[object Boolean]') {
+            params[key] = params[key].toString()
+        }
+    })
+    return params
+}
+
+/**
+ * 是否为数组或者对象，非null
+ * @param {any} value
+ * @returns {boolean}
+ */
+function isArrayOrObjectNotNull (value) {
+    return Array.isArray(value) || Object.prototype.toString.call(value) == '[object Object]'
+}

package/src/service/Actiontrail/v20190401/index.js

@@ -0,0 +1,47 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'actiontrail.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'actiontrail',
+            },
+        },
+    }
+    _apiList = {
+        'ListOperateLogs': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2019-04-01',
+                    'Action': 'ListOperateLogs',
+                },
+                'headers': {
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                },
+            },
+            'paramsType': {
+                'EventName': 'String',
+                'EventRw': 'String',
+                'ServiceName': 'String',
+                'UserName': 'String',
+                'AccessKey': 'String',
+                'EventBeginDate': 'String',
+                'EventEndDate': 'String',
+                'ResourceType': 'String',
+                'ResourceName': 'String',
+                'Page': 'String',
+                'PageSize': 'String',
+                'SearchAfter': 'String',
+            }
+        },
+    }
+}

package/src/service/Bill/v20180601/index.js

@@ -0,0 +1,111 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'bill.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'bill',
+            },
+        },
+    }
+    _apiList = {
+        'GetMonthBill': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'GetMonthBill',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'Action': 'String',
+            }
+        },
+        'GetPostpayDetailBill': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'GetPostpayDetailBill',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'GetPostpayDetailBillCSV': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'GetPostpayDetailBillCSV',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'GetProductCode': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'GetProductCode',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'getMonthConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'getMonthConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'getPostpayDetailConsume': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2018-06-01',
+                    'Action': 'getPostpayDetailConsume',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+    }
+}

package/src/service/Bill_union/v20200101/index.js

@@ -0,0 +1,112 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'bill-union.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'bill-union',
+            },
+        },
+    }
+    _apiList = {
+        'DescribeBillSummaryByPayMode': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeBillSummaryByPayMode',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'DescribeBillSummaryByProduct': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeBillSummaryByProduct',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'DescribeBillSummaryByProject': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeBillSummaryByProject',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+                'BillBeginMonth': 'String',
+                'BillEndMonth': 'String',
+            }
+        },
+        'DescribeInstanceSummaryBills': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeInstanceSummaryBills',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'DescribeProductCode': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeProductCode',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+        'DescribeSplitItemBillDetails': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2020-01-01',
+                    'Action': 'DescribeSplitItemBillDetails',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+    }
+}

package/src/service/Bill_union/v20211209/index.js

@@ -0,0 +1,35 @@
+const BaseClient = require("../../../base/BaseClient.js");
+
+module.exports = class Client extends BaseClient {
+    _baseConfig = {
+        'protocol': 'http://',
+        'endpoint': 'bill-union.api.ksyun.com',
+        'config': {
+            'timeout': 60,  //设置timeout
+            'headers': {
+                'Accept': 'application/json'
+            },
+            'credentials': {
+                'region': 'cn-shanghai-3',
+                'service': 'bill-union',
+            },
+        },
+    }
+    _apiList = {
+        'DescribeCostBill': {
+            'url': '/',
+            'method': 'GET',
+            'config': {
+                'query': {
+                    'Version': '2021-12-09',
+                    'Action': 'DescribeCostBill',
+                },
+                'headers': {
+                    'Content-Type': 'application/json'
+                },
+            },
+            'paramsType': {
+            }
+        },
+    }
+}