tencentcloud-sdk-nodejs-tdmq 4.1.154 → 4.1.156

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-tdmq",
3
- "version": "4.1.154",
3
+ "version": "4.1.156",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -15,8 +15,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
15
15
  */
16
16
  CreateCluster(req: CreateClusterRequest, cb?: (error: string, rep: CreateClusterResponse) => void): Promise<CreateClusterResponse>;
17
17
  /**
18
- * 获取消费详情列表
19
- */
18
+ * 查询 RocketMQ 消费详情列表。
19
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群消费详情的接口文档见 [DescribeConsumerGroup](https://cloud.tencent.com/document/api/1493/97941)。
20
+ */
20
21
  DescribeRocketMQConsumeStats(req: DescribeRocketMQConsumeStatsRequest, cb?: (error: string, rep: DescribeRocketMQConsumeStatsResponse) => void): Promise<DescribeRocketMQConsumeStatsResponse>;
21
22
  /**
22
23
  * 删除角色,支持批量。
@@ -27,8 +28,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
27
28
  */
28
29
  DescribeRabbitMQExchanges(req: DescribeRabbitMQExchangesRequest, cb?: (error: string, rep: DescribeRabbitMQExchangesResponse) => void): Promise<DescribeRabbitMQExchangesResponse>;
29
30
  /**
30
- * 查询消息轨迹
31
- */
31
+ * 查询消息轨迹。
32
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消息轨迹的接口文档见 [DescribeMessageTrace](https://cloud.tencent.com/document/api/1493/114302)。
33
+ */
32
34
  DescribeRocketMQMsgTrace(req: DescribeRocketMQMsgTraceRequest, cb?: (error: string, rep: DescribeRocketMQMsgTraceResponse) => void): Promise<DescribeRocketMQMsgTraceResponse>;
33
35
  /**
34
36
  * 创建角色。
@@ -56,8 +58,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
56
58
  */
57
59
  DeleteTopics(req: DeleteTopicsRequest, cb?: (error: string, rep: DeleteTopicsResponse) => void): Promise<DeleteTopicsResponse>;
58
60
  /**
59
- * 删除RocketMQ消费组
60
- */
61
+ * 删除 RocketMQ 消费组。
62
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。删除 5.x 集群消费组的接口文档见 [DeleteConsumerGroup](https://cloud.tencent.com/document/api/1493/97942)。
63
+ */
61
64
  DeleteRocketMQGroup(req: DeleteRocketMQGroupRequest, cb?: (error: string, rep: DeleteRocketMQGroupResponse) => void): Promise<DeleteRocketMQGroupResponse>;
62
65
  /**
63
66
  * 删除专业集群——预付费,仅通过API 调用
@@ -69,8 +72,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
69
72
  */
70
73
  DeleteRocketMQRoles(req: DeleteRocketMQRolesRequest, cb?: (error: string, rep: DeleteRocketMQRolesResponse) => void): Promise<DeleteRocketMQRolesResponse>;
71
74
  /**
72
- * 获取指定消费组下当前客户端的连接情况
73
- */
75
+ * 查询 RocketMQ 消费组下的客户端连接列表。
76
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组下的客户端连接列表接口文档见 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140)。
77
+ */
74
78
  DescribeRocketMQConsumerConnections(req: DescribeRocketMQConsumerConnectionsRequest, cb?: (error: string, rep: DescribeRocketMQConsumerConnectionsResponse) => void): Promise<DescribeRocketMQConsumerConnectionsResponse>;
75
79
  /**
76
80
  * 创建RabbitMQ的用户
@@ -85,16 +89,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
85
89
  */
86
90
  RewindCmqQueue(req: RewindCmqQueueRequest, cb?: (error: string, rep: RewindCmqQueueResponse) => void): Promise<RewindCmqQueueResponse>;
87
91
  /**
88
- * 获取Topic生产详情列表
89
- */
92
+ * 查询 RocketMQ 主题生产详情列表。
93
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
94
+ */
90
95
  DescribeRocketMQTopicStats(req: DescribeRocketMQTopicStatsRequest, cb?: (error: string, rep: DescribeRocketMQTopicStatsResponse) => void): Promise<DescribeRocketMQTopicStatsResponse>;
91
96
  /**
92
97
  * 新增指定分区、类型的消息主题
93
98
  */
94
99
  CreateTopic(req: CreateTopicRequest, cb?: (error: string, rep: CreateTopicResponse) => void): Promise<CreateTopicResponse>;
95
100
  /**
96
- * 获取RocketMQ命名空间列表
97
- */
101
+ * 获取 RocketMQ 命名空间列表。
102
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
103
+ */
98
104
  DescribeRocketMQNamespaces(req: DescribeRocketMQNamespacesRequest, cb?: (error: string, rep: DescribeRocketMQNamespacesResponse) => void): Promise<DescribeRocketMQNamespacesResponse>;
99
105
  /**
100
106
  * 查询cmq全量队列
@@ -109,8 +115,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
109
115
  */
110
116
  DescribeClusterDetail(req: DescribeClusterDetailRequest, cb?: (error: string, rep: DescribeClusterDetailResponse) => void): Promise<DescribeClusterDetailResponse>;
111
117
  /**
112
- * 创建RocketMQ消费组
113
- */
118
+ * 创建 RocketMQ 消费组。
119
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。创建 5.x 集群消费组的接口文档见 [CreateConsumerGroup](https://cloud.tencent.com/document/api/1493/97943)。
120
+ */
114
121
  CreateRocketMQGroup(req: CreateRocketMQGroupRequest, cb?: (error: string, rep: CreateRocketMQGroupResponse) => void): Promise<CreateRocketMQGroupResponse>;
115
122
  /**
116
123
  * 根据提供的 MessageID 确认指定 topic 中的消息
@@ -134,20 +141,23 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
134
141
  */
135
142
  ModifyRocketMQEnvironmentRole(req: ModifyRocketMQEnvironmentRoleRequest, cb?: (error: string, rep: ModifyRocketMQEnvironmentRoleResponse) => void): Promise<ModifyRocketMQEnvironmentRoleResponse>;
136
143
  /**
137
- * 更新RocketMQ主题信息
138
- */
144
+ * 修改 RocketMQ 主题属性。
145
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。修改 5.x 集群主题属性的接口文档见 [ModifyTopic](https://cloud.tencent.com/document/api/1493/97944)。
146
+ */
139
147
  ModifyRocketMQTopic(req: ModifyRocketMQTopicRequest, cb?: (error: string, rep: ModifyRocketMQTopicResponse) => void): Promise<ModifyRocketMQTopicResponse>;
140
148
  /**
141
149
  * 执行域名异地访问切换,域名的访问指向将切换至备份集群。
142
150
  */
143
151
  ExecuteDisasterRecovery(req?: ExecuteDisasterRecoveryRequest, cb?: (error: string, rep: ExecuteDisasterRecoveryResponse) => void): Promise<ExecuteDisasterRecoveryResponse>;
144
152
  /**
145
- * rocketmq 消息查询
146
- */
153
+ * 查询 RocketMQ 消息列表。
154
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息列表接口文档见 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)。
155
+ */
147
156
  DescribeRocketMQTopicMsgs(req: DescribeRocketMQTopicMsgsRequest, cb?: (error: string, rep: DescribeRocketMQTopicMsgsResponse) => void): Promise<DescribeRocketMQTopicMsgsResponse>;
148
157
  /**
149
- * 查询 RocketMQ 指定主题下的生产者客户端列表。
150
- */
158
+ * 查询 RocketMQ 指定主题下的生产者客户端列表。
159
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群主题下的生产者客户端列表接口文档见 [DescribeProducerList](https://cloud.tencent.com/document/api/1493/122548)。
160
+ */
151
161
  DescribeRocketMQProducers(req: DescribeRocketMQProducersRequest, cb?: (error: string, rep: DescribeRocketMQProducersResponse) => void): Promise<DescribeRocketMQProducersResponse>;
152
162
  /**
153
163
  * 获取指定命名空间的属性
@@ -162,8 +172,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
162
172
  */
163
173
  DescribePublisherSummary(req: DescribePublisherSummaryRequest, cb?: (error: string, rep: DescribePublisherSummaryResponse) => void): Promise<DescribePublisherSummaryResponse>;
164
174
  /**
165
- * 删除RocketMQ命名空间
166
- */
175
+ * 删除 RocketMQ 命名空间。
176
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
177
+ */
167
178
  DeleteRocketMQNamespace(req: DeleteRocketMQNamespaceRequest, cb?: (error: string, rep: DeleteRocketMQNamespaceResponse) => void): Promise<DeleteRocketMQNamespaceResponse>;
168
179
  /**
169
180
  * 创建RabbitMQ的vhost
@@ -174,16 +185,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
174
185
  */
175
186
  DeleteCmqTopic(req: DeleteCmqTopicRequest, cb?: (error: string, rep: DeleteCmqTopicResponse) => void): Promise<DeleteCmqTopicResponse>;
176
187
  /**
177
- * 修改RocketMQ专享实例
178
- */
188
+ * 修改 RocketMQ 专享或通用集群属性。
189
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
190
+ */
179
191
  ModifyRocketMQInstance(req: ModifyRocketMQInstanceRequest, cb?: (error: string, rep: ModifyRocketMQInstanceResponse) => void): Promise<ModifyRocketMQInstanceResponse>;
180
192
  /**
181
193
  * 创建cmq队列接口
182
194
  */
183
195
  CreateCmqQueue(req: CreateCmqQueueRequest, cb?: (error: string, rep: CreateCmqQueueResponse) => void): Promise<CreateCmqQueueResponse>;
184
196
  /**
185
- * 更新RocketMQ消费组信息
186
- */
197
+ * 修改 RocketMQ 消费组属性。
198
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。修改 5.x 集群消费组属性的接口文档见 [ModifyConsumerGroup](https://cloud.tencent.com/document/api/1493/97940)。
199
+ */
187
200
  ModifyRocketMQGroup(req: ModifyRocketMQGroupRequest, cb?: (error: string, rep: ModifyRocketMQGroupResponse) => void): Promise<ModifyRocketMQGroupResponse>;
188
201
  /**
189
202
  * 获取RocketMQ主题详情
@@ -224,16 +237,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
224
237
  */
225
238
  CreateRocketMQEnvironmentRole(req: CreateRocketMQEnvironmentRoleRequest, cb?: (error: string, rep: CreateRocketMQEnvironmentRoleResponse) => void): Promise<CreateRocketMQEnvironmentRoleResponse>;
226
239
  /**
227
- * 获取在线消费端详情
228
- */
240
+ * 查询 RocketMQ 消费者客户端详情。
241
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消费者客户端详情接口文档见 [DescribeConsumerClient](https://cloud.tencent.com/document/api/1493/115240)。
242
+ */
229
243
  DescribeRocketMQConsumerConnectionDetail(req: DescribeRocketMQConsumerConnectionDetailRequest, cb?: (error: string, rep: DescribeRocketMQConsumerConnectionDetailResponse) => void): Promise<DescribeRocketMQConsumerConnectionDetailResponse>;
230
244
  /**
231
245
  * 获取单个 RabbitMQ 托管版实例信息
232
246
  */
233
247
  DescribeRabbitMQVipInstance(req: DescribeRabbitMQVipInstanceRequest, cb?: (error: string, rep: DescribeRabbitMQVipInstanceResponse) => void): Promise<DescribeRabbitMQVipInstanceResponse>;
234
248
  /**
235
- * 获取指定消费组下订阅的主题列表
236
- */
249
+ * 查询 RocketMQ 消费组订阅的主题列表。
250
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
251
+ */
237
252
  DescribeRocketMQTopicsByGroup(req: DescribeRocketMQTopicsByGroupRequest, cb?: (error: string, rep: DescribeRocketMQTopicsByGroupResponse) => void): Promise<DescribeRocketMQTopicsByGroupResponse>;
238
253
  /**
239
254
  * 查询公网指标监控数据,目前仅支持客户端到 LB 的入带宽和出宽带指标。
@@ -245,8 +260,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
245
260
  */
246
261
  ImportRocketMQTopics(req: ImportRocketMQTopicsRequest, cb?: (error: string, rep: ImportRocketMQTopicsResponse) => void): Promise<ImportRocketMQTopicsResponse>;
247
262
  /**
248
- * 该接口用于开启关闭公网访问、设置安全访问策略
249
- */
263
+ * 开启或关闭公网访问、设置安全访问策略。
264
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。设置 5.x 集群的公网接入点接口文档见 [ModifyInstanceEndpoint](https://cloud.tencent.com/document/api/1493/115981)。
265
+ */
250
266
  SetRocketMQPublicAccessPoint(req: SetRocketMQPublicAccessPointRequest, cb?: (error: string, rep: SetRocketMQPublicAccessPointResponse) => void): Promise<SetRocketMQPublicAccessPointResponse>;
251
267
  /**
252
268
  * 查询指定环境和主题下的订阅者列表
@@ -263,8 +279,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
263
279
  */
264
280
  DescribeCmqTopicDetail(req: DescribeCmqTopicDetailRequest, cb?: (error: string, rep: DescribeCmqTopicDetailResponse) => void): Promise<DescribeCmqTopicDetailResponse>;
265
281
  /**
266
- * 获取单个RocketMQ专享集群信息
267
- */
282
+ * 查询 RocketMQ 集群信息。
283
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
284
+ */
268
285
  DescribeRocketMQVipInstanceDetail(req: DescribeRocketMQVipInstanceDetailRequest, cb?: (error: string, rep: DescribeRocketMQVipInstanceDetailResponse) => void): Promise<DescribeRocketMQVipInstanceDetailResponse>;
269
286
  /**
270
287
  * 查询角色列表。
@@ -276,8 +293,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
276
293
  */
277
294
  DescribeRabbitMQUser(req: DescribeRabbitMQUserRequest, cb?: (error: string, rep: DescribeRabbitMQUserResponse) => void): Promise<DescribeRabbitMQUserResponse>;
278
295
  /**
279
- * 更新RocketMQ集群信息
280
- */
296
+ * 修改 RocketMQ 集群属性。
297
+ 当前 API 适用集群:4.x 虚拟集群。修改 4.x 专享或通用集群属性接口文档见 [ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862),修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
298
+ */
281
299
  ModifyRocketMQCluster(req: ModifyRocketMQClusterRequest, cb?: (error: string, rep: ModifyRocketMQClusterResponse) => void): Promise<ModifyRocketMQClusterResponse>;
282
300
  /**
283
301
  * 更新集群信息
@@ -292,16 +310,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
292
310
  */
293
311
  ModifyCmqSubscriptionAttribute(req: ModifyCmqSubscriptionAttributeRequest, cb?: (error: string, rep: ModifyCmqSubscriptionAttributeResponse) => void): Promise<ModifyCmqSubscriptionAttributeResponse>;
294
312
  /**
295
- * 用于获取RocketMQ消费组订阅关系数据
296
- */
313
+ * 查询 RocketMQ 消费组订阅关系列表。
314
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
315
+ */
297
316
  DescribeRocketMQSubscriptions(req: DescribeRocketMQSubscriptionsRequest, cb?: (error: string, rep: DescribeRocketMQSubscriptionsResponse) => void): Promise<DescribeRocketMQSubscriptionsResponse>;
298
317
  /**
299
318
  * 创建一个主题的订阅关系
300
319
  */
301
320
  CreateSubscription(req: CreateSubscriptionRequest, cb?: (error: string, rep: CreateSubscriptionResponse) => void): Promise<CreateSubscriptionResponse>;
302
321
  /**
303
- * 获取单个RocketMQ集群信息
304
- */
322
+ * 查询 RocketMQ 虚拟集群信息。
323
+ 当前 API 适用集群:4.x 虚拟集群。查询 4.x 专享或通用集群信息的接口文档见 [DescribeRocketMQVipInstanceDetail](https://cloud.tencent.com/document/api/1179/86725),查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
324
+ */
305
325
  DescribeRocketMQCluster(req: DescribeRocketMQClusterRequest, cb?: (error: string, rep: DescribeRocketMQClusterResponse) => void): Promise<DescribeRocketMQClusterResponse>;
306
326
  /**
307
327
  * 删除环境角色授权。
@@ -333,12 +353,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
333
353
  */
334
354
  DescribeBindVpcs(req: DescribeBindVpcsRequest, cb?: (error: string, rep: DescribeBindVpcsResponse) => void): Promise<DescribeBindVpcsResponse>;
335
355
  /**
336
- * 删除RocketMQ主题
337
- */
356
+ * 删除 RocketMQ 主题。
357
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。删除 5.x 集群主题的接口文档见 [DeleteTopic](https://cloud.tencent.com/document/api/1493/97946)。
358
+ */
338
359
  DeleteRocketMQTopic(req: DeleteRocketMQTopicRequest, cb?: (error: string, rep: DeleteRocketMQTopicResponse) => void): Promise<DeleteRocketMQTopicResponse>;
339
360
  /**
340
- * 重发RocketMQ死信消息
341
- */
361
+ * 重发 RocketMQ 死信消息。
362
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的重发死信消息接口文档见 [ResendDeadLetterMessage](https://cloud.tencent.com/document/api/1493/114592)。
363
+ */
342
364
  RetryRocketMQDlqMessage(req: RetryRocketMQDlqMessageRequest, cb?: (error: string, rep: RetryRocketMQDlqMessageResponse) => void): Promise<RetryRocketMQDlqMessageResponse>;
343
365
  /**
344
366
  * 导出RocketMQ消息详情
@@ -353,20 +375,23 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
353
375
  */
354
376
  ModifyCmqQueueAttribute(req: ModifyCmqQueueAttributeRequest, cb?: (error: string, rep: ModifyCmqQueueAttributeResponse) => void): Promise<ModifyCmqQueueAttributeResponse>;
355
377
  /**
356
- * 本API用于修改RocketMQ专享实例配置,可以支持实例规格、节点数和存储的升配和实例规格的降配。本API发起订单并成功支付后进入实例配置变更的流程,可通过DescribeRocketMQVipInstances查询实例是否已变更完成。
357
- */
378
+ * 修改 RocketMQ 专享集群配置,可以支持实例规格、节点数和存储的升配和实例规格的降配。本 API 发起订单并成功支付后进入实例配置变更的流程,可通过 [DescribeRocketMQVipInstances](https://cloud.tencent.com/document/api/1179/80903) 查询实例是否已变更完成。
379
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。修改 5.x 集群规格的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
380
+ */
358
381
  ModifyRocketMQInstanceSpec(req: ModifyRocketMQInstanceSpecRequest, cb?: (error: string, rep: ModifyRocketMQInstanceSpecResponse) => void): Promise<ModifyRocketMQInstanceSpecResponse>;
359
382
  /**
360
383
  * 输入迁移任务id和要导入的Group,导入后台
361
384
  */
362
385
  ImportRocketMQConsumerGroups(req: ImportRocketMQConsumerGroupsRequest, cb?: (error: string, rep: ImportRocketMQConsumerGroupsResponse) => void): Promise<ImportRocketMQConsumerGroupsResponse>;
363
386
  /**
364
- * 查询用户已购的RocketMQ专享实例列表
365
- */
387
+ * 查询 RocketMQ 4.x 集群列表。
388
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028),或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。
389
+ */
366
390
  DescribeRocketMQVipInstances(req: DescribeRocketMQVipInstancesRequest, cb?: (error: string, rep: DescribeRocketMQVipInstancesResponse) => void): Promise<DescribeRocketMQVipInstancesResponse>;
367
391
  /**
368
- * 用于获取RocketMQ指标排序列表,比如集群实例下占用存储空间最多的主题排序。
369
- */
392
+ * 用于获取RocketMQ指标排序列表,比如集群实例下占用存储空间最多的主题排序。
393
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
394
+ */
370
395
  DescribeRocketMQTopUsages(req: DescribeRocketMQTopUsagesRequest, cb?: (error: string, rep: DescribeRocketMQTopUsagesResponse) => void): Promise<DescribeRocketMQTopUsagesResponse>;
371
396
  /**
372
397
  * Rocketmq消费验证
@@ -391,12 +416,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
391
416
  */
392
417
  DescribeMqMsgTrace(req: DescribeMqMsgTraceRequest, cb?: (error: string, rep: DescribeMqMsgTraceResponse) => void): Promise<DescribeMqMsgTraceResponse>;
393
418
  /**
394
- * 获取RocketMQ消费组列表
395
- */
419
+ * 查询 RocketMQ 消费组列表。
420
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的消费组列表接口文档见 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)。
421
+ */
396
422
  DescribeRocketMQGroups(req: DescribeRocketMQGroupsRequest, cb?: (error: string, rep: DescribeRocketMQGroupsResponse) => void): Promise<DescribeRocketMQGroupsResponse>;
397
423
  /**
398
- * 创建RocketMQ主题
399
- */
424
+ * 批量创建 RocketMQ 主题。
425
+ 当前云 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
426
+ */
400
427
  CreateRocketMQTopic(req: CreateRocketMQTopicRequest, cb?: (error: string, rep: CreateRocketMQTopicResponse) => void): Promise<CreateRocketMQTopicResponse>;
401
428
  /**
402
429
  * 查询角色授权列表。
@@ -404,8 +431,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
404
431
  */
405
432
  DescribeRocketMQEnvironmentRoles(req: DescribeRocketMQEnvironmentRolesRequest, cb?: (error: string, rep: DescribeRocketMQEnvironmentRolesResponse) => void): Promise<DescribeRocketMQEnvironmentRolesResponse>;
406
433
  /**
407
- * 删除RocketMQ集群
408
- */
434
+ * 删除 RocketMQ 集群。
435
+ 当前 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)。
436
+ */
409
437
  DeleteRocketMQCluster(req: DeleteRocketMQClusterRequest, cb?: (error: string, rep: DeleteRocketMQClusterResponse) => void): Promise<DeleteRocketMQClusterResponse>;
410
438
  /**
411
439
  * 删除RabbitMQ的用户
@@ -471,16 +499,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
471
499
  */
472
500
  ModifyRabbitMQUser(req: ModifyRabbitMQUserRequest, cb?: (error: string, rep: ModifyRabbitMQUserResponse) => void): Promise<ModifyRabbitMQUserResponse>;
473
501
  /**
474
- * 创建RocketMQ命名空间
475
- */
502
+ * 创建 RocketMQ 命名空间。
503
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
504
+ */
476
505
  CreateRocketMQNamespace(req: CreateRocketMQNamespaceRequest, cb?: (error: string, rep: CreateRocketMQNamespaceResponse) => void): Promise<CreateRocketMQNamespaceResponse>;
477
506
  /**
478
507
  * 消息详情
479
508
  */
480
509
  DescribeMsg(req: DescribeMsgRequest, cb?: (error: string, rep: DescribeMsgResponse) => void): Promise<DescribeMsgResponse>;
481
510
  /**
482
- * 创建RocketMQ主题
483
- */
511
+ * 创建 RocketMQ 主题。
512
+ 当前云 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
513
+ */
484
514
  CreateRocketMQTopicV2(req: CreateRocketMQTopicV2Request, cb?: (error: string, rep: CreateRocketMQTopicV2Response) => void): Promise<CreateRocketMQTopicV2Response>;
485
515
  /**
486
516
  * 修改cmq主题属性
@@ -495,16 +525,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
495
525
  */
496
526
  CreateEnvironmentRole(req: CreateEnvironmentRoleRequest, cb?: (error: string, rep: CreateEnvironmentRoleResponse) => void): Promise<CreateEnvironmentRoleResponse>;
497
527
  /**
498
- * 获取RocketMQ主题列表
499
- */
528
+ * 查询 RocketMQ 主题列表。
529
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的主题列表接口文档见 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)。
530
+ */
500
531
  DescribeRocketMQTopics(req: DescribeRocketMQTopicsRequest, cb?: (error: string, rep: DescribeRocketMQTopicsResponse) => void): Promise<DescribeRocketMQTopicsResponse>;
501
532
  /**
502
533
  * 修改环境角色授权。
503
534
  */
504
535
  ModifyEnvironmentRole(req: ModifyEnvironmentRoleRequest, cb?: (error: string, rep: ModifyEnvironmentRoleResponse) => void): Promise<ModifyEnvironmentRoleResponse>;
505
536
  /**
506
- * 获取RocketMQ集群列表
507
- */
537
+ * 查询 RocketMQ 虚拟集群列表。
538
+ 当前 API 适用集群:4.x 虚拟集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028),或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。
539
+ */
508
540
  DescribeRocketMQClusters(req: DescribeRocketMQClustersRequest, cb?: (error: string, rep: DescribeRocketMQClustersResponse) => void): Promise<DescribeRocketMQClustersResponse>;
509
541
  /**
510
542
  * 发送单条消息
@@ -528,8 +560,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
528
560
  */
529
561
  CreateRole(req: CreateRoleRequest, cb?: (error: string, rep: CreateRoleResponse) => void): Promise<CreateRoleResponse>;
530
562
  /**
531
- * 更新RocketMQ命名空间
532
- */
563
+ * 更新 RocketMQ 命名空间。
564
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
565
+ */
533
566
  ModifyRocketMQNamespace(req: ModifyRocketMQNamespaceRequest, cb?: (error: string, rep: ModifyRocketMQNamespaceResponse) => void): Promise<ModifyRocketMQNamespaceResponse>;
534
567
  /**
535
568
  * 消息查询
@@ -548,16 +581,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
548
581
  */
549
582
  DescribePublishers(req: DescribePublishersRequest, cb?: (error: string, rep: DescribePublishersResponse) => void): Promise<DescribePublishersResponse>;
550
583
  /**
551
- * 此接口用于创建一个RocketMQ集群
552
- */
584
+ * 创建 RocketMQ 集群。
585
+ 当前 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)。
586
+ */
553
587
  CreateRocketMQCluster(req: CreateRocketMQClusterRequest, cb?: (error: string, rep: CreateRocketMQClusterResponse) => void): Promise<CreateRocketMQClusterResponse>;
554
588
  /**
555
589
  * 查询RabbitMQ队列详情
556
590
  */
557
591
  DescribeRabbitMQQueueDetail(req: DescribeRabbitMQQueueDetailRequest, cb?: (error: string, rep: DescribeRabbitMQQueueDetailResponse) => void): Promise<DescribeRabbitMQQueueDetailResponse>;
558
592
  /**
559
- * rocketmq消息详情
560
- */
593
+ * 查询 RocketMQ 消息详情。
594
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息详情接口文档见 [DescribeMessage](https://cloud.tencent.com/document/api/1493/114594)。
595
+ */
561
596
  DescribeRocketMQMsg(req: DescribeRocketMQMsgRequest, cb?: (error: string, rep: DescribeRocketMQMsgResponse) => void): Promise<DescribeRocketMQMsgResponse>;
562
597
  /**
563
598
  * 获取环境下主题列表
@@ -588,8 +623,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
588
623
  */
589
624
  SendMsg(req: SendMsgRequest, cb?: (error: string, rep: SendMsgResponse) => void): Promise<SendMsgResponse>;
590
625
  /**
591
- * 删除RocketMQ专享实例
592
- */
626
+ * 删除 RocketMQ 专享或通用集群。
627
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。删除 5.x 集群的接口文档见 [DeleteInstance](https://cloud.tencent.com/document/api/1493/97867)。
628
+ */
593
629
  DeleteRocketMQVipInstance(req: DeleteRocketMQVipInstanceRequest, cb?: (error: string, rep: DeleteRocketMQVipInstanceResponse) => void): Promise<DeleteRocketMQVipInstanceResponse>;
594
630
  /**
595
631
  * 发送 RocketMQ 消息,该接口仅用于控制台发送少量测试消息,不保证SLA,且云 API 存在限流,在真实业务场景下,请使用 RocketMQ SDK 发送消息。
@@ -604,8 +640,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
604
640
  */
605
641
  DeleteCmqSubscribe(req: DeleteCmqSubscribeRequest, cb?: (error: string, rep: DeleteCmqSubscribeResponse) => void): Promise<DeleteCmqSubscribeResponse>;
606
642
  /**
607
- * 接口用于查询RocketMQ实例的公网接入信息
608
- */
643
+ * 查询 RocketMQ 集群的公网接入点信息。
644
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的公网接入点信息接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
645
+ */
609
646
  DescribeRocketMQPublicAccessPoint(req: DescribeRocketMQPublicAccessPointRequest, cb?: (error: string, rep: DescribeRocketMQPublicAccessPointResponse) => void): Promise<DescribeRocketMQPublicAccessPointResponse>;
610
647
  /**
611
648
  * 解绑RabbitMQ路由关系
@@ -616,8 +653,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
616
653
  */
617
654
  ModifyRole(req: ModifyRoleRequest, cb?: (error: string, rep: ModifyRoleResponse) => void): Promise<ModifyRoleResponse>;
618
655
  /**
619
- * 创建RocketMQ专享实例
620
- */
656
+ * 创建 RocketMQ 4.x 集群。
657
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。创建 5.x 集群的接口文档见 [CreateInstance](https://cloud.tencent.com/document/api/1493/97868)。
658
+ */
621
659
  CreateRocketMQVipInstance(req: CreateRocketMQVipInstanceRequest, cb?: (error: string, rep: CreateRocketMQVipInstanceResponse) => void): Promise<CreateRocketMQVipInstanceResponse>;
622
660
  /**
623
661
  * 批量删除角色授权。
@@ -41,8 +41,9 @@ class Client extends TencentCloudCommon.AbstractClient {
41
41
  return this.request("CreateCluster", req, cb);
42
42
  }
43
43
  /**
44
- * 获取消费详情列表
45
- */
44
+ * 查询 RocketMQ 消费详情列表。
45
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群消费详情的接口文档见 [DescribeConsumerGroup](https://cloud.tencent.com/document/api/1493/97941)。
46
+ */
46
47
  async DescribeRocketMQConsumeStats(req, cb) {
47
48
  return this.request("DescribeRocketMQConsumeStats", req, cb);
48
49
  }
@@ -59,8 +60,9 @@ class Client extends TencentCloudCommon.AbstractClient {
59
60
  return this.request("DescribeRabbitMQExchanges", req, cb);
60
61
  }
61
62
  /**
62
- * 查询消息轨迹
63
- */
63
+ * 查询消息轨迹。
64
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消息轨迹的接口文档见 [DescribeMessageTrace](https://cloud.tencent.com/document/api/1493/114302)。
65
+ */
64
66
  async DescribeRocketMQMsgTrace(req, cb) {
65
67
  return this.request("DescribeRocketMQMsgTrace", req, cb);
66
68
  }
@@ -102,8 +104,9 @@ class Client extends TencentCloudCommon.AbstractClient {
102
104
  return this.request("DeleteTopics", req, cb);
103
105
  }
104
106
  /**
105
- * 删除RocketMQ消费组
106
- */
107
+ * 删除 RocketMQ 消费组。
108
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。删除 5.x 集群消费组的接口文档见 [DeleteConsumerGroup](https://cloud.tencent.com/document/api/1493/97942)。
109
+ */
107
110
  async DeleteRocketMQGroup(req, cb) {
108
111
  return this.request("DeleteRocketMQGroup", req, cb);
109
112
  }
@@ -121,8 +124,9 @@ class Client extends TencentCloudCommon.AbstractClient {
121
124
  return this.request("DeleteRocketMQRoles", req, cb);
122
125
  }
123
126
  /**
124
- * 获取指定消费组下当前客户端的连接情况
125
- */
127
+ * 查询 RocketMQ 消费组下的客户端连接列表。
128
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组下的客户端连接列表接口文档见 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140)。
129
+ */
126
130
  async DescribeRocketMQConsumerConnections(req, cb) {
127
131
  return this.request("DescribeRocketMQConsumerConnections", req, cb);
128
132
  }
@@ -145,8 +149,9 @@ class Client extends TencentCloudCommon.AbstractClient {
145
149
  return this.request("RewindCmqQueue", req, cb);
146
150
  }
147
151
  /**
148
- * 获取Topic生产详情列表
149
- */
152
+ * 查询 RocketMQ 主题生产详情列表。
153
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
154
+ */
150
155
  async DescribeRocketMQTopicStats(req, cb) {
151
156
  return this.request("DescribeRocketMQTopicStats", req, cb);
152
157
  }
@@ -157,8 +162,9 @@ class Client extends TencentCloudCommon.AbstractClient {
157
162
  return this.request("CreateTopic", req, cb);
158
163
  }
159
164
  /**
160
- * 获取RocketMQ命名空间列表
161
- */
165
+ * 获取 RocketMQ 命名空间列表。
166
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
167
+ */
162
168
  async DescribeRocketMQNamespaces(req, cb) {
163
169
  return this.request("DescribeRocketMQNamespaces", req, cb);
164
170
  }
@@ -181,8 +187,9 @@ class Client extends TencentCloudCommon.AbstractClient {
181
187
  return this.request("DescribeClusterDetail", req, cb);
182
188
  }
183
189
  /**
184
- * 创建RocketMQ消费组
185
- */
190
+ * 创建 RocketMQ 消费组。
191
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。创建 5.x 集群消费组的接口文档见 [CreateConsumerGroup](https://cloud.tencent.com/document/api/1493/97943)。
192
+ */
186
193
  async CreateRocketMQGroup(req, cb) {
187
194
  return this.request("CreateRocketMQGroup", req, cb);
188
195
  }
@@ -218,8 +225,9 @@ class Client extends TencentCloudCommon.AbstractClient {
218
225
  return this.request("ModifyRocketMQEnvironmentRole", req, cb);
219
226
  }
220
227
  /**
221
- * 更新RocketMQ主题信息
222
- */
228
+ * 修改 RocketMQ 主题属性。
229
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。修改 5.x 集群主题属性的接口文档见 [ModifyTopic](https://cloud.tencent.com/document/api/1493/97944)。
230
+ */
223
231
  async ModifyRocketMQTopic(req, cb) {
224
232
  return this.request("ModifyRocketMQTopic", req, cb);
225
233
  }
@@ -230,14 +238,16 @@ class Client extends TencentCloudCommon.AbstractClient {
230
238
  return this.request("ExecuteDisasterRecovery", req, cb);
231
239
  }
232
240
  /**
233
- * rocketmq 消息查询
234
- */
241
+ * 查询 RocketMQ 消息列表。
242
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息列表接口文档见 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)。
243
+ */
235
244
  async DescribeRocketMQTopicMsgs(req, cb) {
236
245
  return this.request("DescribeRocketMQTopicMsgs", req, cb);
237
246
  }
238
247
  /**
239
- * 查询 RocketMQ 指定主题下的生产者客户端列表。
240
- */
248
+ * 查询 RocketMQ 指定主题下的生产者客户端列表。
249
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群主题下的生产者客户端列表接口文档见 [DescribeProducerList](https://cloud.tencent.com/document/api/1493/122548)。
250
+ */
241
251
  async DescribeRocketMQProducers(req, cb) {
242
252
  return this.request("DescribeRocketMQProducers", req, cb);
243
253
  }
@@ -260,8 +270,9 @@ class Client extends TencentCloudCommon.AbstractClient {
260
270
  return this.request("DescribePublisherSummary", req, cb);
261
271
  }
262
272
  /**
263
- * 删除RocketMQ命名空间
264
- */
273
+ * 删除 RocketMQ 命名空间。
274
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
275
+ */
265
276
  async DeleteRocketMQNamespace(req, cb) {
266
277
  return this.request("DeleteRocketMQNamespace", req, cb);
267
278
  }
@@ -278,8 +289,9 @@ class Client extends TencentCloudCommon.AbstractClient {
278
289
  return this.request("DeleteCmqTopic", req, cb);
279
290
  }
280
291
  /**
281
- * 修改RocketMQ专享实例
282
- */
292
+ * 修改 RocketMQ 专享或通用集群属性。
293
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
294
+ */
283
295
  async ModifyRocketMQInstance(req, cb) {
284
296
  return this.request("ModifyRocketMQInstance", req, cb);
285
297
  }
@@ -290,8 +302,9 @@ class Client extends TencentCloudCommon.AbstractClient {
290
302
  return this.request("CreateCmqQueue", req, cb);
291
303
  }
292
304
  /**
293
- * 更新RocketMQ消费组信息
294
- */
305
+ * 修改 RocketMQ 消费组属性。
306
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。修改 5.x 集群消费组属性的接口文档见 [ModifyConsumerGroup](https://cloud.tencent.com/document/api/1493/97940)。
307
+ */
295
308
  async ModifyRocketMQGroup(req, cb) {
296
309
  return this.request("ModifyRocketMQGroup", req, cb);
297
310
  }
@@ -352,8 +365,9 @@ class Client extends TencentCloudCommon.AbstractClient {
352
365
  return this.request("CreateRocketMQEnvironmentRole", req, cb);
353
366
  }
354
367
  /**
355
- * 获取在线消费端详情
356
- */
368
+ * 查询 RocketMQ 消费者客户端详情。
369
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消费者客户端详情接口文档见 [DescribeConsumerClient](https://cloud.tencent.com/document/api/1493/115240)。
370
+ */
357
371
  async DescribeRocketMQConsumerConnectionDetail(req, cb) {
358
372
  return this.request("DescribeRocketMQConsumerConnectionDetail", req, cb);
359
373
  }
@@ -364,8 +378,9 @@ class Client extends TencentCloudCommon.AbstractClient {
364
378
  return this.request("DescribeRabbitMQVipInstance", req, cb);
365
379
  }
366
380
  /**
367
- * 获取指定消费组下订阅的主题列表
368
- */
381
+ * 查询 RocketMQ 消费组订阅的主题列表。
382
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
383
+ */
369
384
  async DescribeRocketMQTopicsByGroup(req, cb) {
370
385
  return this.request("DescribeRocketMQTopicsByGroup", req, cb);
371
386
  }
@@ -383,8 +398,9 @@ class Client extends TencentCloudCommon.AbstractClient {
383
398
  return this.request("ImportRocketMQTopics", req, cb);
384
399
  }
385
400
  /**
386
- * 该接口用于开启关闭公网访问、设置安全访问策略
387
- */
401
+ * 开启或关闭公网访问、设置安全访问策略。
402
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。设置 5.x 集群的公网接入点接口文档见 [ModifyInstanceEndpoint](https://cloud.tencent.com/document/api/1493/115981)。
403
+ */
388
404
  async SetRocketMQPublicAccessPoint(req, cb) {
389
405
  return this.request("SetRocketMQPublicAccessPoint", req, cb);
390
406
  }
@@ -409,8 +425,9 @@ class Client extends TencentCloudCommon.AbstractClient {
409
425
  return this.request("DescribeCmqTopicDetail", req, cb);
410
426
  }
411
427
  /**
412
- * 获取单个RocketMQ专享集群信息
413
- */
428
+ * 查询 RocketMQ 集群信息。
429
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
430
+ */
414
431
  async DescribeRocketMQVipInstanceDetail(req, cb) {
415
432
  return this.request("DescribeRocketMQVipInstanceDetail", req, cb);
416
433
  }
@@ -428,8 +445,9 @@ class Client extends TencentCloudCommon.AbstractClient {
428
445
  return this.request("DescribeRabbitMQUser", req, cb);
429
446
  }
430
447
  /**
431
- * 更新RocketMQ集群信息
432
- */
448
+ * 修改 RocketMQ 集群属性。
449
+ 当前 API 适用集群:4.x 虚拟集群。修改 4.x 专享或通用集群属性接口文档见 [ModifyRocketMQInstance](https://cloud.tencent.com/document/api/1179/108862),修改 5.x 集群属性的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
450
+ */
433
451
  async ModifyRocketMQCluster(req, cb) {
434
452
  return this.request("ModifyRocketMQCluster", req, cb);
435
453
  }
@@ -452,8 +470,9 @@ class Client extends TencentCloudCommon.AbstractClient {
452
470
  return this.request("ModifyCmqSubscriptionAttribute", req, cb);
453
471
  }
454
472
  /**
455
- * 用于获取RocketMQ消费组订阅关系数据
456
- */
473
+ * 查询 RocketMQ 消费组订阅关系列表。
474
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群查询消费组订阅的主题列表接口文档见 [DescribeTopicListByGroup](https://cloud.tencent.com/document/api/1493/115314)。
475
+ */
457
476
  async DescribeRocketMQSubscriptions(req, cb) {
458
477
  return this.request("DescribeRocketMQSubscriptions", req, cb);
459
478
  }
@@ -464,8 +483,9 @@ class Client extends TencentCloudCommon.AbstractClient {
464
483
  return this.request("CreateSubscription", req, cb);
465
484
  }
466
485
  /**
467
- * 获取单个RocketMQ集群信息
468
- */
486
+ * 查询 RocketMQ 虚拟集群信息。
487
+ 当前 API 适用集群:4.x 虚拟集群。查询 4.x 专享或通用集群信息的接口文档见 [DescribeRocketMQVipInstanceDetail](https://cloud.tencent.com/document/api/1179/86725),查询 5.x 集群信息的接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
488
+ */
469
489
  async DescribeRocketMQCluster(req, cb) {
470
490
  return this.request("DescribeRocketMQCluster", req, cb);
471
491
  }
@@ -513,14 +533,16 @@ class Client extends TencentCloudCommon.AbstractClient {
513
533
  return this.request("DescribeBindVpcs", req, cb);
514
534
  }
515
535
  /**
516
- * 删除RocketMQ主题
517
- */
536
+ * 删除 RocketMQ 主题。
537
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。删除 5.x 集群主题的接口文档见 [DeleteTopic](https://cloud.tencent.com/document/api/1493/97946)。
538
+ */
518
539
  async DeleteRocketMQTopic(req, cb) {
519
540
  return this.request("DeleteRocketMQTopic", req, cb);
520
541
  }
521
542
  /**
522
- * 重发RocketMQ死信消息
523
- */
543
+ * 重发 RocketMQ 死信消息。
544
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的重发死信消息接口文档见 [ResendDeadLetterMessage](https://cloud.tencent.com/document/api/1493/114592)。
545
+ */
524
546
  async RetryRocketMQDlqMessage(req, cb) {
525
547
  return this.request("RetryRocketMQDlqMessage", req, cb);
526
548
  }
@@ -543,8 +565,9 @@ class Client extends TencentCloudCommon.AbstractClient {
543
565
  return this.request("ModifyCmqQueueAttribute", req, cb);
544
566
  }
545
567
  /**
546
- * 本API用于修改RocketMQ专享实例配置,可以支持实例规格、节点数和存储的升配和实例规格的降配。本API发起订单并成功支付后进入实例配置变更的流程,可通过DescribeRocketMQVipInstances查询实例是否已变更完成。
547
- */
568
+ * 修改 RocketMQ 专享集群配置,可以支持实例规格、节点数和存储的升配和实例规格的降配。本 API 发起订单并成功支付后进入实例配置变更的流程,可通过 [DescribeRocketMQVipInstances](https://cloud.tencent.com/document/api/1179/80903) 查询实例是否已变更完成。
569
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。修改 5.x 集群规格的接口文档见 [ModifyInstance](https://cloud.tencent.com/document/api/1493/97865)。
570
+ */
548
571
  async ModifyRocketMQInstanceSpec(req, cb) {
549
572
  return this.request("ModifyRocketMQInstanceSpec", req, cb);
550
573
  }
@@ -555,14 +578,16 @@ class Client extends TencentCloudCommon.AbstractClient {
555
578
  return this.request("ImportRocketMQConsumerGroups", req, cb);
556
579
  }
557
580
  /**
558
- * 查询用户已购的RocketMQ专享实例列表
559
- */
581
+ * 查询 RocketMQ 4.x 集群列表。
582
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028),或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。
583
+ */
560
584
  async DescribeRocketMQVipInstances(req, cb) {
561
585
  return this.request("DescribeRocketMQVipInstances", req, cb);
562
586
  }
563
587
  /**
564
- * 用于获取RocketMQ指标排序列表,比如集群实例下占用存储空间最多的主题排序。
565
- */
588
+ * 用于获取RocketMQ指标排序列表,比如集群实例下占用存储空间最多的主题排序。
589
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群暂不支持该功能。
590
+ */
566
591
  async DescribeRocketMQTopUsages(req, cb) {
567
592
  return this.request("DescribeRocketMQTopUsages", req, cb);
568
593
  }
@@ -599,14 +624,16 @@ class Client extends TencentCloudCommon.AbstractClient {
599
624
  return this.request("DescribeMqMsgTrace", req, cb);
600
625
  }
601
626
  /**
602
- * 获取RocketMQ消费组列表
603
- */
627
+ * 查询 RocketMQ 消费组列表。
628
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的消费组列表接口文档见 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)。
629
+ */
604
630
  async DescribeRocketMQGroups(req, cb) {
605
631
  return this.request("DescribeRocketMQGroups", req, cb);
606
632
  }
607
633
  /**
608
- * 创建RocketMQ主题
609
- */
634
+ * 批量创建 RocketMQ 主题。
635
+ 当前云 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
636
+ */
610
637
  async CreateRocketMQTopic(req, cb) {
611
638
  return this.request("CreateRocketMQTopic", req, cb);
612
639
  }
@@ -618,8 +645,9 @@ class Client extends TencentCloudCommon.AbstractClient {
618
645
  return this.request("DescribeRocketMQEnvironmentRoles", req, cb);
619
646
  }
620
647
  /**
621
- * 删除RocketMQ集群
622
- */
648
+ * 删除 RocketMQ 集群。
649
+ 当前 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)。
650
+ */
623
651
  async DeleteRocketMQCluster(req, cb) {
624
652
  return this.request("DeleteRocketMQCluster", req, cb);
625
653
  }
@@ -709,8 +737,9 @@ class Client extends TencentCloudCommon.AbstractClient {
709
737
  return this.request("ModifyRabbitMQUser", req, cb);
710
738
  }
711
739
  /**
712
- * 创建RocketMQ命名空间
713
- */
740
+ * 创建 RocketMQ 命名空间。
741
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
742
+ */
714
743
  async CreateRocketMQNamespace(req, cb) {
715
744
  return this.request("CreateRocketMQNamespace", req, cb);
716
745
  }
@@ -721,8 +750,9 @@ class Client extends TencentCloudCommon.AbstractClient {
721
750
  return this.request("DescribeMsg", req, cb);
722
751
  }
723
752
  /**
724
- * 创建RocketMQ主题
725
- */
753
+ * 创建 RocketMQ 主题。
754
+ 当前云 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的创建 Topic 接口文档见 [CreateTopic](https://cloud.tencent.com/document/api/1493/97947)。
755
+ */
726
756
  async CreateRocketMQTopicV2(req, cb) {
727
757
  return this.request("CreateRocketMQTopicV2", req, cb);
728
758
  }
@@ -745,8 +775,9 @@ class Client extends TencentCloudCommon.AbstractClient {
745
775
  return this.request("CreateEnvironmentRole", req, cb);
746
776
  }
747
777
  /**
748
- * 获取RocketMQ主题列表
749
- */
778
+ * 查询 RocketMQ 主题列表。
779
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的主题列表接口文档见 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)。
780
+ */
750
781
  async DescribeRocketMQTopics(req, cb) {
751
782
  return this.request("DescribeRocketMQTopics", req, cb);
752
783
  }
@@ -757,8 +788,9 @@ class Client extends TencentCloudCommon.AbstractClient {
757
788
  return this.request("ModifyEnvironmentRole", req, cb);
758
789
  }
759
790
  /**
760
- * 获取RocketMQ集群列表
761
- */
791
+ * 查询 RocketMQ 虚拟集群列表。
792
+ 当前 API 适用集群:4.x 虚拟集群。查询 5.x 集群列表接口文档见 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028),或者使用 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口适用所有集群类型。
793
+ */
762
794
  async DescribeRocketMQClusters(req, cb) {
763
795
  return this.request("DescribeRocketMQClusters", req, cb);
764
796
  }
@@ -794,8 +826,9 @@ class Client extends TencentCloudCommon.AbstractClient {
794
826
  return this.request("CreateRole", req, cb);
795
827
  }
796
828
  /**
797
- * 更新RocketMQ命名空间
798
- */
829
+ * 更新 RocketMQ 命名空间。
830
+ 当前 API 适用集群:4.x 虚拟集群和 4.x 专享集群,其他集群类型均不支持该功能。
831
+ */
799
832
  async ModifyRocketMQNamespace(req, cb) {
800
833
  return this.request("ModifyRocketMQNamespace", req, cb);
801
834
  }
@@ -824,8 +857,9 @@ class Client extends TencentCloudCommon.AbstractClient {
824
857
  return this.request("DescribePublishers", req, cb);
825
858
  }
826
859
  /**
827
- * 此接口用于创建一个RocketMQ集群
828
- */
860
+ * 创建 RocketMQ 集群。
861
+ 当前 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)。
862
+ */
829
863
  async CreateRocketMQCluster(req, cb) {
830
864
  return this.request("CreateRocketMQCluster", req, cb);
831
865
  }
@@ -836,8 +870,9 @@ class Client extends TencentCloudCommon.AbstractClient {
836
870
  return this.request("DescribeRabbitMQQueueDetail", req, cb);
837
871
  }
838
872
  /**
839
- * rocketmq消息详情
840
- */
873
+ * 查询 RocketMQ 消息详情。
874
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。5.x 集群的查询消息详情接口文档见 [DescribeMessage](https://cloud.tencent.com/document/api/1493/114594)。
875
+ */
841
876
  async DescribeRocketMQMsg(req, cb) {
842
877
  return this.request("DescribeRocketMQMsg", req, cb);
843
878
  }
@@ -884,8 +919,9 @@ class Client extends TencentCloudCommon.AbstractClient {
884
919
  return this.request("SendMsg", req, cb);
885
920
  }
886
921
  /**
887
- * 删除RocketMQ专享实例
888
- */
922
+ * 删除 RocketMQ 专享或通用集群。
923
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。删除 5.x 集群的接口文档见 [DeleteInstance](https://cloud.tencent.com/document/api/1493/97867)。
924
+ */
889
925
  async DeleteRocketMQVipInstance(req, cb) {
890
926
  return this.request("DeleteRocketMQVipInstance", req, cb);
891
927
  }
@@ -908,8 +944,9 @@ class Client extends TencentCloudCommon.AbstractClient {
908
944
  return this.request("DeleteCmqSubscribe", req, cb);
909
945
  }
910
946
  /**
911
- * 接口用于查询RocketMQ实例的公网接入信息
912
- */
947
+ * 查询 RocketMQ 集群的公网接入点信息。
948
+ 当前 API 适用集群:4.x 虚拟集群,4.x 专享集群 和 4.x 通用集群。查询 5.x 集群的公网接入点信息接口文档见 [DescribeInstance](https://cloud.tencent.com/document/api/1493/97866)。
949
+ */
913
950
  async DescribeRocketMQPublicAccessPoint(req, cb) {
914
951
  return this.request("DescribeRocketMQPublicAccessPoint", req, cb);
915
952
  }
@@ -926,8 +963,9 @@ class Client extends TencentCloudCommon.AbstractClient {
926
963
  return this.request("ModifyRole", req, cb);
927
964
  }
928
965
  /**
929
- * 创建RocketMQ专享实例
930
- */
966
+ * 创建 RocketMQ 4.x 集群。
967
+ 当前 API 适用集群:4.x 专享集群 和 4.x 通用集群。创建 5.x 集群的接口文档见 [CreateInstance](https://cloud.tencent.com/document/api/1493/97868)。
968
+ */
931
969
  async CreateRocketMQVipInstance(req, cb) {
932
970
  return this.request("CreateRocketMQVipInstance", req, cb);
933
971
  }
@@ -429,7 +429,7 @@ export interface DeleteRocketMQGroupRequest {
429
429
  */
430
430
  ClusterId: string;
431
431
  /**
432
- * 命名空间名称
432
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
433
433
  */
434
434
  NamespaceId: string;
435
435
  /**
@@ -1333,7 +1333,7 @@ export interface DescribeRocketMQMsgRequest {
1333
1333
  */
1334
1334
  ClusterId: string;
1335
1335
  /**
1336
- * 命名空间
1336
+ * 命名空间,4.x 通用集群命名空间固定为: tdmq_default
1337
1337
  */
1338
1338
  EnvironmentId: string;
1339
1339
  /**
@@ -1475,7 +1475,7 @@ export interface DescribeRocketMQMsgTraceRequest {
1475
1475
  */
1476
1476
  ClusterId: string;
1477
1477
  /**
1478
- * 命名空间
1478
+ * 命名空间,4.x 通用集群命名空间固定为: tdmq_default
1479
1479
  */
1480
1480
  EnvironmentId: string;
1481
1481
  /**
@@ -1509,7 +1509,7 @@ export interface ModifyRocketMQGroupRequest {
1509
1509
  */
1510
1510
  ClusterId: string;
1511
1511
  /**
1512
- * 命名空间
1512
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
1513
1513
  */
1514
1514
  NamespaceId: string;
1515
1515
  /**
@@ -2448,7 +2448,7 @@ export interface DescribeRocketMQTopicMsgsRequest {
2448
2448
  */
2449
2449
  ClusterId: string;
2450
2450
  /**
2451
- * 命名空间
2451
+ * 命名空间,4.x 通用集群命名空间固定为: tdmq_default
2452
2452
  */
2453
2453
  EnvironmentId: string;
2454
2454
  /**
@@ -4318,7 +4318,7 @@ export interface DescribeRocketMQProducersRequest {
4318
4318
  */
4319
4319
  ClusterId: string;
4320
4320
  /**
4321
- * 命名空间
4321
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
4322
4322
  */
4323
4323
  NamespaceId: string;
4324
4324
  /**
@@ -4989,7 +4989,7 @@ export interface CreateRocketMQTopicRequest {
4989
4989
  */
4990
4990
  Topic: string;
4991
4991
  /**
4992
- * 主题所在的命名空间,目前支持在单个命名空间下创建主题
4992
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
4993
4993
  */
4994
4994
  Namespaces: Array<string>;
4995
4995
  /**
@@ -5387,7 +5387,7 @@ export interface DescribeRocketMQConsumerConnectionsRequest {
5387
5387
  */
5388
5388
  ClusterId: string;
5389
5389
  /**
5390
- * 命名空间名称
5390
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
5391
5391
  */
5392
5392
  NamespaceId: string;
5393
5393
  /**
@@ -5728,7 +5728,7 @@ export interface CreateRocketMQGroupRequest {
5728
5728
  */
5729
5729
  GroupId: string;
5730
5730
  /**
5731
- * 命名空间,目前只支持单个命名空间
5731
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
5732
5732
  */
5733
5733
  Namespaces: Array<string>;
5734
5734
  /**
@@ -5981,7 +5981,7 @@ export interface DescribeRocketMQTopicsRequest {
5981
5981
  */
5982
5982
  ClusterId: string;
5983
5983
  /**
5984
- * 命名空间
5984
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
5985
5985
  */
5986
5986
  NamespaceId: string;
5987
5987
  /**
@@ -6298,7 +6298,7 @@ export interface DescribeRocketMQTopicStatsRequest {
6298
6298
  */
6299
6299
  ClusterId: string;
6300
6300
  /**
6301
- * 命名空间
6301
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
6302
6302
  */
6303
6303
  NamespaceId: string;
6304
6304
  /**
@@ -6894,7 +6894,7 @@ export interface DescribeRocketMQConsumerConnectionDetailRequest {
6894
6894
  */
6895
6895
  ClusterId: string;
6896
6896
  /**
6897
- * 命名空间名称
6897
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
6898
6898
  */
6899
6899
  NamespaceId: string;
6900
6900
  /**
@@ -7009,7 +7009,7 @@ export interface ModifyRocketMQTopicRequest {
7009
7009
  */
7010
7010
  ClusterId: string;
7011
7011
  /**
7012
- * 命名空间名称
7012
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
7013
7013
  */
7014
7014
  NamespaceId: string;
7015
7015
  /**
@@ -7587,7 +7587,7 @@ export interface DescribeRocketMQSubscriptionsRequest {
7587
7587
  */
7588
7588
  ClusterId: string;
7589
7589
  /**
7590
- * 命名空间名称
7590
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
7591
7591
  */
7592
7592
  Namespace: string;
7593
7593
  /**
@@ -8001,7 +8001,7 @@ export interface DescribeRocketMQConsumeStatsRequest {
8001
8001
  */
8002
8002
  ClusterId: string;
8003
8003
  /**
8004
- * 命名空间
8004
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
8005
8005
  */
8006
8006
  NamespaceId: string;
8007
8007
  /**
@@ -8553,7 +8553,7 @@ export interface RetryRocketMQDlqMessageRequest {
8553
8553
  */
8554
8554
  ClusterId: string;
8555
8555
  /**
8556
- * 命名空间名称
8556
+ * 命名空间,4.x 通用集群命名空间固定为: tdmq_default
8557
8557
  */
8558
8558
  NamespaceId: string;
8559
8559
  /**
@@ -8574,7 +8574,7 @@ export interface DescribeRocketMQTopicsByGroupRequest {
8574
8574
  */
8575
8575
  ClusterId: string;
8576
8576
  /**
8577
- * 命名空间名称
8577
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
8578
8578
  */
8579
8579
  NamespaceId: string;
8580
8580
  /**
@@ -8659,7 +8659,7 @@ export interface CreateRocketMQTopicV2Request {
8659
8659
  */
8660
8660
  ClusterId: string;
8661
8661
  /**
8662
- * 命名空间
8662
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
8663
8663
  */
8664
8664
  Namespace: string;
8665
8665
  /**
@@ -10028,7 +10028,7 @@ export interface DeleteRocketMQTopicRequest {
10028
10028
  */
10029
10029
  ClusterId: string;
10030
10030
  /**
10031
- * 命名空间名称
10031
+ * 主题所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
10032
10032
  */
10033
10033
  NamespaceId: string;
10034
10034
  /**
@@ -10219,7 +10219,7 @@ export interface DescribeRocketMQGroupsRequest {
10219
10219
  */
10220
10220
  ClusterId: string;
10221
10221
  /**
10222
- * 命名空间
10222
+ * 消费组所在的命名空间,4.x 通用集群命名空间固定为: tdmq_default
10223
10223
  */
10224
10224
  NamespaceId: string;
10225
10225
  /**