tencentcloud-sdk-nodejs-mqtt 4.1.5 → 4.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-mqtt",
-  "version": "4.1.5",
+  "version": "4.1.6",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/services/mqtt/v20240516/mqtt_client.d.ts

@@ -77,7 +77,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DescribeDeviceCertificate(req: DescribeDeviceCertificateRequest, cb?: (error: string, rep: DescribeDeviceCertificateResponse) => void): Promise<DescribeDeviceCertificateResponse>;
     /**
-     * 注册设备证书
+     * 注册设备证书（仅一机一证场景生效），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8)
      */
     RegisterDeviceCertificate(req: RegisterDeviceCertificateRequest, cb?: (error: string, rep: RegisterDeviceCertificateResponse) => void): Promise<RegisterDeviceCertificateResponse>;
     /**
@@ -186,7 +186,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DeleteAuthenticator(req: DeleteAuthenticatorRequest, cb?: (error: string, rep: DeleteAuthenticatorResponse) => void): Promise<DeleteAuthenticatorResponse>;
     /**
-     * 注册ca证书
+     * 注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
      */
     RegisterCaCertificate(req: RegisterCaCertificateRequest, cb?: (error: string, rep: RegisterCaCertificateResponse) => void): Promise<RegisterCaCertificateResponse>;
     /**

package/tencentcloud/services/mqtt/v20240516/mqtt_client.js

@@ -133,7 +133,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeDeviceCertificate", req, cb);
     }
     /**
-     * 注册设备证书
+     * 注册设备证书（仅一机一证场景生效），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8)
      */
     async RegisterDeviceCertificate(req, cb) {
         return this.request("RegisterDeviceCertificate", req, cb);
@@ -292,7 +292,7 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DeleteAuthenticator", req, cb);
     }
     /**
-     * 注册ca证书
+     * 注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
      */
     async RegisterCaCertificate(req, cb) {
         return this.request("RegisterCaCertificate", req, cb);

package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts

@@ -313,27 +313,30 @@ export interface ModifyUserResponse {
  */
 export interface DescribeCaCertificateResponse {
     /**
-     * 创建时间
+     * 创建时间，毫秒级时间戳 。
      */
     CreatedTime?: number;
     /**
-     * 上次更新时间
+     * 上次更新时间，毫秒级时间戳 。
      */
     UpdateTime?: number;
     /**
-     * 失效日期
+     * 失效日期，毫秒级时间戳 。
      */
     NotAfterTime?: number;
     /**
-     * 上次激活时间
+     * 上次激活时间，毫秒级时间戳 。
      */
     LastActivationTime?: number;
     /**
-     * 上次吊销时间
+     * 上次吊销时间，毫秒级时间戳 。
      */
     LastInactivationTime?: number;
     /**
-     * 证书状态
+     * CA证书状态
+   ACTIVE：激活
+  INACTIVE：未激活
+  
      */
     Status?: string;
     /**
@@ -341,7 +344,7 @@ export interface DescribeCaCertificateResponse {
      */
     CaSn?: string;
     /**
-     * common name
+     * 证书的CN（Common Name），证书中用于标识主体的名称，通常是域名或组织名称
      */
     CaCn?: string;
     /**
@@ -349,7 +352,7 @@ export interface DescribeCaCertificateResponse {
      */
     CaCertificate?: string;
     /**
-     * 证书格式
+     * 证书格式，当仅支持PEM格式
      */
     Format?: string;
     /**
@@ -357,7 +360,7 @@ export interface DescribeCaCertificateResponse {
      */
     CaIssuerCn?: string;
     /**
-     * 生效开始时间
+     * 生效开始时间，毫秒级时间戳 。
      */
     NotBeforeTime?: number;
     /**
@@ -370,32 +373,33 @@ export interface DescribeCaCertificateResponse {
  */
 export interface DescribeDeviceCertificatesRequest {
     /**
-     * 实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
      * 支持搜索参数
-  ClientId：客户端id
-  CaSn：所属的CA证书SN
-  DeviceCertificateSn：设备证书SN
-  DeviceCertificateCn：设备证书CN
+  ClientId：客户端id，根据实际业务使用获取
+  CaSn：所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
+  DeviceCertificateSn：设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
+  DeviceCertificateCn：设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
   OrganizationalUnit：证书OU
   NotAfterEnd：过期时间小于等于指定时间的证书
   NotAfterStart：过期时间大于等于指定时间的证书
-  Status：证书状态
+  Status：设备证书状态     ACTIVE（激活）； INACTIVE（未激活）REVOKED（吊销）；PENDING_ACTIVATION（注册待激活）
   
      */
     Filters?: Array<Filter>;
     /**
-     * 分页limit
+     * 分页limit，默认20，最大100
      */
     Limit?: number;
     /**
-     * 分页偏移量
+     * 分页偏移量，默认0
      */
     Offset?: number;
     /**
-     * CREATE_TIME_DESC, 创建时间降序
+     * 排序规则
+      CREATE_TIME_DESC, 创建时间降序
       CREATE_TIME_ASC,创建时间升序
       UPDATE_TIME_DESC,更新时间降序
       UPDATE_TIME_ASC,更新时间升序
@@ -547,7 +551,7 @@ export interface RegisterCaCertificateResponse {
  */
 export interface DeleteInstanceRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
 }
@@ -761,7 +765,7 @@ export interface MQTTInstanceItem {
      */
     ClientNumLimit?: number;
     /**
-     * 是否自动续费。仅包年包月就去那生效。
+     * 是否自动续费。仅包年包月集群生效。
   1:自动续费
   0:非自动续费
      */
@@ -1017,7 +1021,7 @@ export interface DeleteCaCertificateRequest {
      */
     InstanceId: string;
     /**
-     * 证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
+     * CA证书序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
      */
     CaSn: string;
 }
@@ -1291,11 +1295,11 @@ export interface MQTTUserItem {
  */
 export interface ActivateCaCertificateRequest {
     /**
-     * 集群id
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 证书序列号
+     * CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
      */
     CaSn: string;
 }
@@ -1419,7 +1423,6 @@ export interface AuthorizationPolicyItem {
     ClientId?: string;
     /**
      * 条件-用户名，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
-  
      */
     Username?: string;
     /**
@@ -1459,7 +1462,7 @@ export interface DescribeClientListRequest {
      */
     InstanceId: string;
     /**
-     * 客户端名
+     * 客户端ID
      */
     ClientId?: string;
     /**
@@ -1536,7 +1539,7 @@ export interface DescribeTopicListRequest {
      */
     Offset?: number;
     /**
-     * 查询结果限制数量，默认0，最大20
+     * 查询结果限制数量，默认20，最大20
      */
     Limit?: number;
 }
@@ -1600,27 +1603,25 @@ export interface DescribeAuthenticatorRequest {
  */
 export interface RegisterCaCertificateRequest {
     /**
-     * 集群id
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * CA证书
+     * CA证书内容，自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
      */
     CaCertificate: string;
     /**
-     * 验证证书
+     * 验证证书内容，可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
      */
     VerificationCertificate: string;
     /**
-     * 证书格式，不传默认PEM格式
+     * 证书格式，不传默认PEM格式，当前仅支持PEM格式
      */
     Format?: string;
     /**
      * 证书状态，不传默认ACTIVE状态
-      ACTIVE,//激活
-      INACTIVE,//未激活
-      REVOKED,//吊销
-      PENDING_ACTIVATION,//注册待激活
+      ACTIVE：激活
+      INACTIVE：未激活
      */
     Status?: string;
 }
@@ -1701,11 +1702,11 @@ export interface CreateInsPublicEndpointRequest {
  */
 export interface RegisterDeviceCertificateRequest {
     /**
-     * 集群id
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 设备证书
+     * 设备证书内容，可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
      */
     DeviceCertificate: string;
     /**
@@ -1713,15 +1714,19 @@ export interface RegisterDeviceCertificateRequest {
      */
     CaSn: string;
     /**
-     * 客户端ID
+     * 客户端ID，需要关联该证书的客户端ID。根据实际业务使用填写
      */
     ClientId?: string;
     /**
-     * 证书格式
+     * 证书格式，默认为PEM，当前仅支持PEM格式
      */
     Format?: string;
     /**
-     *     ACTIVE,//激活     INACTIVE,//未激活     REVOKED,//吊销     PENDING_ACTIVATION,//注册待激活
+     *  客户端证书状态，默认激活状态（ACTIVE）
+  ACTIVE：激活
+  INACTIVE：未激活
+  REVOKED：吊销
+  PENDING_ACTIVATION：注册待激活
      */
     Status?: string;
 }
@@ -1760,7 +1765,7 @@ export interface DescribeDeviceCertificatesResponse {
      */
     TotalCount?: number;
     /**
-     * 设备证书
+     * 设备证书列表
      */
     Data?: Array<DeviceCertificateItem>;
     /**
@@ -1798,7 +1803,7 @@ export interface CreateUserRequest {
      */
     Username: string;
     /**
-     * 密码，该字段为空时候则后端会默认生成
+     * 密码，该字段为空时候则后端会默认生成。用户自定义密码时，不能为空，只支持数字 大小写字母 分隔符("_","-")，不能超过 64 个字符。
      */
     Password?: string;
     /**
@@ -1999,11 +2004,11 @@ export interface DescribeUserListRequest {
  */
 export interface DescribeCaCertificateRequest {
     /**
-     * ca证书sn
+     * CA证书的SN序列号，可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
      */
     CaSn: string;
     /**
-     * 集群id
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
 }
@@ -2293,7 +2298,7 @@ export interface DeviceCertificateItem {
      */
     DeviceCertificate?: string;
     /**
-     * 设备证书Sn
+     * 设备证书SN序列号，用于唯一标识一个设备证书
      */
     DeviceCertificateSn?: string;
     /**
@@ -2301,19 +2306,19 @@ export interface DeviceCertificateItem {
      */
     DeviceCertificateCn?: string;
     /**
-     * 签发ca的序列号
+     * 签发该证书的CA证书的序列号
      */
     CaSn?: string;
     /**
-     * 证书格式
+     * 证书格式，当前仅支持PEM
      */
     Format?: string;
     /**
-     * 证书状态
-      ACTIVE,//激活
-      INACTIVE,//未激活
-      REVOKED,//吊销
-      PENDING_ACTIVATION,//注册待激活
+     * 设备证书状态
+      ACTIVE：激活
+      INACTIVE：未激活
+      REVOKED：吊销
+      PENDING_ACTIVATION：注册待激活
      */
     Status?: string;
     /**
@@ -2321,19 +2326,19 @@ export interface DeviceCertificateItem {
      */
     OrganizationalUnit?: string;
     /**
-     * 上次激活时间
+     * 上次激活时间，毫秒级时间戳 。
      */
     LastActivationTime?: number;
     /**
-     * 上次取消激活时间
+     * 上次取消激活时间，毫秒级时间戳 。
      */
     LastInactivationTime?: number;
     /**
-     * 创建时间
+     * 创建时间，毫秒级时间戳 。
      */
     CreatedTime?: number;
     /**
-     * 预销毁时间
+     * 更新时间，毫秒级时间戳 。
      */
     UpdateTime?: number;
     /**
@@ -2343,11 +2348,11 @@ export interface DeviceCertificateItem {
      */
     CertificateSource?: string;
     /**
-     * 证书失效日期
+     * 证书失效日期，毫秒级时间戳 。
      */
     NotAfterTime?: number;
     /**
-     * 证书生效开始日期
+     * 证书生效开始日期，毫秒级时间戳 。
      */
     NotBeforeTime?: number;
 }