tencentcloud-sdk-nodejs 4.1.64 → 4.1.66

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;
     /**
@@ -71,42 +73,34 @@ export interface ProductSKU {
     SkuCode?: string;
     /**
      * TPS上限
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     TpsLimit?: number;
     /**
      * 弹性TPS上限
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     ScaledTpsLimit?: number;
     /**
      * 主题数量上限默认值
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     TopicNumLimit?: number;
     /**
      * 消费组数量上限
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     GroupNumLimit?: number;
     /**
      * 默认消息保留时间，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     DefaultRetention?: number;
     /**
      * 可调整消息保留时间上限，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     RetentionUpperLimit?: number;
     /**
      * 可调整消息保留时间下限，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     RetentionLowerLimit?: number;
     /**
      * 延时消息最大时长，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MaxMessageDelay?: number;
     /**
@@ -119,7 +113,6 @@ export interface ProductSKU {
     PriceTags?: Array<PriceTag>;
     /**
      * 主题数量上限默认最大值
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     TopicNumUpperLimit?: number;
 }
@@ -351,43 +344,43 @@ export interface ModifyRoleResponse {
  */
 export interface DescribeMessageListRequest {
     /**
-     * 集群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;
     /**
-     * 开始时间
+     * 要查询消息的开始时间，**Unix时间戳（毫秒）**
      */
     StartTime: number;
     /**
-     * 结束时间
+     * 要查询消息的结束时间，**Unix时间戳（毫秒）**
      */
     EndTime: number;
     /**
-     * 一次查询标识
+     * 一次查询标识。第一次查询可传空字符串，当查询结果涉及分页，请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
      */
     TaskRequestId: string;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 消息 ID
+     * 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
      */
     MsgId?: string;
     /**
-     * 消息 Key
+     * 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
      */
     MsgKey?: string;
     /**
@@ -395,11 +388,11 @@ export interface DescribeMessageListRequest {
      */
     RecentMessageNum?: number;
     /**
-     * 是否查询死信消息
+     * 是否查询死信消息，默认为false
      */
     QueryDeadLetterMessage?: boolean;
     /**
-     * 消息 Tag
+     * 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
      */
     Tag?: string;
 }
@@ -417,15 +410,15 @@ export interface DeleteMQTTInsPublicEndpointRequest {
  */
 export interface ModifyInstanceRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 实例名称
+     * 实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”
      */
     Name?: string;
     /**
-     * 备注信息
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
     /**
@@ -433,11 +426,15 @@ export interface ModifyInstanceRequest {
      */
     SendReceiveRatio?: number;
     /**
-     * 调整实例规格的商品代号
+     * 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
      */
     SkuCode?: string;
     /**
-     * 消息保留时长，小时为单位
+     * 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
+  
+  - 默认值：DefaultRetention 参数
+  - 最小值：RetentionLowerLimit 参数
+  - 最大值：RetentionUpperLimit 参数
      */
     MessageRetention?: number;
     /**
@@ -449,11 +446,14 @@ export interface ModifyInstanceRequest {
      */
     AclEnabled?: boolean;
     /**
-     * 最大可创建主题数
+     * 最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
+  
+  - 最小值和默认值：TopicNumLimit 参数
+  - 最大值：TopicNumUpperLimit 参数
      */
     MaxTopicNum?: number;
     /**
-     * 免费额度之外的主题个数
+     * 免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
      */
     ExtraTopicNum?: string;
     /**
@@ -542,13 +542,15 @@ export interface FusionInstanceItem {
      */
     GroupNumLimit?: number;
     /**
-     * 计费模式，
-  POSTPAID，按量计费
-  PREPAID，包年包月
+     * 计费模式，枚举值如下：
+  
+  - POSTPAID：按量计费
+  
+  - PREPAID：包年包月
      */
     PayMode?: string;
     /**
-     * 到期时间，秒为单位
+     * 到期时间，**Unix时间戳（毫秒）**
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ExpiryTime?: number;
@@ -581,22 +583,21 @@ export interface FusionInstanceItem {
     TpsLimit?: number;
     /**
      * 弹性TPS限流值
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     ScaledTpsLimit?: number;
     /**
      * 消息保留时间，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MessageRetention?: number;
     /**
      * 延迟消息最大时长，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MaxMessageDelay?: number;
     /**
-     * 是否自动续费
-  注意：此字段可能返回 null，表示取不到有效值。
+     * 预付费集群是否自动续费，枚举值如下：
+  
+  - 0: 不自动续费
+  - 1: 自动续费
      */
     RenewFlag?: number;
     /**
@@ -605,12 +606,12 @@ export interface FusionInstanceItem {
      */
     InstanceItemExtraInfo?: InstanceItemExtraInfo;
     /**
-     * 预销毁时间
+     * 预销毁时间，**Unix时间戳（毫秒）**
   注意：此字段可能返回 null，表示取不到有效值。
      */
     DestroyTime?: number;
     /**
-     * 所属可用区列表
+     * 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ZoneIds?: Array<number | bigint>;
@@ -713,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;
 }
@@ -863,19 +864,19 @@ export interface DescribeMQTTProductSKUListResponse {
  */
 export interface DescribeRoleListRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
 }
@@ -993,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;
 }
@@ -1217,6 +1218,23 @@ export interface DescribeInstanceListResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeConsumerClientList返回参数结构体
+ */
+export interface DescribeConsumerClientListResponse {
+    /**
+     * 查询总数
+     */
+    TotalCount?: number;
+    /**
+     * 消费客户端
+     */
+    Data?: Array<ConsumerClient>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ModifyInstance返回参数结构体
  */
@@ -1231,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;
     /**
@@ -1248,11 +1266,11 @@ export interface CreateConsumerGroupRequest {
      */
     ConsumeMessageOrderly: boolean;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
     /**
-     * 备注
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
     /**
@@ -1385,7 +1403,7 @@ export interface DescribeMQTTInsPublicEndpointsResponse {
  */
 export interface DescribeInstanceListRequest {
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
@@ -1393,11 +1411,11 @@ export interface DescribeInstanceListRequest {
      */
     TagFilters?: Array<TagFilter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
 }
@@ -1690,7 +1708,7 @@ export interface DeleteMQTTInsPublicEndpointResponse {
  */
 export interface DeleteInstanceRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
 }
@@ -1699,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;
     /**
@@ -1723,7 +1741,7 @@ export interface ModifyRoleRequest {
      */
     Remark?: string;
     /**
-     * Topic&Group维度权限配置
+     * Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
      */
     DetailedPerms?: Array<DetailedRolePerm>;
 }
@@ -1758,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;
     /**
@@ -1775,15 +1793,15 @@ export interface CreateTopicRequest {
      */
     TopicType: string;
     /**
-     * 队列数量
+     * 队列数量，取值范围3～16
      */
     QueueNum: number;
     /**
-     * 备注
+     * 备注，最多 128 字符
      */
     Remark?: string;
     /**
-     * 消息保留时长
+     * 消息保留时长（单位：小时）
      */
     MsgTTL?: number;
     /**
@@ -1796,31 +1814,31 @@ export interface CreateTopicRequest {
  */
 export interface DescribeMessageRequest {
     /**
-     * 集群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;
     /**
-     * 消息ID
+     * 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
      */
     MsgId: string;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 是否是死信消息
+     * 是否是死信消息，默认为false
      */
     QueryDeadLetterMessage?: boolean;
     /**
-     * 是否是延时消息
+     * 是否是延时消息，默认为false
      */
     QueryDelayMessage?: boolean;
 }
@@ -1829,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;
 }
@@ -1947,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;
 }
@@ -2054,7 +2072,7 @@ export interface DescribeTopicListByGroupResponse {
  */
 export interface DescribeMessageTraceResponse {
     /**
-     * 展示Topic名
+     * 主题名称
      */
     ShowTopicName?: string;
     /**
@@ -2180,13 +2198,15 @@ export interface InstanceItem {
      */
     GroupNumLimit?: number;
     /**
-     * 计费模式，
-  POSTPAID，按量计费
-  PREPAID，包年包月
+     * 计费模式，枚举值如下：
+  
+  - POSTPAID：按量计费
+  
+  - PREPAID：包年包月
      */
     PayMode?: string;
     /**
-     * 到期时间，秒为单位
+     * 到期时间戳，**Unix时间戳（毫秒）**
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ExpiryTime?: number;
@@ -2214,27 +2234,22 @@ export interface InstanceItem {
     SkuCode?: string;
     /**
      * TPS限流值
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     TpsLimit?: number;
     /**
      * 弹性TPS限流值
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     ScaledTpsLimit?: number;
     /**
      * 消息保留时间，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MessageRetention?: number;
     /**
      * 延迟消息最大时长，小时为单位
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MaxMessageDelay?: number;
     /**
-     * 是否自动续费
-  注意：此字段可能返回 null，表示取不到有效值。
+     * 是否自动续费，仅针对预付费集群（0: 不自动续费；1:自动续费）
      */
     RenewFlag?: number;
 }
@@ -2252,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;
 }
@@ -2286,23 +2301,23 @@ export interface DeleteMQTTInstanceRequest {
  */
 export interface DescribeMessageTraceRequest {
     /**
-     * 集群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;
     /**
-     * 消息ID
+     * 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
      */
     MsgId: string;
     /**
-     * 是否是死信消息
+     * 是否是死信消息，默认为false
      */
     QueryDeadLetterMessage?: boolean;
     /**
-     * 是否是延时消息
+     * 是否是延时消息，默认为false
      */
     QueryDelayMessage?: boolean;
 }
@@ -2564,7 +2579,7 @@ export interface DescribeMessageResponse {
      */
     MessageTracks?: Array<MessageTrackItem>;
     /**
-     * Topic
+     * 主题名称
      */
     ShowTopicName?: string;
     /**
@@ -2635,19 +2650,19 @@ export interface ImportSourceClusterTopicsResponse {
  */
 export interface DescribeTopicListRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
 }
@@ -2656,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;
     /**
@@ -2673,11 +2688,11 @@ export interface ModifyConsumerGroupRequest {
      */
     ConsumeMessageOrderly?: boolean;
     /**
-     * 最大重试次数
+     * 最大重试次数，取值范围0～1000
      */
     MaxRetryTimes?: number;
     /**
-     * 备注
+     * 备注信息，最多 128 个字符
      */
     Remark?: string;
 }
@@ -2686,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;
 }
@@ -2699,19 +2714,19 @@ export interface DescribeConsumerGroupRequest {
  */
 export interface DescribeConsumerGroupListRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
@@ -2744,7 +2759,7 @@ export interface TopicItem {
      */
     QueueNum?: number;
     /**
-     * 描述
+     * 备注信息
      */
     Remark?: string;
     /**
@@ -2769,7 +2784,6 @@ export interface TopicItem {
     FullNamespaceV4?: string;
     /**
      * 消息保留时长
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     MsgTTL?: number;
 }
@@ -2808,7 +2822,11 @@ export interface SubscriptionData {
      */
     IsOnline?: boolean;
     /**
-     * 消费类型
+     * 消费类型，枚举值如下：
+  
+  - PULL：PULL 消费类型
+  - PUSH：PUSH 消费类型
+  - POP：POP 消费类型
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ConsumeType?: string;
@@ -2823,7 +2841,10 @@ export interface SubscriptionData {
      */
     ExpressionType?: string;
     /**
-     * 订阅一致性
+     * 订阅一致性，枚举如下：
+  
+  - 0: 订阅一致
+  - 1: 订阅不一致
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Consistency?: number;
@@ -2865,19 +2886,23 @@ export interface SubscriptionData {
  */
 export interface CreateInstanceRequest {
     /**
-     * 实例类型，
-  EXPERIMENT 体验版
-  BASIC 基础版
-  PRO  专业版
-  PLATINUM 铂金版
+     * 实例类型，枚举值如下：
+  
+  - EXPERIMENT：体验版
+  
+  - BASIC：基础版
+  
+  - PRO：专业版
+  
+  - PLATINUM：铂金版
      */
     InstanceType: string;
     /**
-     * 集群名称
+     * 集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_”
      */
     Name: string;
     /**
-     * 商品规格，可用规格如下：experiment_500, basic_1k, basic_2k, basic_3k, basic_4k, basic_5k, basic_6k, basic_7k, basic_8k, basic_9k, basic_10k, pro_4k, pro_6k, pro_8k, pro_1w, pro_15k, pro_2w, pro_25k, pro_3w, pro_35k, pro_4w, pro_45k, pro_5w, pro_55k, pro_60k, pro_65k, pro_70k, pro_75k, pro_80k, pro_85k, pro_90k, pro_95k, pro_100k, platinum_1w, platinum_2w, platinum_3w, platinum_4w, platinum_5w, platinum_6w, platinum_7w, platinum_8w, platinum_9w, platinum_10w, platinum_12w, platinum_14w, platinum_16w, platinum_18w, platinum_20w, platinum_25w, platinum_30w, platinum_35w, platinum_40w, platinum_45w, platinum_50w, platinum_60w, platinum_70w, platinum_80w, platinum_90w, platinum_100w
+     * 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
      */
     SkuCode: string;
     /**
@@ -2905,11 +2930,15 @@ export interface CreateInstanceRequest {
      */
     Bandwidth?: number;
     /**
-     * 公网访问白名单
+     * 公网访问白名单，不填表示拒绝所有 IP 访问
      */
     IpRules?: Array<IpRule>;
     /**
-     * 消息保留时长（单位：小时）
+     * 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
+  
+  - 默认值：DefaultRetention 参数
+  - 最小值：RetentionLowerLimit 参数
+  - 最大值：RetentionUpperLimit 参数
      */
     MessageRetention?: number;
     /**
@@ -2917,19 +2946,22 @@ export interface CreateInstanceRequest {
      */
     PayMode?: number;
     /**
-     * 是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
+     * 预付费集群是否自动续费（0: 不自动续费；1: 自动续费），默认值为0
      */
     RenewFlag?: number;
     /**
-     * 购买时长（单位：月），默认值为1
+     * 预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1
      */
     TimeSpan?: number;
     /**
-     * 最大可创建主题数
+     * 最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参：
+  
+  - 默认值和最小值：TopicNumLimit 参数
+  - 最大值：TopicNumUpperLimit 参数
      */
     MaxTopicNum?: number;
     /**
-     * 部署可用区列表
+     * 部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口获得。
      */
     ZoneIds?: Array<number | bigint>;
 }
@@ -2959,7 +2991,12 @@ export interface ConsumerClient {
      */
     ConsumerLag?: number;
     /**
-     * 消费者客户端类型（grpc；remoting；http）
+     * 消费者客户端类型，枚举值如下：
+  
+  - grpc：GRPC协议
+  - remoting：Remoting协议
+  - http：HTTP协议
+  注意：此字段可能返回 null，表示取不到有效值。
      */
     ChannelProtocol?: string;
 }
@@ -2980,11 +3017,15 @@ export interface DescribeConsumerGroupResponse {
      */
     ConsumerLag?: number;
     /**
-     * 消费者类型
+     * 消费类型，枚举值如下：
+  
+  - PULL：PULL 消费类型
+  - PUSH：PUSH 消费类型
+  - POP：POP 消费类型
      */
     ConsumeType?: string;
     /**
-     * 创建时间，秒为单位
+     * 创建时间，**Unix时间戳（毫秒）**
      */
     CreatedTime?: number;
     /**
@@ -3020,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;
 }
@@ -3089,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>;
 }
@@ -3192,7 +3233,13 @@ export interface MQTTClientSubscription {
  */
 export interface MessageTraceItem {
     /**
-     * 步骤
+     * 消息处理阶段，枚举值如下：
+  
+  - produce：消息生产
+  
+  - persist：消息存储
+  
+  - consume：消息消费
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Stage?: string;
@@ -3207,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;
 }
@@ -3288,7 +3335,7 @@ export interface DescribeInstanceResponse {
      */
     MaxMessageDelay?: number;
     /**
-     * 创建时间，秒为单位
+     * 创建时间，**Unix时间戳（毫秒）**
      */
     CreatedTime?: number;
     /**
@@ -3318,7 +3365,17 @@ export interface DescribeInstanceResponse {
      */
     Remark?: string;
     /**
-     * 实例状态
+     * 实例状态，枚举值如下：
+  
+  - RUNNING：运行中
+  - ABNORMAL：异常
+  - OVERDUE：隔离中
+  - DESTROYED：已销毁
+  - CREATING：创建中
+  - MODIFYING：变配中
+  - CREATE_FAILURE：创建失败
+  - MODIFY_FAILURE：变配失败
+  - DELETING：删除中
      */
     InstanceStatus?: string;
     /**
@@ -3326,7 +3383,10 @@ export interface DescribeInstanceResponse {
      */
     SkuCode?: string;
     /**
-     * 计费模式
+     * 计费模式，枚举值如下：
+  
+  - POSTPAID：后付费按量计费
+  - PREPAID：预付费包年包月
      */
     PayMode?: string;
     /**
@@ -3334,11 +3394,14 @@ export interface DescribeInstanceResponse {
      */
     ScaledTpsEnabled?: boolean;
     /**
-     * 是否自动续费
+     * 预付费集群是否自动续费，枚举值如下：
+  
+  - 0: 不自动续费
+  - 1: 自动续费
      */
     RenewFlag?: number;
     /**
-     * 到期时间
+     * 到期时间，**Unix时间戳（毫秒）**
      */
     ExpiryTime?: number;
     /**
@@ -3361,7 +3424,7 @@ export interface DescribeInstanceResponse {
      */
     TopicNumUpperLimit?: number;
     /**
-     * 可用区列表
+     * 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
      */
     ZoneIds?: Array<number | bigint>;
     /**
@@ -3517,15 +3580,15 @@ export interface RollbackMigratingTopicStageResponse {
  */
 export interface DescribeFusionInstanceListRequest {
     /**
-     * 查询起始位置
+     * 查询起始位置，默认为0。
      */
     Offset?: number;
     /**
-     * 查询结果限制数量
+     * 查询结果限制数量，默认20。
      */
     Limit?: number;
     /**
-     * 查询条件列表
+     * 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
      */
     Filters?: Array<Filter>;
     /**
@@ -3634,7 +3697,7 @@ export interface MQTTUserItem {
  */
 export interface ModifyInstanceEndpointRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
@@ -3792,6 +3855,31 @@ export interface DescribeTopicListResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeConsumerClientList请求参数结构体
+ */
+export interface DescribeConsumerClientListRequest {
+    /**
+     * 腾讯云 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;
+}
 /**
  * 主题消费进度
  */
@@ -3801,7 +3889,12 @@ export interface TopicConsumeStats {
      */
     Topic?: string;
     /**
-     * 主题类型
+     * 主题类型，枚举值如下：
+  
+  - NORMAL：普通消息主题
+  - FIFO：顺序消息主题
+  - DELAY：延迟消息主题
+  - TRANSACTION：事务消息主题
      */
     TopicType?: string;
     /**
@@ -3813,11 +3906,11 @@ export interface TopicConsumeStats {
      */
     ConsumerLag?: number;
     /**
-     * 订阅规则
+     * 订阅规则，`*`表示订阅全部TAG
      */
     SubString?: string;
     /**
-     * 最后消费进度更新时间
+     * 最后消费进度更新时间，**Unix时间戳（毫秒）**
      */
     LastUpdateTime?: number;
 }
@@ -3839,7 +3932,7 @@ export interface DescribeMQTTTopicRequest {
  */
 export interface CreateRoleRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
     /**
@@ -3863,7 +3956,7 @@ export interface CreateRoleRequest {
      */
     PermType?: string;
     /**
-     * Topic&Group维度权限配置
+     * Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
      */
     DetailedPerms?: Array<DetailedRolePerm>;
 }
@@ -3881,10 +3974,13 @@ export interface DeleteConsumerGroupResponse {
  */
 export interface Endpoint {
     /**
-     * 接入点类型，枚举值如下
-  VPC: VPC;
-  PUBLIC: 公网;
-  INTERNAL: 支撑网;
+     * 接入点类型，枚举值如下：
+  
+  - VPC：VPC 网络
+  
+  - PUBLIC：公网
+  
+  - INTERNAL：支撑网
      */
     Type?: string;
     /**
@@ -3973,12 +4069,11 @@ export interface IpRule {
      */
     Ip: string;
     /**
-     * 是否允许放行
+     * 是否允许放行，默认为false表示拒绝
      */
     Allow: boolean;
     /**
      * 备注信息
-  注意：此字段可能返回 null，表示取不到有效值。
      */
     Remark: string;
 }
@@ -4051,11 +4146,11 @@ export interface RoleItem {
      */
     Remark?: string;
     /**
-     * 创建时间，秒为单位
+     * 角色的创建时间，**Unix时间戳（毫秒）**
      */
     CreatedTime?: number;
     /**
-     * 修改时间，秒为单位
+     * 角色的更新时间，**Unix时间戳（毫秒）**
      */
     ModifiedTime?: number;
     /**
@@ -4234,7 +4329,7 @@ export interface ModifyInstanceEndpointResponse {
  */
 export interface DescribeInstanceRequest {
     /**
-     * 集群ID
+     * 腾讯云 RocketMQ 实例 ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
      */
     InstanceId: string;
 }
@@ -4299,19 +4394,19 @@ export interface DescribeMQTTMessageListRequest {
  */
 export interface ResetConsumerGroupOffsetRequest {
     /**
-     * 集群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;
     /**
-     * 重置位点时间（单位：毫秒）-1表示重置到最新位点
+     * 重置位点的时间戳（单位：毫秒），指定为 -1 时表示重置到最新位点
      */
     ResetTimestamp: number;
     /**
-     * 消费组名称
+     * 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
      */
     ConsumerGroup?: string;
 }