tencentcloud-sdk-nodejs-mqtt 4.0.1027 → 4.0.1034

package/README.md

@@ -1,21 +1,20 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
-为方便 NODEJS 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 NODEJS 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
+欢迎使用腾讯云开发者工具套件（SDK），Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
+为方便 Node.js 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 Node.js 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
 
 # 依赖环境
 
-1. NODEJS 10.0.0 版本及以上
-2. 从腾讯云控制台 开通相应产品
-3. 获取 SecretID、SecretKey 以及调用地址（endpoint），endpoint 一般形式为\*.tencentcloudapi.com，如 CVM 的调用地址为 cvm.tencentcloudapi.com，具体参考各产品说明。
+1. Node.js 10.0.0 版本及以上。
+2. 注意：部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
 
 # 获取安装
 
-安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
+使用 SDK 需要 API 密钥，可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请，API 密钥包括 SecretID 和 SecretKey，密钥须严格保管，避免泄露。
 
-## 通过 NPM 安装
+## 通过 npm 安装
 
-通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法，NPM 是 NODEJS 的包管理工具。关于 NPM 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
+通过 npm 获取安装是使用 Node.js SDK 的推荐方法，关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
 
 ### 安装指定产品 SDK（推荐）
 
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
 1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
 2. 解压源码包到您项目合适的位置，例如 `sdk/tencentcloud-sdk-nodejs`。
 3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
-4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入SDK，具体可参考示例。
+4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK，具体可参考示例。
 
 # 示例
 
+以云服务器产品查询可用区列表接口为例。
+
 ```js
 const tencentcloud = require("tencentcloud-sdk-nodejs")
 
@@ -102,7 +103,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -112,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 // ...
 ```
 
-实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
+实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
 
 ## Common Client
-从 4.0.714 版本开始腾讯云 NODEJS SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
+
+从 4.0.714 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
 
 **注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
 
@@ -123,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 
 ## 更多示例
 
-更丰富的使用 demo 请在 examples 目录中寻找。
+请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
 
 # 相关配置
 
 ## 代理
 
-如果是有代理的环境下，需要配置代理，请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
+如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
 
 # 凭证管理
 
 除显式传入凭证外，从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
 
-在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
+在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
 ```javascript
 // ...
 const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -147,20 +149,16 @@ new XxxClient({
 })
 ```
 
-# 旧版 SDK
-
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
-
 # 常见问题
-- webpack打包出错/浏览器报错
+- webpack 打包出错/浏览器报错
 
-  请**务必不要**将此SDK直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
+  请**务必不要**将此 SDK 直接用于 Web 前端（包括小程序等），暴露密钥在这些环境非常不安全。
 
-  正确的做法是在自己的服务端引用此SDK，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
+  正确的做法是在自己的服务端引用此 SDK，并保存好密钥，做好请求鉴权，前端再调用服务端执行业务流程。
 
 - `The "original" argument must be of type Function.`
 
-  通常是因为nodejs版本低于 `v10` ，或处于非node环境，请再次确认执行环境。
+  通常是因为 Node.js 版本低于 `v10` ，或处于非 Node.js 环境，请再次确认执行环境。
 
 - 请求不通
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-mqtt",
-  "version": "4.0.1027",
+  "version": "4.0.1034",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/src/services/mqtt/v20240516/mqtt_client.ts

@@ -19,28 +19,32 @@ import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
   DeleteUserRequest,
   ModifyJWTAuthenticatorResponse,
-  UpdateAuthorizationPolicyPriorityRequest,
+  CaCertificateItem,
+  ModifyAuthorizationPolicyResponse,
   ActivateDeviceCertificateRequest,
   CreateInstanceResponse,
-  DescribeAuthenticatorRequest,
+  ApplyRegistrationCodeRequest,
   ModifyJWTAuthenticatorRequest,
   AuthorizationPolicyPriority,
   ModifyInstanceRequest,
   DeleteTopicRequest,
   ModifyUserResponse,
+  DescribeCaCertificateResponse,
   DescribeDeviceCertificatesRequest,
   DeleteAuthenticatorRequest,
   PublicAccessRule,
   VpcInfo,
   DeleteAuthorizationPolicyResponse,
+  ProductSkuItem,
   ModifyJWKSAuthenticatorRequest,
-  DeleteInstanceResponse,
+  RegisterCaCertificateResponse,
   RegisterDeviceCertificateResponse,
   MQTTAuthenticatorItem,
   Tag,
   DescribeDeviceCertificateRequest,
   MQTTInstanceItem,
   DescribeInstanceListResponse,
+  ApplyRegistrationCodeResponse,
   ModifyInstanceResponse,
   ModifyInsPublicEndpointResponse,
   ModifyJWKSAuthenticatorResponse,
@@ -48,21 +52,27 @@ import {
   CreateUserResponse,
   CreateAuthorizationPolicyRequest,
   DescribeAuthenticatorResponse,
+  DeactivateCaCertificateResponse,
+  DeleteCaCertificateRequest,
   DeleteDeviceCertificateRequest,
   DescribeInsPublicEndpointsRequest,
   DeleteUserResponse,
+  ActivateCaCertificateResponse,
   DeleteDeviceCertificateResponse,
-  ModifyAuthorizationPolicyResponse,
+  DeleteInstanceResponse,
+  DescribeProductSKUListResponse,
   CreateJWKSAuthenticatorRequest,
   DescribeTopicResponse,
   CreateJWKSAuthenticatorResponse,
   DescribeAuthorizationPoliciesResponse,
   CreateTopicRequest,
+  DeleteCaCertificateResponse,
   TagFilter,
   DescribeUserListResponse,
   ModifyTopicResponse,
   DeactivateDeviceCertificateResponse,
   MQTTUserItem,
+  ActivateCaCertificateRequest,
   ActivateDeviceCertificateResponse,
   DescribeTopicRequest,
   UpdateAuthorizationPolicyPriorityResponse,
@@ -73,6 +83,8 @@ import {
   AuthorizationPolicyItem,
   RevokedDeviceCertificateRequest,
   CreateAuthorizationPolicyResponse,
+  DescribeAuthenticatorRequest,
+  RegisterCaCertificateRequest,
   CreateInstanceRequest,
   CreateInsPublicEndpointRequest,
   RegisterDeviceCertificateRequest,
@@ -82,24 +94,33 @@ import {
   ModifyTopicRequest,
   CreateUserRequest,
   DescribeInstanceResponse,
+  ModifyInstanceCertBindingResponse,
   DeleteInstanceRequest,
   DescribeInsPublicEndpointsResponse,
   ModifyInsPublicEndpointRequest,
   DeleteInsPublicEndpointRequest,
   DescribeUserListRequest,
+  DescribeCaCertificateRequest,
+  UpdateAuthorizationPolicyPriorityRequest,
   CreateJWTAuthenticatorResponse,
   DeleteAuthorizationPolicyRequest,
   DescribeAuthorizationPoliciesRequest,
-  RevokedDeviceCertificateResponse,
+  DescribeProductSKUListRequest,
+  DescribeTopicListResponse,
   DescribeDeviceCertificateResponse,
   DescribeInstanceListRequest,
+  DeactivateCaCertificateRequest,
   CreateJWTAuthenticatorRequest,
+  DescribeCaCertificatesRequest,
   DeviceCertificateItem,
   MQTTTopicItem,
+  PriceTag,
   ModifyAuthorizationPolicyRequest,
-  DescribeTopicListResponse,
+  RevokedDeviceCertificateResponse,
   DeleteTopicResponse,
+  ModifyInstanceCertBindingRequest,
   DescribeInstanceRequest,
+  DescribeCaCertificatesResponse,
   ModifyUserRequest,
   DeleteAuthenticatorResponse,
   IpRule,
@@ -115,13 +136,15 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 购买新的MQTT实例
-   */
-  async CreateInstance(
-    req: CreateInstanceRequest,
-    cb?: (error: string, rep: CreateInstanceResponse) => void
-  ): Promise<CreateInstanceResponse> {
-    return this.request("CreateInstance", req, cb)
+     * 查询用户列表，Filter参数使用说明如下：
+
+1. Username，用户名称模糊搜索
+     */
+  async DescribeUserList(
+    req: DescribeUserListRequest,
+    cb?: (error: string, rep: DescribeUserListResponse) => void
+  ): Promise<DescribeUserListResponse> {
+    return this.request("DescribeUserList", req, cb)
   }
 
   /**
@@ -144,6 +167,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("ModifyTopic", req, cb)
   }
 
+  /**
+   * 删除Ca证书
+   */
+  async DeleteCaCertificate(
+    req: DeleteCaCertificateRequest,
+    cb?: (error: string, rep: DeleteCaCertificateResponse) => void
+  ): Promise<DeleteCaCertificateResponse> {
+    return this.request("DeleteCaCertificate", req, cb)
+  }
+
   /**
    * 失效Ca证书
    */
@@ -164,6 +197,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeTopic", req, cb)
   }
 
+  /**
+   * 失效Ca证书
+   */
+  async DeactivateCaCertificate(
+    req: DeactivateCaCertificateRequest,
+    cb?: (error: string, rep: DeactivateCaCertificateResponse) => void
+  ): Promise<DeactivateCaCertificateResponse> {
+    return this.request("DeactivateCaCertificate", req, cb)
+  }
+
   /**
    * 创建一个jwks的认证
    */
@@ -234,18 +277,6 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeInsPublicEndpoints", req, cb)
   }
 
-  /**
-     * 查询用户列表，Filter参数使用说明如下：
-
-1. Username，用户名称模糊搜索
-     */
-  async DescribeUserList(
-    req: DescribeUserListRequest,
-    cb?: (error: string, rep: DescribeUserListResponse) => void
-  ): Promise<DescribeUserListResponse> {
-    return this.request("DescribeUserList", req, cb)
-  }
-
   /**
    * 更新MQTT实例公网接入点
    */
@@ -256,6 +287,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("ModifyInsPublicEndpoint", req, cb)
   }
 
+  /**
+   * 查询设备证书详情接口
+   */
+  async DescribeDeviceCertificate(
+    req: DescribeDeviceCertificateRequest,
+    cb?: (error: string, rep: DescribeDeviceCertificateResponse) => void
+  ): Promise<DescribeDeviceCertificateResponse> {
+    return this.request("DescribeDeviceCertificate", req, cb)
+  }
+
   /**
    * 注册设备证书
    */
@@ -266,6 +307,47 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("RegisterDeviceCertificate", req, cb)
   }
 
+  /**
+     * 更新MQTT集群绑定证书
+参数传空，则为删除证书
+     */
+  async ModifyInstanceCertBinding(
+    req: ModifyInstanceCertBindingRequest,
+    cb?: (error: string, rep: ModifyInstanceCertBindingResponse) => void
+  ): Promise<ModifyInstanceCertBindingResponse> {
+    return this.request("ModifyInstanceCertBinding", req, cb)
+  }
+
+  /**
+   * 获取产品售卖规格
+   */
+  async DescribeProductSKUList(
+    req?: DescribeProductSKUListRequest,
+    cb?: (error: string, rep: DescribeProductSKUListResponse) => void
+  ): Promise<DescribeProductSKUListResponse> {
+    return this.request("DescribeProductSKUList", req, cb)
+  }
+
+  /**
+   * 查询集群下的ca证书信息
+   */
+  async DescribeCaCertificates(
+    req: DescribeCaCertificatesRequest,
+    cb?: (error: string, rep: DescribeCaCertificatesResponse) => void
+  ): Promise<DescribeCaCertificatesResponse> {
+    return this.request("DescribeCaCertificates", req, cb)
+  }
+
+  /**
+   * 修改策略规则优先级
+   */
+  async UpdateAuthorizationPolicyPriority(
+    req: UpdateAuthorizationPolicyPriorityRequest,
+    cb?: (error: string, rep: UpdateAuthorizationPolicyPriorityResponse) => void
+  ): Promise<UpdateAuthorizationPolicyPriorityResponse> {
+    return this.request("UpdateAuthorizationPolicyPriority", req, cb)
+  }
+
   /**
    * 创建主题
    */
@@ -296,6 +378,19 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeAuthorizationPolicies", req, cb)
   }
 
+  /**
+     * 获取主题列表，Filter参数使用说明如下：
+
+1. TopicName，主题名称模糊搜索
+2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
+     */
+  async DescribeTopicList(
+    req: DescribeTopicListRequest,
+    cb?: (error: string, rep: DescribeTopicListResponse) => void
+  ): Promise<DescribeTopicListResponse> {
+    return this.request("DescribeTopicList", req, cb)
+  }
+
   /**
    * 删除MQTT实例的公网接入点
    */
@@ -307,13 +402,13 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 查询设备证书详情接口
+   * 购买新的MQTT实例
    */
-  async DescribeDeviceCertificate(
-    req: DescribeDeviceCertificateRequest,
-    cb?: (error: string, rep: DescribeDeviceCertificateResponse) => void
-  ): Promise<DescribeDeviceCertificateResponse> {
-    return this.request("DescribeDeviceCertificate", req, cb)
+  async CreateInstance(
+    req: CreateInstanceRequest,
+    cb?: (error: string, rep: CreateInstanceResponse) => void
+  ): Promise<CreateInstanceResponse> {
+    return this.request("CreateInstance", req, cb)
   }
 
   /**
@@ -352,16 +447,23 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-     * 获取主题列表，Filter参数使用说明如下：
+   * 删除MQTT主题
+   */
+  async DeleteTopic(
+    req: DeleteTopicRequest,
+    cb?: (error: string, rep: DeleteTopicResponse) => void
+  ): Promise<DeleteTopicResponse> {
+    return this.request("DeleteTopic", req, cb)
+  }
 
-1. TopicName，主题名称模糊搜索
-2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
-     */
-  async DescribeTopicList(
-    req: DescribeTopicListRequest,
-    cb?: (error: string, rep: DescribeTopicListResponse) => void
-  ): Promise<DescribeTopicListResponse> {
-    return this.request("DescribeTopicList", req, cb)
+  /**
+   * 查询Ca证书详情接口
+   */
+  async DescribeCaCertificate(
+    req: DescribeCaCertificateRequest,
+    cb?: (error: string, rep: DescribeCaCertificateResponse) => void
+  ): Promise<DescribeCaCertificateResponse> {
+    return this.request("DescribeCaCertificate", req, cb)
   }
 
   /**
@@ -424,6 +526,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DeleteAuthenticator", req, cb)
   }
 
+  /**
+   * 注册ca证书
+   */
+  async RegisterCaCertificate(
+    req: RegisterCaCertificateRequest,
+    cb?: (error: string, rep: RegisterCaCertificateResponse) => void
+  ): Promise<RegisterCaCertificateResponse> {
+    return this.request("RegisterCaCertificate", req, cb)
+  }
+
   /**
    * 查询MQTT认证器
    */
@@ -435,13 +547,13 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 修改策略规则优先级
+   * 激活Ca证书
    */
-  async UpdateAuthorizationPolicyPriority(
-    req: UpdateAuthorizationPolicyPriorityRequest,
-    cb?: (error: string, rep: UpdateAuthorizationPolicyPriorityResponse) => void
-  ): Promise<UpdateAuthorizationPolicyPriorityResponse> {
-    return this.request("UpdateAuthorizationPolicyPriority", req, cb)
+  async ActivateCaCertificate(
+    req: ActivateCaCertificateRequest,
+    cb?: (error: string, rep: ActivateCaCertificateResponse) => void
+  ): Promise<ActivateCaCertificateResponse> {
+    return this.request("ActivateCaCertificate", req, cb)
   }
 
   /**
@@ -455,13 +567,13 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 删除MQTT主题
+   * 申请ca注册码
    */
-  async DeleteTopic(
-    req: DeleteTopicRequest,
-    cb?: (error: string, rep: DeleteTopicResponse) => void
-  ): Promise<DeleteTopicResponse> {
-    return this.request("DeleteTopic", req, cb)
+  async ApplyRegistrationCode(
+    req: ApplyRegistrationCodeRequest,
+    cb?: (error: string, rep: ApplyRegistrationCodeResponse) => void
+  ): Promise<ApplyRegistrationCodeResponse> {
+    return this.request("ApplyRegistrationCode", req, cb)
   }
 
   /**