tencentcloud-sdk-nodejs 4.1.66 → 4.1.68

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

@@ -46,7 +46,10 @@ Filters示例：
     /**
      * 根据消费组获取主题列表，Filter参数使用说明如下：
 
-TopicName，主题名称过滤
+- TopicName 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
+
+Filters示例：
+[{ "Name": "TopicName", "Values": ["test_topic"] }]
      */
     DescribeTopicListByGroup(req: DescribeTopicListByGroupRequest, cb?: (error: string, rep: DescribeTopicListByGroupResponse) => void): Promise<DescribeTopicListByGroupResponse>;
     /**
@@ -134,8 +137,11 @@ Filters示例：
     /**
      * 查询角色列表，Filter参数使用说明如下：
 
-1. RoleName，角色名称模糊搜索
-2. AccessKey，AccessKey模糊搜索
+- RoleName 角色名称，支持模糊搜索，从本接口返回值或控制台获得
+- AccessKey AccessKey，支持模糊搜索，从本接口返回值或控制台获得
+
+Filters示例：
+[{ "Name": "RoleName", "Values": ["test_role"] }]
      */
     DescribeRoleList(req: DescribeRoleListRequest, cb?: (error: string, rep: DescribeRoleListResponse) => void): Promise<DescribeRoleListResponse>;
     /**
@@ -167,7 +173,7 @@ Filters示例：
      */
     DescribeMigratingGroupStats(req: DescribeMigratingGroupStatsRequest, cb?: (error: string, rep: DescribeMigratingGroupStatsResponse) => void): Promise<DescribeMigratingGroupStatsResponse>;
     /**
-     * 删除角色
+     * 删除角色。请确保该角色相关信息不在当前代码中被使用。删除角色后，原先使用该角色进行生产或消费消息的密钥（AccessKey 和 SecretKey）将立即失效。
      */
     DeleteRole(req: DeleteRoleRequest, cb?: (error: string, rep: DeleteRoleResponse) => void): Promise<DeleteRoleResponse>;
     /**
@@ -248,8 +254,11 @@ Filters示例：
     /**
      * 获取主题列表，Filter参数使用说明如下：
 
-1. TopicName，主题名称模糊搜索
-2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
+- TopicName 主题名称，支持模糊搜索，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得
+- TopicType 主题类型查询，支持多选，参考 [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) 接口 TopicType 字段
+
+Filters示例：
+ [{ "Name": "TopicName", "Values": ["test_topic"] }]
      */
     DescribeTopicList(req: DescribeTopicListRequest, cb?: (error: string, rep: DescribeTopicListResponse) => void): Promise<DescribeTopicListResponse>;
     /**
@@ -281,8 +290,13 @@ Filters示例：
     /**
      * 获取消费组列表，Filter参数使用说明如下：
 
-1. ConsumerGroupName，名称模糊查询
-2. ConsumeMessageOrderly，投递顺序性。"true":顺序投递；"false":并发投递
+- ConsumerGroupName 消费组名称，支持模糊查询，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
+- ConsumeMessageOrderly，投递顺序性，枚举值如下：
+    - true 顺序投递
+    - false 并发投递
+
+Filters示例：
+[{ "Name": "ConsumeMessageOrderly", "Values": ["true"] }]
      */
     DescribeConsumerGroupList(req: DescribeConsumerGroupListRequest, cb?: (error: string, rep: DescribeConsumerGroupListResponse) => void): Promise<DescribeConsumerGroupListResponse>;
     /**
@@ -291,20 +305,31 @@ Filters示例：
     CreateMQTTInstance(req: CreateMQTTInstanceRequest, cb?: (error: string, rep: CreateMQTTInstanceResponse) => void): Promise<CreateMQTTInstanceResponse>;
     /**
      * 查询集群列表，仅支持 5.x 集群。Filters参数使用说明如下：
-1. InstanceName, 名称模糊查询
-2. InstanceId，集群ID查询
-3. InstanceType, 集群类型查询，支持多选
-3. InstanceStatus，集群状态查询，支持多选
 
-当使用TagFilters查询时，Filters参数失效。
+- InstanceName 集群名称，支持模糊搜索
+- InstanceId 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得
+- InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+- InstanceStatus 集群状态，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+
+Filters示例：
+[{
+    "Name": "InstanceId",
+    "Values": ["rmq-72mo3a9o"]
+}]
      */
     DescribeInstanceList(req: DescribeInstanceListRequest, cb?: (error: string, rep: DescribeInstanceListResponse) => void): Promise<DescribeInstanceListResponse>;
     /**
      * 查询集群列表，支持 4.x 和 5.x 集群，其中 Filters 参数使用说明如下：
-1. InstanceName, 名称模糊查询
-2. InstanceId，集群ID查询
-3. InstanceType, 集群类型查询，支持多选
-4. Version，集群版本查询
+
+- InstanceName 集群名称，支持模糊查询，从本接口返回值或控制台获得
+- InstanceId 集群ID，精确查询，从当前接口或控制台获得
+- InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+- Version 集群版本，枚举值如下：
+    - 4 RocketMQ 4.x 集群
+    - 5 RocketMQ 5.x 集群
+
+Filters示例：
+ [{ "Name": "InstanceId", "Values": ["rmq-72mo3a9o"] }]
      */
     DescribeFusionInstanceList(req: DescribeFusionInstanceListRequest, cb?: (error: string, rep: DescribeFusionInstanceListResponse) => void): Promise<DescribeFusionInstanceListResponse>;
     /**
@@ -322,7 +347,10 @@ Filters示例：
     /**
      * 查询主题详情，Offset和Limit参数是指订阅该主题的消费组查询分页参数，Filter参数使用说明如下：
 
-ConsumerGroup，消费组名称过滤
+- ConsumerGroup 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
+
+Filters示例：
+[{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
      */
     DescribeTopic(req: DescribeTopicRequest, cb?: (error: string, rep: DescribeTopicResponse) => void): Promise<DescribeTopicResponse>;
     /**

package/tencentcloud/services/trocket/v20230308/trocket_client.js

@@ -78,7 +78,10 @@ Filters示例：
     /**
      * 根据消费组获取主题列表，Filter参数使用说明如下：
 
-TopicName，主题名称过滤
+- TopicName 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
+
+Filters示例：
+[{ "Name": "TopicName", "Values": ["test_topic"] }]
      */
     async DescribeTopicListByGroup(req, cb) {
         return this.request("DescribeTopicListByGroup", req, cb);
@@ -196,8 +199,11 @@ Filters示例：
     /**
      * 查询角色列表，Filter参数使用说明如下：
 
-1. RoleName，角色名称模糊搜索
-2. AccessKey，AccessKey模糊搜索
+- RoleName 角色名称，支持模糊搜索，从本接口返回值或控制台获得
+- AccessKey AccessKey，支持模糊搜索，从本接口返回值或控制台获得
+
+Filters示例：
+[{ "Name": "RoleName", "Values": ["test_role"] }]
      */
     async DescribeRoleList(req, cb) {
         return this.request("DescribeRoleList", req, cb);
@@ -245,7 +251,7 @@ Filters示例：
         return this.request("DescribeMigratingGroupStats", req, cb);
     }
     /**
-     * 删除角色
+     * 删除角色。请确保该角色相关信息不在当前代码中被使用。删除角色后，原先使用该角色进行生产或消费消息的密钥（AccessKey 和 SecretKey）将立即失效。
      */
     async DeleteRole(req, cb) {
         return this.request("DeleteRole", req, cb);
@@ -364,8 +370,11 @@ Filters示例：
     /**
      * 获取主题列表，Filter参数使用说明如下：
 
-1. TopicName，主题名称模糊搜索
-2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
+- TopicName 主题名称，支持模糊搜索，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得
+- TopicType 主题类型查询，支持多选，参考 [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) 接口 TopicType 字段
+
+Filters示例：
+ [{ "Name": "TopicName", "Values": ["test_topic"] }]
      */
     async DescribeTopicList(req, cb) {
         return this.request("DescribeTopicList", req, cb);
@@ -409,8 +418,13 @@ Filters示例：
     /**
      * 获取消费组列表，Filter参数使用说明如下：
 
-1. ConsumerGroupName，名称模糊查询
-2. ConsumeMessageOrderly，投递顺序性。"true":顺序投递；"false":并发投递
+- ConsumerGroupName 消费组名称，支持模糊查询，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
+- ConsumeMessageOrderly，投递顺序性，枚举值如下：
+    - true 顺序投递
+    - false 并发投递
+
+Filters示例：
+[{ "Name": "ConsumeMessageOrderly", "Values": ["true"] }]
      */
     async DescribeConsumerGroupList(req, cb) {
         return this.request("DescribeConsumerGroupList", req, cb);
@@ -423,22 +437,33 @@ Filters示例：
     }
     /**
      * 查询集群列表，仅支持 5.x 集群。Filters参数使用说明如下：
-1. InstanceName, 名称模糊查询
-2. InstanceId，集群ID查询
-3. InstanceType, 集群类型查询，支持多选
-3. InstanceStatus，集群状态查询，支持多选
 
-当使用TagFilters查询时，Filters参数失效。
+- InstanceName 集群名称，支持模糊搜索
+- InstanceId 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得
+- InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+- InstanceStatus 集群状态，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+
+Filters示例：
+[{
+    "Name": "InstanceId",
+    "Values": ["rmq-72mo3a9o"]
+}]
      */
     async DescribeInstanceList(req, cb) {
         return this.request("DescribeInstanceList", req, cb);
     }
     /**
      * 查询集群列表，支持 4.x 和 5.x 集群，其中 Filters 参数使用说明如下：
-1. InstanceName, 名称模糊查询
-2. InstanceId，集群ID查询
-3. InstanceType, 集群类型查询，支持多选
-4. Version，集群版本查询
+
+- InstanceName 集群名称，支持模糊查询，从本接口返回值或控制台获得
+- InstanceId 集群ID，精确查询，从当前接口或控制台获得
+- InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
+- Version 集群版本，枚举值如下：
+    - 4 RocketMQ 4.x 集群
+    - 5 RocketMQ 5.x 集群
+
+Filters示例：
+ [{ "Name": "InstanceId", "Values": ["rmq-72mo3a9o"] }]
      */
     async DescribeFusionInstanceList(req, cb) {
         return this.request("DescribeFusionInstanceList", req, cb);
@@ -464,7 +489,10 @@ Filters示例：
     /**
      * 查询主题详情，Offset和Limit参数是指订阅该主题的消费组查询分页参数，Filter参数使用说明如下：
 
-ConsumerGroup，消费组名称过滤
+- ConsumerGroup 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
+
+Filters示例：
+[{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
      */
     async DescribeTopic(req, cb) {
         return this.request("DescribeTopic", req, cb);