tencentcloud-sdk-nodejs 4.1.65 → 4.1.67

package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts

@@ -4,6 +4,8 @@
 export interface DetailedRolePerm {
     /**
      * 权限对应的资源
+  可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
+  可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     Resource: string;
     /**
@@ -712,11 +714,11 @@ export interface TopicStageChangeResult {
  */
 export interface DeleteTopicRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 主题名称
+     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
      */
     Topic: string;
 }
@@ -992,19 +994,19 @@ export declare type DescribeMQTTProductSKUListRequest = null;
  */
 export interface DescribeConsumerLagRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 命名空间，4.x集群必填
+     * 命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口或控制台获得。
      */
     Namespace?: string;
     /**
-     * 订阅主题，不为空则查询订阅了该主题的消费组的堆积
+     * 订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
      */
     SubscribeTopic?: string;
 }
@@ -1247,11 +1249,11 @@ export interface ModifyInstanceResponse {
  */
 export interface CreateConsumerGroupRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 最大重试次数
+     * 最大重试次数，取值范围0～1000
      */
     MaxRetryTimes: number;
     /**
@@ -1264,11 +1266,11 @@ export interface CreateConsumerGroupRequest {
      */
     ConsumeMessageOrderly: boolean;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 备注
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
     /**
@@ -1715,11 +1717,11 @@ export interface DeleteInstanceRequest {
  */
 export interface ModifyRoleRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 角色名称
+     * 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
      */
     Role: string;
     /**
@@ -1739,7 +1741,7 @@ export interface ModifyRoleRequest {
      */
     Remark?: string;
     /**
-     * Topic&Group维度权限配置
+     * Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
      */
     DetailedPerms?: Array<DetailedRolePerm>;
 }
@@ -1774,11 +1776,11 @@ export interface DescribeFusionInstanceListResponse {
  */
 export interface CreateTopicRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 主题名称
+     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
      */
     Topic: string;
     /**
@@ -1791,15 +1793,15 @@ export interface CreateTopicRequest {
      */
     TopicType: string;
     /**
-     * 队列数量
+     * 队列数量，取值范围3～16
      */
     QueueNum: number;
     /**
-     * 备注
+     * 备注，最多 128 字符
      */
     Remark?: string;
     /**
-     * 消息保留时长
+     * 消息保留时长（单位：小时）
      */
     MsgTTL?: number;
     /**
@@ -1845,11 +1847,11 @@ export interface DescribeMessageRequest {
  */
 export interface DeleteRoleRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 角色名称
+     * 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
      */
     Role: string;
 }
@@ -1963,11 +1965,11 @@ export interface TagFilter {
  */
 export interface DeleteConsumerGroupRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
 }
@@ -2265,23 +2267,23 @@ export interface DeleteMQTTInstanceResponse {
  */
 export interface DescribeTopicRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 主题名称
+     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
      */
     Topic: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
 }
@@ -2669,11 +2671,11 @@ export interface DescribeTopicListRequest {
  */
 export interface ModifyConsumerGroupRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
@@ -2686,11 +2688,11 @@ export interface ModifyConsumerGroupRequest {
      */
     ConsumeMessageOrderly?: boolean;
     /**
-     * 最大重试次数
+     * 最大重试次数，取值范围0～1000
      */
     MaxRetryTimes?: number;
     /**
-     * 备注
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
 }
@@ -2699,11 +2701,11 @@ export interface ModifyConsumerGroupRequest {
  */
 export interface DescribeConsumerGroupRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
 }
@@ -2757,7 +2759,7 @@ export interface TopicItem {
      */
     QueueNum?: number;
     /**
-     * 描述
+     * 备注信息
      */
     Remark?: string;
     /**
@@ -2782,7 +2784,6 @@ export interface TopicItem {
     FullNamespaceV4?: string;
     /**
      * 消息保留时长
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MsgTTL?: number;
 }
@@ -2821,7 +2822,11 @@ export interface SubscriptionData {
      */
     IsOnline?: boolean;
     /**
-     * 消费类型
+     * 消费类型，枚举值如下：
+  
+  - PULL：PULL 消费类型
+  - PUSH：PUSH 消费类型
+  - POP：POP 消费类型
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ConsumeType?: string;
@@ -2836,7 +2841,10 @@ export interface SubscriptionData {
      */
     ExpressionType?: string;
     /**
-     * 订阅一致性
+     * 订阅一致性，枚举如下：
+  
+  - 0: 订阅一致
+  - 1: 订阅不一致
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Consistency?: number;
@@ -3009,11 +3017,15 @@ export interface DescribeConsumerGroupResponse {
      */
     ConsumerLag?: number;
     /**
-     * 消费者类型
+     * 消费类型，枚举值如下：
+  
+  - PULL：PULL 消费类型
+  - PUSH：PUSH 消费类型
+  - POP：POP 消费类型
      */
     ConsumeType?: string;
     /**
-     * 创建时间，秒为单位
+     * 创建时间，**Unix时间戳（毫秒）**
      */
     CreatedTime?: number;
     /**
@@ -3049,27 +3061,27 @@ export interface DescribeConsumerGroupResponse {
  */
 export interface DescribeConsumerClientRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 客户端ID
+     * 客户端ID，从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。
      */
     ClientId: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
 }
@@ -3118,23 +3130,23 @@ export interface DeleteRoleResponse {
  */
 export interface DescribeTopicListByGroupRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
 }
@@ -3242,23 +3254,23 @@ export interface MessageTraceItem {
  */
 export interface ModifyTopicRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 主题名称
+     * 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
      */
     Topic: string;
     /**
-     * 队列数量
+     * 队列数量，取值范围3～16
      */
     QueueNum?: number;
     /**
-     * 备注信息
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
     /**
-     * 消息保留时长
+     * 消息保留时长（单位：小时）
      */
     MsgTTL?: number;
 }
@@ -3848,23 +3860,23 @@ export interface DescribeTopicListResponse {
  */
 export interface DescribeConsumerClientListRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
 }
@@ -3877,7 +3889,12 @@ export interface TopicConsumeStats {
      */
     Topic?: string;
     /**
-     * 主题类型
+     * 主题类型，枚举值如下：
+  
+  - NORMAL：普通消息主题
+  - FIFO：顺序消息主题
+  - DELAY：延迟消息主题
+  - TRANSACTION：事务消息主题
      */
     TopicType?: string;
     /**
@@ -3889,11 +3906,11 @@ export interface TopicConsumeStats {
      */
     ConsumerLag?: number;
     /**
-     * 订阅规则
+     * 订阅规则，`*`表示订阅全部TAG
      */
     SubString?: string;
     /**
-     * 最后消费进度更新时间
+     * 最后消费进度更新时间，**Unix时间戳（毫秒）**
      */
     LastUpdateTime?: number;
 }
@@ -3915,7 +3932,7 @@ export interface DescribeMQTTTopicRequest {
  */
 export interface CreateRoleRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
@@ -3939,7 +3956,7 @@ export interface CreateRoleRequest {
      */
     PermType?: string;
     /**
-     * Topic&Group维度权限配置
+     * Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
      */
     DetailedPerms?: Array<DetailedRolePerm>;
 }