tenyun v0.11.0

TenYun

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

设计

核心包通过实例化后两次Proxy动态代理，第一层代理 产品标识，第二层代理产品服务 实现了通过一个实例接入腾讯云各产品服务的能力，默认为最新版本的接口接入，同时提供往期版本(通过第二参数传递X-TC-Version头)的接入能力。

使用

npm install tenyun

import TenYun from 'tenyun';

const secretId = 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******';
const secretKey = 'Gu5t9xGARNpq86cd98joQYCN3*******';

const tc = new TenYun(secretId, secretKey);

const sampleRequest = {Limit: 1, Filters: [ { Values: [ '未命名' ], Name: 'instance-name' } ]};

tc.cvm.DescribeInstances(sampleRequest)
.then(({ data }) => console.info(data))
.catch((error) => console.error(error.code));

(async () => {
  try {
    const { data } = await tc.cvm.DescribeInstances(sampleRequest);
    console.info(data);
  } catch(error) {
    console.error(error);
  }
})();

// provide the second object, AKA AxiosRequestConfig, to request the specific `X-TC-Version` API
tc.sms.DescribeSmsSignList({ SignIdSet: [123], International: 0 }, { headers: { 'X-TC-Version': '2019-07-11' } })
.then(({ data }) => console.info(data))
.catch((error) => console.error(error.code));

// none documentation APIs
tc.tcbr.DescribeArchitectureType()
.then(({ data }) => console.info(data))
.catch((error) => console.error(error.code));

console.info(tc);

TenYun {
  cvm: [Function: cvm.tencentcloudapi.com] {
    DescribeInstances: [AsyncFunction: DescribeInstances]
  },
  sms: [Function: sms.tencentcloudapi.com] {
    DescribeSmsSignList: [AsyncFunction: DescribeSmsSignList]
  },
  tcbr: [Function: tcbr.tencentcloudapi.com] {
    DescribeArchitectureType: [AsyncFunction: DescribeArchitectureType]
  },
  [Symbol(SECRET_ID)]: 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3*******',
  [Symbol(SECRET_KEY)]: SecretKeyObject { [Symbol(kKeyType)]: 'secret' }
}

API

new TenYun(SecretId: string, SecretKey: BinaryLike, Token?: string, Region?: string)

tenYun[ServiceShortName]() => string[]

返回支持的服务版本 YYYY-MM-DD 格式字符串数组，DESC 排序。

tenYun[ServiceShortName][ActionName](data?: any, config?: AxiosRequestConfig) => AxiosPromise

请求对应产品的服务。

tenYun.client => AxiosInstance

返回 Axios 实例。

支持的产品及服务

其他

types 基于 tencentcloud-cli:services 及 @wxcloud/cloudapi 项目生成，其中 vpc.d.ts 及 tag.d.ts 遵循如下生成规则：vpc:$.objects.Vpc 对象在本项目内别名为 interface VpcInfo ，tag:$.objects.Tag 别名为 interface TagInfo ，以消除与模块module重名而产生的歧义。

License

MIT