tencentcloud-sdk-nodejs 4.1.153 → 4.1.155

package/tencentcloud/services/tdmq/v20200217/tdmq_client.js

@@ -40,7 +40,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateCluster", req, cb);
     }
     /**
-     * 获取消费详情列表
+     * 查询 RocketMQ 消费详情列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群消费详情的接口文档见 [DescribeConsumerGroup](https://cloud.tencent.com/document/api/1493/97941)。
      */
     async DescribeRocketMQConsumeStats(req, cb) {
         return this.request("DescribeRocketMQConsumeStats", req, cb);
@@ -58,13 +59,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRabbitMQExchanges", req, cb);
     }
     /**
-     * 查询消息轨迹
+     * 查询消息轨迹。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消息轨迹的接口文档见 [DescribeMessageTrace](https://cloud.tencent.com/document/api/1493/114302)。
      */
     async DescribeRocketMQMsgTrace(req, cb) {
         return this.request("DescribeRocketMQMsgTrace", req, cb);
     }
     /**
-     * 创建角色
+     * 创建角色。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建角色接口文档见 [CreateRole](https://cloud.tencent.com/document/api/1493/98864)。
      */
     async CreateRocketMQRole(req, cb) {
         return this.request("CreateRocketMQRole", req, cb);
@@ -100,7 +103,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DeleteTopics", req, cb);
     }
     /**
-     * 删除RocketMQ消费组
+     * 删除 RocketMQ 消费组。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。删除 5.x 集群消费组的接口文档见 [DeleteConsumerGroup](https://cloud.tencent.com/document/api/1493/97942)。
      */
     async DeleteRocketMQGroup(req, cb) {
         return this.request("DeleteRocketMQGroup", req, cb);
@@ -112,13 +116,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DeleteProCluster", req, cb);
     }
     /**
-     * 删除角色，支持批量。
+     * 批量删除角色。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的删除角色接口文档见 [DeleteRole](https://cloud.tencent.com/document/api/1493/98863)。
      */
     async DeleteRocketMQRoles(req, cb) {
         return this.request("DeleteRocketMQRoles", req, cb);
     }
     /**
-     * 获取指定消费组下当前客户端的连接情况
+     * 查询 RocketMQ 消费组下的客户端连接列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组下的客户端连接列表接口文档见 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140)。
      */
     async DescribeRocketMQConsumerConnections(req, cb) {
         return this.request("DescribeRocketMQConsumerConnections", req, cb);
@@ -142,7 +148,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("RewindCmqQueue", req, cb);
     }
     /**
-     * 获取Topic生产详情列表
+     * 查询 RocketMQ 主题生产详情列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
      */
     async DescribeRocketMQTopicStats(req, cb) {
         return this.request("DescribeRocketMQTopicStats", req, cb);
@@ -154,7 +161,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateTopic", req, cb);
     }
     /**
-     * 获取RocketMQ命名空间列表
+     * 获取 RocketMQ 命名空间列表。
+当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。
      */
     async DescribeRocketMQNamespaces(req, cb) {
         return this.request("DescribeRocketMQNamespaces", req, cb);
@@ -178,7 +186,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeClusterDetail", req, cb);
     }
     /**
-     * 创建RocketMQ消费组
+     * 创建 RocketMQ 消费组。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。创建 5.x 集群消费组的接口文档见 [CreateConsumerGroup](https://cloud.tencent.com/document/api/1493/97943)。
      */
     async CreateRocketMQGroup(req, cb) {
         return this.request("CreateRocketMQGroup", req, cb);
@@ -208,13 +217,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyPublicNetworkSecurityPolicy", req, cb);
     }
     /**
-     * 修改环境角色授权。
+     * 修改角色授权。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的修改角色接口文档见 [ModifyRole](https://cloud.tencent.com/document/api/1493/98861)。
      */
     async ModifyRocketMQEnvironmentRole(req, cb) {
         return this.request("ModifyRocketMQEnvironmentRole", req, cb);
     }
     /**
-     * 更新RocketMQ主题信息
+     * 修改 RocketMQ 主题属性。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。修改 5.x 集群主题属性的接口文档见 [ModifyTopic](https://cloud.tencent.com/document/api/1493/97944)。
      */
     async ModifyRocketMQTopic(req, cb) {
         return this.request("ModifyRocketMQTopic", req, cb);
@@ -226,7 +237,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ExecuteDisasterRecovery", req, cb);
     }
     /**
-     * rocketmq 消息查询
+     * 查询 RocketMQ 消息列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息列表接口文档见 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)。
      */
     async DescribeRocketMQTopicMsgs(req, cb) {
         return this.request("DescribeRocketMQTopicMsgs", req, cb);
@@ -256,7 +268,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribePublisherSummary", req, cb);
     }
     /**
-     * 删除RocketMQ命名空间
+     * 删除 RocketMQ 命名空间。
+当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。
      */
     async DeleteRocketMQNamespace(req, cb) {
         return this.request("DeleteRocketMQNamespace", req, cb);
@@ -286,7 +299,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateCmqQueue", req, cb);
     }
     /**
-     * 更新RocketMQ消费组信息
+     * 修改 RocketMQ 消费组属性。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。修改 5.x 集群消费组属性的接口文档见 [ModifyConsumerGroup](https://cloud.tencent.com/document/api/1493/97940)。
      */
     async ModifyRocketMQGroup(req, cb) {
         return this.request("ModifyRocketMQGroup", req, cb);
@@ -316,7 +330,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DeleteCluster", req, cb);
     }
     /**
-     * 重置指定Group的消费位点到指定时间戳
+     * 重置消费位点。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的重置消费位点接口文档见 [ResetConsumerGroupOffset](https://cloud.tencent.com/document/api/1493/116942)。
      */
     async ResetRocketMQConsumerOffSet(req, cb) {
         return this.request("ResetRocketMQConsumerOffSet", req, cb);
@@ -340,13 +355,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("GetTopicList", req, cb);
     }
     /**
-     * 创建环境角色授权
+     * 创建角色授权。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建角色接口文档见 [CreateRole](https://cloud.tencent.com/document/api/1493/98864)。
      */
     async CreateRocketMQEnvironmentRole(req, cb) {
         return this.request("CreateRocketMQEnvironmentRole", req, cb);
     }
     /**
-     * 获取在线消费端详情
+     * 查询 RocketMQ 消费者客户端详情。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消费者客户端详情接口文档见 [DescribeConsumerClient](https://cloud.tencent.com/document/api/1493/115240)。
      */
     async DescribeRocketMQConsumerConnectionDetail(req, cb) {
         return this.request("DescribeRocketMQConsumerConnectionDetail", req, cb);
@@ -358,7 +375,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRabbitMQVipInstance", req, cb);
     }
     /**
-     * 获取指定消费组下订阅的主题列表
+     * 查询 RocketMQ 消费组订阅的主题列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
      */
     async DescribeRocketMQTopicsByGroup(req, cb) {
         return this.request("DescribeRocketMQTopicsByGroup", req, cb);
@@ -409,7 +427,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeRocketMQVipInstanceDetail", req, cb);
     }
     /**
-     * 获取角色列表
+     * 查询角色列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询角色列表接口文档见 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862)。
      */
     async DescribeRocketMQRoles(req, cb) {
         return this.request("DescribeRocketMQRoles", req, cb);
@@ -445,7 +464,8 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ModifyCmqSubscriptionAttribute", req, cb);
     }
     /**
-     * 用于获取RocketMQ消费组订阅关系数据
+     * 查询 RocketMQ 消费组订阅关系列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
      */
     async DescribeRocketMQSubscriptions(req, cb) {
         return this.request("DescribeRocketMQSubscriptions", req, cb);
@@ -481,13 +501,14 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateRabbitMQBinding", req, cb);
     }
     /**
-     * 查询消息轨迹
+     * 查询单条消息的消息轨迹
      */
     async DescribeMsgTrace(req, cb) {
         return this.request("DescribeMsgTrace", req, cb);
     }
     /**
-     * 角色修改
+     * 修改角色。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的修改角色接口文档见 [ModifyRole](https://cloud.tencent.com/document/api/1493/98861)。
      */
     async ModifyRocketMQRole(req, cb) {
         return this.request("ModifyRocketMQRole", req, cb);
@@ -505,13 +526,15 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeBindVpcs", req, cb);
     }
     /**
-     * 删除RocketMQ主题
+     * 删除 RocketMQ 主题。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。删除 5.x 集群主题的接口文档见 [DeleteTopic](https://cloud.tencent.com/document/api/1493/97946)。
      */
     async DeleteRocketMQTopic(req, cb) {
         return this.request("DeleteRocketMQTopic", req, cb);
     }
     /**
-     * 重发RocketMQ死信消息
+     * 重发 RocketMQ 死信消息。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的重发死信消息接口文档见 [ResendDeadLetterMessage](https://cloud.tencent.com/document/api/1493/114592)。
      */
     async RetryRocketMQDlqMessage(req, cb) {
         return this.request("RetryRocketMQDlqMessage", req, cb);
@@ -591,25 +614,29 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeMqMsgTrace", req, cb);
     }
     /**
-     * 获取RocketMQ消费组列表
+     * 查询 RocketMQ 消费组列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的消费组列表接口文档见 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)。
      */
     async DescribeRocketMQGroups(req, cb) {
         return this.request("DescribeRocketMQGroups", req, cb);
     }
     /**
-     * 创建RocketMQ主题
+     * 批量创建 RocketMQ 主题。
+当前云 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
      */
     async CreateRocketMQTopic(req, cb) {
         return this.request("CreateRocketMQTopic", req, cb);
     }
     /**
-     * 获取命名空间角色列表
+     * 查询角色授权列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的查询角色列表接口文档见 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862)。
      */
     async DescribeRocketMQEnvironmentRoles(req, cb) {
         return this.request("DescribeRocketMQEnvironmentRoles", req, cb);
     }
     /**
-     * 删除RocketMQ集群
+     * 删除 RocketMQ 集群。
+当前 API 适用集群：4.x 虚拟集群。删除 4.x 专享或通用集群的接口文档见 [DeleteRocketMQVipInstance](https://cloud.tencent.com/document/api/1179/95802)，删除 5.x 集群的接口文档见 [DeleteInstance](https://cloud.tencent.com/document/product/1493/97867)。
      */
     async DeleteRocketMQCluster(req, cb) {
         return this.request("DeleteRocketMQCluster", req, cb);
@@ -700,7 +727,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("ModifyRabbitMQUser", req, cb);
     }
     /**
-     * 创建RocketMQ命名空间
+     * 创建 RocketMQ 命名空间。
+当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。
      */
     async CreateRocketMQNamespace(req, cb) {
         return this.request("CreateRocketMQNamespace", req, cb);
@@ -712,7 +740,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("DescribeMsg", req, cb);
     }
     /**
-     * 创建RocketMQ主题
+     * 创建 RocketMQ 主题。
+当前云 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
      */
     async CreateRocketMQTopicV2(req, cb) {
         return this.request("CreateRocketMQTopicV2", req, cb);
@@ -736,7 +765,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("CreateEnvironmentRole", req, cb);
     }
     /**
-     * 获取RocketMQ主题列表
+     * 查询 RocketMQ 主题列表。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的主题列表接口文档见 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)。
      */
     async DescribeRocketMQTopics(req, cb) {
         return this.request("DescribeRocketMQTopics", req, cb);
@@ -785,7 +815,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("CreateRole", req, cb);
     }
     /**
-     * 更新RocketMQ命名空间
+     * 更新 RocketMQ 命名空间。
+当前 API 适用集群：4.x 虚拟集群和 4.x 专享集群，其他集群类型均不支持该功能。
      */
     async ModifyRocketMQNamespace(req, cb) {
         return this.request("ModifyRocketMQNamespace", req, cb);
@@ -815,7 +846,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("DescribePublishers", req, cb);
     }
     /**
-     * 此接口用于创建一个RocketMQ集群
+     * 创建 RocketMQ 集群。
+当前 API 适用集群：4.x 虚拟集群。创建 4.x 专享或通用集群的接口文档见 [CreateRocketMQVipInstance](https://cloud.tencent.com/document/api/1179/95721)，创建 5.x 集群接口文档见 [CreateInstance](https://cloud.tencent.com/document/api/1493/97868)。
      */
     async CreateRocketMQCluster(req, cb) {
         return this.request("CreateRocketMQCluster", req, cb);
@@ -923,7 +955,8 @@ BatchReceivePolicy 的接口会一次性返回多条消息：
         return this.request("CreateRocketMQVipInstance", req, cb);
     }
     /**
-     * 删除环境角色授权。
+     * 批量删除角色授权。
+当前 API 适用集群：4.x 虚拟集群，4.x 专享集群 和 4.x 通用集群。5.x 集群的删除角色接口文档见 [DeleteRole](https://cloud.tencent.com/document/api/1493/98863)。
      */
     async DeleteRocketMQEnvironmentRoles(req, cb) {
         return this.request("DeleteRocketMQEnvironmentRoles", req, cb);