tencentcloud-sdk-nodejs 4.1.5 → 4.1.7

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

@@ -163,31 +163,31 @@ export interface ApplyRegistrationCodeRequest {
  */
 export interface DescribeMessageListRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 主题
+     * 要查询的一级Topic，可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
      */
     Topic: string;
     /**
-     * 开始时间
+     * 开始时间，毫秒级时间戳 。
      */
     StartTime: number;
     /**
-     * 结束时间
+     * 结束时间，毫秒级时间戳 。
      */
     EndTime: number;
     /**
-     * 请求任务id
+     * 请求任务id，用于相同查询参数下查询加速，第一次查询时无需传递，第一次查询会根据本次查询参数生成查询任务ID，保留查询条件，查询下一页消息时可传递第一次查询返回的任务ID。
      */
     TaskRequestId: string;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认0
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20，最大50
      */
     Limit?: number;
 }
@@ -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;
 }
@@ -556,19 +560,20 @@ export interface DeleteInstanceRequest {
  */
 export interface ModifyInstanceRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 要修改实例名称
+     * 要修改实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。
      */
     Name?: string;
     /**
-     * 要修改的备注信息
+     * 要修改的备注信息，最多64个字符。
      */
     Remark?: string;
     /**
-     * 要变更的配置规格
+     * 需要变更的配置规格
+  基础版和增强版集群不能升配到铂金版规格，铂金版集群不能降配至基础版和增强版规格。
      */
     SkuCode?: string;
     /**
@@ -581,6 +586,10 @@ export interface ModifyInstanceRequest {
      * 自动注册证书是否自动激活
      */
     AutomaticActivation?: boolean;
+    /**
+     * 授权策略开关
+     */
+    AuthorizationPolicy?: boolean;
 }
 /**
  * RegisterDeviceCertificate返回参数结构体
@@ -603,16 +612,35 @@ export interface MQTTAuthenticatorItem {
      */
     Type?: string;
     /**
-     * HTTP认证器
+     * JWT认证器字段说明
+  from（认证字段）
+      password：从password字段获取认证字段
+      username：从username字段获取认证字段
+  secret（签名方式）
+      hmac-based：hmac-based签名方式
+      public-key：public-key签名方式
+  secret（密钥），hmac-based需要配置密钥
+  public-key（公钥），public-key签名方式需要配置
+  样例：{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
+  
+  JWKS认证器字段说明
+  endpoint（接入点）：公钥获取服务器接入地址
+  refreshInterval（认证内容）：公钥集合刷新周期
+  from（认证字段）
+      password：从password字段获取认证字段
+      username：从username字段获取认证字段
+  text：公钥集合
+  样例：{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
+  
+  HTTP认证器
   headers（请求头）：标准请求头和自定义请求头
   endpoint（接入点）：认证服务器接入点
   method（http请求方法）：POST/GET
   readTimeout（读超时时间）：读取认证服务器数据超时时间，单位秒
   connectTimeout（连接超时时间）：连接认证服务器超时时间，单位秒
   body（请求体）：http请求体
-  concurrency（并发数）：最大并发请求数
+  concurrency（并发数）：最大并发请求数量
   样例：{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
-  
   参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
      */
     Config?: string;
@@ -761,7 +789,7 @@ export interface MQTTInstanceItem {
      */
     ClientNumLimit?: number;
     /**
-     * 是否自动续费。仅包年包月就去那生效。
+     * 是否自动续费。仅包年包月集群生效。
   1:自动续费
   0:非自动续费
      */
@@ -873,7 +901,7 @@ export interface MQTTMessageItem {
      */
     ProducerAddr?: string;
     /**
-     * 消息发送时间
+     * 消息发送时间，格式 日期时间：YYYY-MM-DD hh:mm:ss
      */
     ProduceTime?: string;
     /**
@@ -890,6 +918,9 @@ export interface MQTTMessageItem {
     SubTopic?: string;
     /**
      * 消息质量等级
+  0：至多一次
+  1：至少一次
+  2：精确一次
      */
     Qos?: string;
 }
@@ -925,55 +956,66 @@ export interface CreateUserResponse {
  */
 export interface CreateAuthorizationPolicyRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 策略名称
+     * 策略名称，不能为空，3-64个字符，支持中文、字母、数字、“-”及“_”。
      */
     PolicyName: string;
     /**
-     * 策略版本
+     * 策略版本,默认为1，当前仅支持1
      */
     PolicyVersion: number;
     /**
-     * 策略优先级，越小越优先
+     * 策略优先级，越小越优先，不能重复
      */
     Priority: number;
     /**
-     * allow、deny
+     * 决策：
+  allow 允许
+  deny 拒绝
      */
     Effect: string;
     /**
-     * connect、pub、sub
+     * 操作
+  connect：连接
+  pub：发布
+  sub：订阅
      */
     Actions: string;
     /**
-     * 1,匹配保留消息；2,匹配非保留消息，3.匹配所有消息
+     * 条件-保留消息
+  1,匹配保留消息；
+  2,匹配非保留消息，
+  3.匹配保留和非保留消息
      */
     Retain: number;
     /**
-     * 0、1、2
+     * 条件：服务质量
+  0：最多一次
+  1：最少一次
+  2：精确一次
      */
     Qos: string;
     /**
-     * 资源
+     * 资源，需要匹配的订阅
      */
     Resources?: string;
     /**
-     * 用户名
+     * 条件-用户名
      */
     Username?: string;
     /**
-     * 客户端
+     * 条件：客户端ID，支持正则
      */
     ClientId?: string;
     /**
-     * IP地址
+     * 条件：客户端IP地址，支持IP或者CIDR
      */
     Ip?: string;
     /**
-     * 备注信息
+     * 备注信息，最长 128 字符
      */
     Remark?: string;
 }
@@ -1017,7 +1059,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 +1333,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 +1461,6 @@ export interface AuthorizationPolicyItem {
     ClientId?: string;
     /**
      * 条件-用户名，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
-  
      */
     Username?: string;
     /**
@@ -1459,7 +1500,7 @@ export interface DescribeClientListRequest {
      */
     InstanceId: string;
     /**
-     * 客户端名
+     * 客户端ID
      */
     ClientId?: string;
     /**
@@ -1536,7 +1577,7 @@ export interface DescribeTopicListRequest {
      */
     Offset?: number;
     /**
-     * 查询结果限制数量，默认0，最大20
+     * 查询结果限制数量，默认20，最大20
      */
     Limit?: number;
 }
@@ -1574,6 +1615,14 @@ export interface RevokedDeviceCertificateRequest {
  * CreateAuthorizationPolicy返回参数结构体
  */
 export interface CreateAuthorizationPolicyResponse {
+    /**
+     * 集群Id
+     */
+    InstanceId?: string;
+    /**
+     * 策略id
+     */
+    Id?: number;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -1600,27 +1649,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 +1748,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 +1760,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 +1811,7 @@ export interface DescribeDeviceCertificatesResponse {
      */
     TotalCount?: number;
     /**
-     * 设备证书
+     * 设备证书列表
      */
     Data?: Array<DeviceCertificateItem>;
     /**
@@ -1798,7 +1849,7 @@ export interface CreateUserRequest {
      */
     Username: string;
     /**
-     * 密码，该字段为空时候则后端会默认生成
+     * 密码，该字段为空时候则后端会默认生成。用户自定义密码时，不能为空，只支持数字 大小写字母 分隔符("_","-")，不能超过 64 个字符。
      */
     Password?: string;
     /**
@@ -1814,6 +1865,7 @@ export interface DescribeInstanceResponse {
      * 实例类型
   BASIC 基础版
   PRO  专业版
+  PLATINUM 铂金版
      */
     InstanceType?: string;
     /**
@@ -1845,7 +1897,7 @@ export interface DescribeInstanceResponse {
      */
     Remark?: string;
     /**
-     * 实例状态
+     * 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中
      */
     InstanceStatus?: string;
     /**
@@ -1875,7 +1927,7 @@ export interface DescribeInstanceResponse {
      */
     AutomaticActivation?: boolean;
     /**
-     * 是否自动续费
+     * 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
      */
     RenewFlag?: number;
     /**
@@ -1883,11 +1935,11 @@ export interface DescribeInstanceResponse {
      */
     PayMode?: string;
     /**
-     * 到期时间，秒为单位
+     * 到期时间，毫秒级时间戳
      */
     ExpiryTime?: number;
     /**
-     * 预销毁时间
+     * 预销毁时间，毫秒级时间戳
      */
     DestroyTime?: number;
     /**
@@ -1906,6 +1958,10 @@ export interface DescribeInstanceResponse {
      * 集群最大订阅数
      */
     MaxSubscription?: number;
+    /**
+     * 授权策略开关
+     */
+    AuthorizationPolicy?: boolean;
     /**
      * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
@@ -1999,11 +2055,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 +2349,7 @@ export interface DeviceCertificateItem {
      */
     DeviceCertificate?: string;
     /**
-     * 设备证书Sn
+     * 设备证书SN序列号，用于唯一标识一个设备证书
      */
     DeviceCertificateSn?: string;
     /**
@@ -2301,19 +2357,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 +2377,19 @@ export interface DeviceCertificateItem {
      */
     OrganizationalUnit?: string;
     /**
-     * 上次激活时间
+     * 上次激活时间，毫秒级时间戳 。
      */
     LastActivationTime?: number;
     /**
-     * 上次取消激活时间
+     * 上次取消激活时间，毫秒级时间戳 。
      */
     LastInactivationTime?: number;
     /**
-     * 创建时间
+     * 创建时间，毫秒级时间戳 。
      */
     CreatedTime?: number;
     /**
-     * 预销毁时间
+     * 更新时间，毫秒级时间戳 。
      */
     UpdateTime?: number;
     /**
@@ -2343,11 +2399,11 @@ export interface DeviceCertificateItem {
      */
     CertificateSource?: string;
     /**
-     * 证书失效日期
+     * 证书失效日期，毫秒级时间戳 。
      */
     NotAfterTime?: number;
     /**
-     * 证书生效开始日期
+     * 证书生效开始日期，毫秒级时间戳 。
      */
     NotBeforeTime?: number;
 }
@@ -2367,7 +2423,7 @@ export interface MQTTClientInfo {
      * MQTT 协议版本
   3：表示MQTT 3.1版本
   4：表示 MQTT 3.1.1
-  5:   标识MQTT 5.0协议
+  5：表示MQTT 5.0协议
      */
     ProtocolVersion?: number;
     /**
@@ -2600,7 +2656,7 @@ export interface ModifyHttpAuthenticatorRequest {
  */
 export interface DescribeInstanceRequest {
     /**
-     * 实例ID
+     * 实例ID [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)
      */
     InstanceId: string;
 }