tencentcloud-sdk-nodejs 4.1.48 → 4.1.50

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

@@ -196,35 +196,40 @@ export interface DescribeMessageListRequest {
  */
 export interface ModifyJWTAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 算法：hmac-based，public-key
+     * 签名方式：hmac-based，public-key
      */
     Algorithm?: string;
     /**
-     * 设备连接时传递jwt的key；
-  username-使用用户名字段传递；
-  password-使用密码字段传递
+     * 认证字段
+  password：对应 MQTT CONNECT Packet 中 password 字段，
+  username：对应 MQTT CONNECT Packet 中 username 字段
      */
     From?: string;
     /**
-     * 密码
+     * 密钥，Algorithm为hmac-based需要传递该字段。
      */
     Secret?: string;
     /**
-     * 公钥
+     * 公钥，Algorithm为public-key时需要传递该字段。
      */
     PublicKey?: string;
     /**
-     * JSKS文本
+     * 认证器是否开启：open-启用；close-关闭
      */
-    Text?: string;
+    Status?: string;
     /**
-     * 说明
+     * 说明，不能超过 128 个字符
      */
     Remark?: string;
+    /**
+     * JSKS文本
+     * @deprecated
+     */
+    Text?: string;
 }
 /**
  * 策略规则优先级
@@ -429,13 +434,13 @@ export interface PublicAccessRule {
     /**
      * ip网段信息
      */
-    IpRule: string;
+    IpRule?: string;
     /**
-     * 允许或者拒绝
+     * 当前仅支持允许，默认允许（allow）
      */
-    Allow: boolean;
+    Allow?: boolean;
     /**
-     * 备注信息
+     * 备注信息，最多64个字符。
      */
     Remark?: string;
 }
@@ -512,31 +517,33 @@ export interface ProductSkuItem {
  */
 export interface ModifyJWKSAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 端点
+     * JWKS服务器地址，（Text字段和Endpoint字段必须选择一个填写）
      */
     Endpoint?: string;
     /**
-     * 认证器状态：open-启用；close-关闭
+     * 认证器状态：open-启用（默认）；close-关闭
      */
     Status?: string;
     /**
-     * 刷新时间
+     * 认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址时生效。
      */
     RefreshInterval?: number;
     /**
-     * JSKS文本
+     * JWKS文本，认证服务器地址为空时生效。（Text字段和Endpoint字段必须选择一个填写）
      */
     Text?: string;
     /**
-     * 设备连接时传递jwt的key；username-使用用户名字段传递；password-使用密码字段传递
+     * 认证字段；
+  username-对应 MQTT CONNECT Packet 中 username 字段，
+  password-对应 MQTT CONNECT Packet 中 password 字段。默认username
      */
     From?: string;
     /**
-     * 说明
+     * 说明，不能超过 128 个字符
      */
     Remark?: string;
 }
@@ -579,7 +586,7 @@ export interface ModifyInstanceRequest {
      */
     Name?: string;
     /**
-     * 要修改的备注信息，最多64个字符。
+     * 要修改的备注信息，最多128个字符。
      */
     Remark?: string;
     /**
@@ -591,10 +598,12 @@ export interface ModifyInstanceRequest {
      * 客户端证书注册方式：
   JITP：自动注册
   API：手动通过API注册
+     * @deprecated
      */
     DeviceCertificateProvisionType?: string;
     /**
      * 自动注册证书是否自动激活
+     * @deprecated
      */
     AutomaticActivation?: boolean;
     /**
@@ -771,7 +780,6 @@ export interface MQTTInstanceItem {
   MAINTAINING，维护中
   ABNORMAL，异常
   OVERDUE，欠费
-  DESTROYED，已删除
   CREATING，创建中
   MODIFYING，变配中
   CREATE_FAILURE，创建失败
@@ -895,13 +903,29 @@ export interface CreateHttpAuthenticatorResponse {
     RequestId?: string;
 }
 /**
- * ModifyInsPublicEndpoint返回参数结构体
+ * MQTT消息
  */
-export interface ModifyInsPublicEndpointResponse {
+export interface MQTTMessage {
     /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 消息id
      */
-    RequestId?: string;
+    MessageId?: string;
+    /**
+     * 消息发送的客户端Id
+     */
+    ClientId?: string;
+    /**
+     * 消息服务质量等级
+     */
+    Qos?: string;
+    /**
+     * 消息在服务端的存储时间，毫秒级时间戳
+     */
+    StoreTimestamp?: number;
+    /**
+     * 源topic
+     */
+    OriginTopic?: string;
 }
 /**
  * 消息记录
@@ -929,14 +953,17 @@ export interface MQTTMessageItem {
     ProduceTime?: string;
     /**
      * 死信重发次数
+     * @deprecated
      */
     DeadLetterResendTimes?: number;
     /**
      * 死信重发成功次数
+     * @deprecated
      */
     DeadLetterResendSuccessTimes?: number;
     /**
      * 子topic
+     * @deprecated
      */
     SubTopic?: string;
     /**
@@ -991,24 +1018,25 @@ export interface CreateAuthorizationPolicyRequest {
      */
     PolicyVersion: number;
     /**
-     * 策略优先级，越小越优先，不能重复
+     * 策略优先级，越小越优先，不能重复，优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
      */
     Priority: number;
     /**
      * 决策：
-  allow 允许
-  deny 拒绝
+  allow：允许符合该策略的设备的访问请求。
+  deny：拒绝覆盖该策略的设备的访问请求。
+  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
      */
     Effect: string;
     /**
-     * 操作
+     * 操作,支持多选，多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
   connect：连接
   pub：发布
   sub：订阅
      */
     Actions: string;
     /**
-     * 条件-保留消息
+     * 条件-保留消息，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
   1,匹配保留消息；
   2,匹配非保留消息，
   3.匹配保留和非保留消息
@@ -1019,10 +1047,12 @@ export interface CreateAuthorizationPolicyRequest {
   0：最多一次
   1：最少一次
   2：精确一次
+  可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
      */
     Qos: string;
     /**
-     * 资源，需要匹配的订阅
+     * 资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
+  
      */
     Resources?: string;
     /**
@@ -1034,7 +1064,7 @@ export interface CreateAuthorizationPolicyRequest {
      */
     ClientId?: string;
     /**
-     * 条件：客户端IP地址，支持IP或者CIDR
+     * 条件：客户端IP地址，支持IP或者CIDR，可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
      */
     Ip?: string;
     /**
@@ -1099,6 +1129,27 @@ export interface DeleteDeviceCertificateRequest {
      */
     DeviceCertificateSn: string;
 }
+/**
+ * DescribeMessageByTopic请求参数结构体
+ */
+export interface DescribeMessageByTopicRequest {
+    /**
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
+     */
+    InstanceId: string;
+    /**
+     * home/room
+     */
+    Topic: string;
+    /**
+     * 开始时间，毫秒级时间戳 。
+     */
+    StartTime: number;
+    /**
+     * 查询消息条数，最大1024，默认100.
+     */
+    MaxNumber?: number;
+}
 /**
  * DescribeInsPublicEndpoints请求参数结构体
  */
@@ -1135,6 +1186,19 @@ export interface DeleteDeviceCertificateResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeMessageByTopic返回参数结构体
+ */
+export interface DescribeMessageByTopicResponse {
+    /**
+     * 消息列表
+     */
+    Data?: Array<MQTTMessage>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DeleteInstance返回参数结构体
  */
@@ -1166,33 +1230,35 @@ export interface DescribeProductSKUListResponse {
  */
 export interface CreateJWKSAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * jwks端点
+     * JWKS服务地址，（Text字段和Endpoint字段必须选择一个填写）
      */
     Endpoint?: string;
     /**
-     * jwks刷新间隔,单位：秒
+     * 认证文本刷新间隔时间，单位：秒，最小值60，默认值60，最大值1000。填写认证服务器地址（Endpoint）时生效。
      */
     RefreshInterval?: number;
     /**
-     * jwks文本
+     * jwks文本，（Text字段和Endpoint字段必须选择一个填写）
      */
     Text?: string;
     /**
-     * 认证器是否开启：open-启用；close-关闭
+     * 认证器是否开启：open-启用；close-关闭，默认open-启用
      */
     Status?: string;
     /**
-     * 说明
+     * 说明，不能超过 128 个字符
      */
     Remark?: string;
     /**
-     * 设备连接时传递jwt的key；
-  username-使用用户名字段传递；
-  password-使用密码字段传递
+     * 认证字段；
+  username-对应 MQTT CONNECT Packet 中 username 字段，
+  password-对应 MQTT CONNECT Packet 中 password 字段。
+  
+  默认username
      */
     From?: string;
 }
@@ -1634,6 +1700,15 @@ export interface RevokedDeviceCertificateRequest {
      */
     DeviceCertificateSn: string;
 }
+/**
+ * ModifyInsPublicEndpoint返回参数结构体
+ */
+export interface ModifyInsPublicEndpointResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateAuthorizationPolicy返回参数结构体
  */
@@ -1699,21 +1774,23 @@ export interface RegisterCaCertificateRequest {
  */
 export interface CreateInstanceRequest {
     /**
-     * 实例类型，
+     * 实例类型，需要和SkuCode保持对应关系，可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
   BASIC 基础版
   PRO  专业版
+  PLATINUM 铂金版
+  
      */
     InstanceType: string;
     /**
-     * 实例名称
+     * 集群名称不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”。
      */
     Name: string;
     /**
-     * 商品规格，可用规格可通过接口DescribeProductSKUList查询
+     * 商品规格，需要和InstanceType保持对应关系，可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
      */
     SkuCode: string;
     /**
-     * 备注信息
+     * 备注信息，最长 128 字符
      */
     Remark?: string;
     /**
@@ -1721,31 +1798,31 @@ export interface CreateInstanceRequest {
      */
     TagList?: Array<Tag>;
     /**
-     * 实例绑定的VPC信息
+     * 实例绑定的VPC信息，需要传当前用户下可用的VPC和SUBNET
      */
     VpcList?: Array<VpcInfo>;
     /**
-     * 是否开启公网
+     * 是否开启公网，默认false（关闭）
      */
     EnablePublic?: boolean;
     /**
-     * 公网带宽（单位：兆）
+     * 公网带宽（单位：Mbps），EnablePublic 为True时，该字段必须填写且大于0.
      */
     Bandwidth?: number;
     /**
-     * 公网访问白名单
+     * 公网访问白名单，不传表示拒绝所有IP网络访问。
      */
     IpRules?: Array<IpRule>;
     /**
-     * 是否自动续费（0: 不自动续费；1: 自动续费）
+     * 是否自动续费（0: 不自动续费；1: 自动续费），仅购买预付费集群时生效。默认1:自动续费
      */
     RenewFlag?: number;
     /**
-     * 购买时长（单位：月）
+     * 购买时长（单位：月），购买预付费集群时生效，默认1m（月）。可选范围：1~12、24、36、48、60；
      */
     TimeSpan?: number;
     /**
-     * 付费模式（0: 后付费；1: 预付费）
+     * 付费模式（0: 后付费；1: 预付费），默认0（后付费）。
      */
     PayMode?: number;
 }
@@ -1754,7 +1831,7 @@ export interface CreateInstanceRequest {
  */
 export interface CreateInsPublicEndpointRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
@@ -1794,8 +1871,6 @@ export interface RegisterDeviceCertificateRequest {
      *  客户端证书状态，默认激活状态（ACTIVE）
   ACTIVE：激活
   INACTIVE：未激活
-  REVOKED：吊销
-  PENDING_ACTIVATION：注册待激活
      */
     Status?: string;
 }
@@ -2030,7 +2105,7 @@ export interface DescribeDeviceCertificateRequest {
  */
 export interface ModifyInsPublicEndpointRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
@@ -2144,27 +2219,27 @@ export interface RevokedDeviceCertificateResponse {
  */
 export interface CreateHttpAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * jwks端点
+     * jwks服务地址
      */
     Endpoint: string;
     /**
-     * 最大并发连接数，默认8，范围：1-20
+     * 最大并发连接数，默认8，范围：1-10
      */
     Concurrency?: number;
     /**
-     * 网络请求方法 Get 或 Post，默认post
+     * 网络请求方法 GET 或 POST，默认POST
      */
     Method?: string;
     /**
-     * 认证器是否开启：open-启用；close-关闭
+     * 认证器是否开启：open-启用；close-关闭，默认open-启用
      */
     Status?: string;
     /**
-     * 说明
+     * 说明，最多支持128个字符。
      */
     Remark?: string;
     /**
@@ -2289,6 +2364,7 @@ export interface DescribeInstanceListRequest {
   InstanceName：集群名模糊搜索
   InstanceId：集群id精确搜索
   InstanceStatus：集群状态搜索（RUNNING-运行中，CREATING-创建中，MODIFYING-变配中，DELETING-删除中）
+  注意：配置TagFilters时该查询条件不生效。
      */
     Filters?: Array<Filter>;
     /**
@@ -2322,31 +2398,35 @@ export interface DeactivateCaCertificateRequest {
  */
 export interface CreateJWTAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 算法：hmac-based，public-key
+     * 签名方式：hmac-based，public-key
      */
     Algorithm: string;
     /**
-     * 设备连接时传递jwt的key；username-使用用户名字段传递；password-使用密码字段传递
+     * 认证字段
+  password：对应 MQTT CONNECT Packet 中 password 字段，
+  username：对应 MQTT CONNECT Packet 中 username 字段
+  默认username
+  
      */
     From: string;
     /**
-     * 密码
+     * 密钥，Algorithm为hmac-based需要传递该字段。
      */
     Secret?: string;
     /**
-     * 公钥
+     * 公钥，Algorithm为public-key时需要传递该字段。
      */
     PublicKey?: string;
     /**
-     * 认证器是否开启：open-启用；close-关闭
+     * 认证器是否开启：open-启用；close-关闭，默认：open-启用
      */
     Status?: string;
     /**
-     * 说明
+     * 说明，不能超过 128 个字符。
      */
     Remark?: string;
 }
@@ -2518,59 +2598,72 @@ export interface PriceTag {
  */
 export interface ModifyAuthorizationPolicyRequest {
     /**
-     * 策略
+     * 授权策略ID，从 [查询授权策略](https://cloud.tencent.com/document/product/1778/111074) 接口获取
      */
     Id: number;
     /**
-     * 实例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
+     * 操作,支持多选，多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
+  connect：连接
+  pub：发布
+  sub：订阅
      */
     Actions?: string;
     /**
-     * 资源
+     * 资源，需要匹配的订阅，支持配置多条匹配规则，多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
+  
      */
     Resources?: string;
     /**
-     * 用户名
+     * 条件-用户名
      */
     Username?: string;
     /**
-     * 1.匹配保留消息；2.匹配非保留消息；3.匹配所有消息
+     * 条件-保留消息
+  1,匹配保留消息；
+  2,匹配非保留消息，
+  3.匹配保留和非保留消息
      */
     Retain?: number;
     /**
-     * 客户端
+     * 条件：客户端ID，支持正则
      */
     ClientId?: string;
     /**
-     * IP
+     * 条件：客户端IP地址，支持IP或者CIDR
      */
     Ip?: string;
     /**
-     * 0、1、2
+     * 条件：服务质量
+  0：最多一次
+  1：最少一次
+  2：精确一次
      */
     Qos?: string;
     /**
-     * 备注信息
+     * 备注信息，最长 128 字符
      */
     Remark?: string;
 }
@@ -2601,17 +2694,9 @@ export interface DeleteTopicResponse {
  */
 export interface ModifyInstanceCertBindingRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
-    /**
-     * 服务端证书id
-     */
-    SSLServerCertId: string;
-    /**
-     * CA证书id
-     */
-    SSLCaCertId: string;
     /**
      * 加密通信方式
   TLS：单向证书认证
@@ -2619,10 +2704,19 @@ export interface ModifyInstanceCertBindingRequest {
   BYOC：一设备一证书认证
      */
     X509Mode: string;
+    /**
+     * 服务端证书id，从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS或BYOC时为必填。
+     */
+    SSLServerCertId?: string;
+    /**
+     * CA证书id，从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS时为必填
+     */
+    SSLCaCertId?: string;
     /**
      * 设备证书注册类型：
-  JITP，自动注册；
-  MANUAL 手动注册
+  JITP：自动注册；
+  API：手动注册
+  默认值：API
      */
     DeviceCertificateProvisionType?: string;
     /**
@@ -2635,11 +2729,11 @@ export interface ModifyInstanceCertBindingRequest {
  */
 export interface ModifyHttpAuthenticatorRequest {
     /**
-     * 实例ID
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 端点
+     * 服务地址
      */
     Endpoint?: string;
     /**
@@ -2647,7 +2741,7 @@ export interface ModifyHttpAuthenticatorRequest {
      */
     Status?: string;
     /**
-     * 最大并发连接数，默认8，范围：1-20
+     * 最大并发连接数，默认8，范围：1-10
      */
     Concurrency?: number;
     /**
@@ -2659,7 +2753,7 @@ export interface ModifyHttpAuthenticatorRequest {
      */
     ReadTimeout?: number;
     /**
-     * 说明
+     * 说明，最多支持128个字符。
      */
     Remark?: string;
     /**
@@ -2732,7 +2826,7 @@ export interface IpRule {
      */
     Ip: string;
     /**
-     * 是否允许放行
+     * 当前仅支持允许，默认允许。
      */
     Allow: boolean;
     /**