tencentcloud-sdk-nodejs 4.1.63 → 4.1.65

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.
Files changed (68) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/bh/v20230418/bh_client.js +20 -2
  3. package/es/services/emr/v20190103/emr_client.js +161 -158
  4. package/es/services/kms/v20190118/kms_client.js +59 -14
  5. package/es/services/lke/v20231130/lke_client.js +16 -4
  6. package/es/services/trocket/v20230308/trocket_client.js +5 -2
  7. package/es/services/wedata/v20210820/wedata_client.js +10 -4
  8. package/package.json +1 -1
  9. package/tencentcloud/common/abstract_client.d.ts +111 -13
  10. package/tencentcloud/common/abstract_client.js +82 -15
  11. package/tencentcloud/common/common_client.d.ts +7 -0
  12. package/tencentcloud/common/common_client.js +7 -0
  13. package/tencentcloud/common/cvm_role_credential.d.ts +6 -0
  14. package/tencentcloud/common/cvm_role_credential.js +10 -1
  15. package/tencentcloud/common/http/http_connection.js +1 -2
  16. package/tencentcloud/common/interface.d.ts +35 -36
  17. package/tencentcloud/common/interface.js +1 -1
  18. package/tencentcloud/common/sdk_version.d.ts +1 -1
  19. package/tencentcloud/common/sdk_version.js +1 -1
  20. package/tencentcloud/common/sign.js +1 -1
  21. package/tencentcloud/common/sse_response_model.d.ts +26 -2
  22. package/tencentcloud/common/sse_response_model.js +17 -2
  23. package/tencentcloud/services/bh/v20230418/bh_client.d.ts +27 -3
  24. package/tencentcloud/services/bh/v20230418/bh_client.js +39 -3
  25. package/tencentcloud/services/bh/v20230418/bh_models.d.ts +315 -56
  26. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
  27. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +25 -19
  28. package/tencentcloud/services/cdb/v20170320/cdb_client.js +25 -19
  29. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +143 -107
  30. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +12 -2
  31. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -0
  32. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +44 -0
  33. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +12 -0
  34. package/tencentcloud/services/dsgc/v20190723/dsgc_client.d.ts +1 -3
  35. package/tencentcloud/services/dsgc/v20190723/dsgc_client.js +1 -3
  36. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +93 -6
  37. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +182 -178
  38. package/tencentcloud/services/emr/v20190103/emr_client.js +272 -266
  39. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +5762 -5634
  40. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +1 -0
  41. package/tencentcloud/services/ess/v20201111/ess_client.js +1 -0
  42. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +13 -3
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -0
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -0
  45. package/tencentcloud/services/gs/v20191118/gs_models.d.ts +4 -0
  46. package/tencentcloud/services/kms/v20190118/kms_client.d.ts +76 -16
  47. package/tencentcloud/services/kms/v20190118/kms_client.js +112 -22
  48. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +572 -53
  49. package/tencentcloud/services/live/v20180801/live_models.d.ts +4 -0
  50. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +21 -5
  51. package/tencentcloud/services/lke/v20231130/lke_client.js +30 -6
  52. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +5094 -4554
  53. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +32 -0
  54. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +4 -0
  55. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +2 -2
  56. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +2 -0
  57. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +0 -4
  58. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +4 -0
  59. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +14 -2
  60. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +4 -0
  61. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +42 -20
  62. package/tencentcloud/services/trocket/v20230308/trocket_client.js +44 -20
  63. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +198 -119
  64. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +4 -0
  65. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +33 -9
  66. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +15 -7
  67. package/tencentcloud/services/wedata/v20210820/wedata_client.js +20 -8
  68. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +256 -54
@@ -71,42 +71,34 @@ export interface ProductSKU {
71
71
  SkuCode?: string;
72
72
  /**
73
73
  * TPS上限
74
- 注意:此字段可能返回 null,表示取不到有效值。
75
74
  */
76
75
  TpsLimit?: number;
77
76
  /**
78
77
  * 弹性TPS上限
79
- 注意:此字段可能返回 null,表示取不到有效值。
80
78
  */
81
79
  ScaledTpsLimit?: number;
82
80
  /**
83
81
  * 主题数量上限默认值
84
- 注意:此字段可能返回 null,表示取不到有效值。
85
82
  */
86
83
  TopicNumLimit?: number;
87
84
  /**
88
85
  * 消费组数量上限
89
- 注意:此字段可能返回 null,表示取不到有效值。
90
86
  */
91
87
  GroupNumLimit?: number;
92
88
  /**
93
89
  * 默认消息保留时间,小时为单位
94
- 注意:此字段可能返回 null,表示取不到有效值。
95
90
  */
96
91
  DefaultRetention?: number;
97
92
  /**
98
93
  * 可调整消息保留时间上限,小时为单位
99
- 注意:此字段可能返回 null,表示取不到有效值。
100
94
  */
101
95
  RetentionUpperLimit?: number;
102
96
  /**
103
97
  * 可调整消息保留时间下限,小时为单位
104
- 注意:此字段可能返回 null,表示取不到有效值。
105
98
  */
106
99
  RetentionLowerLimit?: number;
107
100
  /**
108
101
  * 延时消息最大时长,小时为单位
109
- 注意:此字段可能返回 null,表示取不到有效值。
110
102
  */
111
103
  MaxMessageDelay?: number;
112
104
  /**
@@ -119,7 +111,6 @@ export interface ProductSKU {
119
111
  PriceTags?: Array<PriceTag>;
120
112
  /**
121
113
  * 主题数量上限默认最大值
122
- 注意:此字段可能返回 null,表示取不到有效值。
123
114
  */
124
115
  TopicNumUpperLimit?: number;
125
116
  }
@@ -351,43 +342,43 @@ export interface ModifyRoleResponse {
351
342
  */
352
343
  export interface DescribeMessageListRequest {
353
344
  /**
354
- * 集群ID
345
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
355
346
  */
356
347
  InstanceId: string;
357
348
  /**
358
- * 主题名称
349
+ * 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
359
350
  */
360
351
  Topic: string;
361
352
  /**
362
- * 开始时间
353
+ * 要查询消息的开始时间,**Unix时间戳(毫秒)**
363
354
  */
364
355
  StartTime: number;
365
356
  /**
366
- * 结束时间
357
+ * 要查询消息的结束时间,**Unix时间戳(毫秒)**
367
358
  */
368
359
  EndTime: number;
369
360
  /**
370
- * 一次查询标识
361
+ * 一次查询标识。第一次查询可传空字符串,当查询结果涉及分页,请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
371
362
  */
372
363
  TaskRequestId: string;
373
364
  /**
374
- * 查询起始位置
365
+ * 查询起始位置,默认为0。
375
366
  */
376
367
  Offset?: number;
377
368
  /**
378
- * 查询结果限制数量
369
+ * 查询结果限制数量,默认20。
379
370
  */
380
371
  Limit?: number;
381
372
  /**
382
- * 消费组名称
373
+ * 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
383
374
  */
384
375
  ConsumerGroup?: string;
385
376
  /**
386
- * 消息 ID
377
+ * 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
387
378
  */
388
379
  MsgId?: string;
389
380
  /**
390
- * 消息 Key
381
+ * 消息 Key,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
391
382
  */
392
383
  MsgKey?: string;
393
384
  /**
@@ -395,11 +386,11 @@ export interface DescribeMessageListRequest {
395
386
  */
396
387
  RecentMessageNum?: number;
397
388
  /**
398
- * 是否查询死信消息
389
+ * 是否查询死信消息,默认为false
399
390
  */
400
391
  QueryDeadLetterMessage?: boolean;
401
392
  /**
402
- * 消息 Tag
393
+ * 消息 Tag,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
403
394
  */
404
395
  Tag?: string;
405
396
  }
@@ -417,15 +408,15 @@ export interface DeleteMQTTInsPublicEndpointRequest {
417
408
  */
418
409
  export interface ModifyInstanceRequest {
419
410
  /**
420
- * 集群ID
411
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
421
412
  */
422
413
  InstanceId: string;
423
414
  /**
424
- * 实例名称
415
+ * 实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
425
416
  */
426
417
  Name?: string;
427
418
  /**
428
- * 备注信息
419
+ * 备注信息,最多 128 个字符
429
420
  */
430
421
  Remark?: string;
431
422
  /**
@@ -433,11 +424,15 @@ export interface ModifyInstanceRequest {
433
424
  */
434
425
  SendReceiveRatio?: number;
435
426
  /**
436
- * 调整实例规格的商品代号
427
+ * 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
437
428
  */
438
429
  SkuCode?: string;
439
430
  /**
440
- * 消息保留时长,小时为单位
431
+ * 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
432
+
433
+ - 默认值:DefaultRetention 参数
434
+ - 最小值:RetentionLowerLimit 参数
435
+ - 最大值:RetentionUpperLimit 参数
441
436
  */
442
437
  MessageRetention?: number;
443
438
  /**
@@ -449,11 +444,14 @@ export interface ModifyInstanceRequest {
449
444
  */
450
445
  AclEnabled?: boolean;
451
446
  /**
452
- * 最大可创建主题数
447
+ * 最大可创建主题数,取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
448
+
449
+ - 最小值和默认值:TopicNumLimit 参数
450
+ - 最大值:TopicNumUpperLimit 参数
453
451
  */
454
452
  MaxTopicNum?: number;
455
453
  /**
456
- * 免费额度之外的主题个数
454
+ * 免费额度之外的主题个数,免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
457
455
  */
458
456
  ExtraTopicNum?: string;
459
457
  /**
@@ -542,13 +540,15 @@ export interface FusionInstanceItem {
542
540
  */
543
541
  GroupNumLimit?: number;
544
542
  /**
545
- * 计费模式,
546
- POSTPAID,按量计费
547
- PREPAID,包年包月
543
+ * 计费模式,枚举值如下:
544
+
545
+ - POSTPAID:按量计费
546
+
547
+ - PREPAID:包年包月
548
548
  */
549
549
  PayMode?: string;
550
550
  /**
551
- * 到期时间,秒为单位
551
+ * 到期时间,**Unix时间戳(毫秒)**
552
552
  注意:此字段可能返回 null,表示取不到有效值。
553
553
  */
554
554
  ExpiryTime?: number;
@@ -581,22 +581,21 @@ export interface FusionInstanceItem {
581
581
  TpsLimit?: number;
582
582
  /**
583
583
  * 弹性TPS限流值
584
- 注意:此字段可能返回 null,表示取不到有效值。
585
584
  */
586
585
  ScaledTpsLimit?: number;
587
586
  /**
588
587
  * 消息保留时间,小时为单位
589
- 注意:此字段可能返回 null,表示取不到有效值。
590
588
  */
591
589
  MessageRetention?: number;
592
590
  /**
593
591
  * 延迟消息最大时长,小时为单位
594
- 注意:此字段可能返回 null,表示取不到有效值。
595
592
  */
596
593
  MaxMessageDelay?: number;
597
594
  /**
598
- * 是否自动续费
599
- 注意:此字段可能返回 null,表示取不到有效值。
595
+ * 预付费集群是否自动续费,枚举值如下:
596
+
597
+ - 0: 不自动续费
598
+ - 1: 自动续费
600
599
  */
601
600
  RenewFlag?: number;
602
601
  /**
@@ -605,12 +604,12 @@ export interface FusionInstanceItem {
605
604
  */
606
605
  InstanceItemExtraInfo?: InstanceItemExtraInfo;
607
606
  /**
608
- * 预销毁时间
607
+ * 预销毁时间,**Unix时间戳(毫秒)**
609
608
  注意:此字段可能返回 null,表示取不到有效值。
610
609
  */
611
610
  DestroyTime?: number;
612
611
  /**
613
- * 所属可用区列表
612
+ * 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
614
613
  注意:此字段可能返回 null,表示取不到有效值。
615
614
  */
616
615
  ZoneIds?: Array<number | bigint>;
@@ -863,19 +862,19 @@ export interface DescribeMQTTProductSKUListResponse {
863
862
  */
864
863
  export interface DescribeRoleListRequest {
865
864
  /**
866
- * 集群ID
865
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
867
866
  */
868
867
  InstanceId: string;
869
868
  /**
870
- * 查询起始位置
869
+ * 查询起始位置,默认为0。
871
870
  */
872
871
  Offset?: number;
873
872
  /**
874
- * 查询结果限制数量
873
+ * 查询结果限制数量,默认20。
875
874
  */
876
875
  Limit?: number;
877
876
  /**
878
- * 查询条件列表
877
+ * 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
879
878
  */
880
879
  Filters?: Array<Filter>;
881
880
  }
@@ -1217,6 +1216,23 @@ export interface DescribeInstanceListResponse {
1217
1216
  */
1218
1217
  RequestId?: string;
1219
1218
  }
1219
+ /**
1220
+ * DescribeConsumerClientList返回参数结构体
1221
+ */
1222
+ export interface DescribeConsumerClientListResponse {
1223
+ /**
1224
+ * 查询总数
1225
+ */
1226
+ TotalCount?: number;
1227
+ /**
1228
+ * 消费客户端
1229
+ */
1230
+ Data?: Array<ConsumerClient>;
1231
+ /**
1232
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1233
+ */
1234
+ RequestId?: string;
1235
+ }
1220
1236
  /**
1221
1237
  * ModifyInstance返回参数结构体
1222
1238
  */
@@ -1316,7 +1332,7 @@ export interface DescribeMQTTClientRequest {
1316
1332
  */
1317
1333
  export interface DescribeSourceClusterGroupListRequest {
1318
1334
  /**
1319
- * 任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台中获得。
1335
+ * 任务ID,可在[DescribeSmoothMigrationTaskList](https://cloud.tencent.com/document/api/1493/119997)接口返回的[SmoothMigrationTaskItem](https://cloud.tencent.com/document/api/1493/96031#SmoothMigrationTaskItem)或控制台上获得。
1320
1336
 
1321
1337
  */
1322
1338
  TaskId: string;
@@ -1385,7 +1401,7 @@ export interface DescribeMQTTInsPublicEndpointsResponse {
1385
1401
  */
1386
1402
  export interface DescribeInstanceListRequest {
1387
1403
  /**
1388
- * 查询条件列表
1404
+ * 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1389
1405
  */
1390
1406
  Filters?: Array<Filter>;
1391
1407
  /**
@@ -1393,11 +1409,11 @@ export interface DescribeInstanceListRequest {
1393
1409
  */
1394
1410
  TagFilters?: Array<TagFilter>;
1395
1411
  /**
1396
- * 查询起始位置
1412
+ * 查询起始位置,默认为0。
1397
1413
  */
1398
1414
  Offset?: number;
1399
1415
  /**
1400
- * 查询结果限制数量
1416
+ * 查询结果限制数量,默认20。
1401
1417
  */
1402
1418
  Limit?: number;
1403
1419
  }
@@ -1690,7 +1706,7 @@ export interface DeleteMQTTInsPublicEndpointResponse {
1690
1706
  */
1691
1707
  export interface DeleteInstanceRequest {
1692
1708
  /**
1693
- * 集群ID
1709
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1694
1710
  */
1695
1711
  InstanceId: string;
1696
1712
  }
@@ -1796,31 +1812,31 @@ export interface CreateTopicRequest {
1796
1812
  */
1797
1813
  export interface DescribeMessageRequest {
1798
1814
  /**
1799
- * 集群ID
1815
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1800
1816
  */
1801
1817
  InstanceId: string;
1802
1818
  /**
1803
- * 主题名称
1819
+ * 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
1804
1820
  */
1805
1821
  Topic: string;
1806
1822
  /**
1807
- * 消息ID
1823
+ * 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
1808
1824
  */
1809
1825
  MsgId: string;
1810
1826
  /**
1811
- * 查询起始位置
1827
+ * 查询起始位置,默认为0。
1812
1828
  */
1813
1829
  Offset?: number;
1814
1830
  /**
1815
- * 查询结果限制数量
1831
+ * 查询结果限制数量,默认20。
1816
1832
  */
1817
1833
  Limit?: number;
1818
1834
  /**
1819
- * 是否是死信消息
1835
+ * 是否是死信消息,默认为false
1820
1836
  */
1821
1837
  QueryDeadLetterMessage?: boolean;
1822
1838
  /**
1823
- * 是否是延时消息
1839
+ * 是否是延时消息,默认为false
1824
1840
  */
1825
1841
  QueryDelayMessage?: boolean;
1826
1842
  }
@@ -2054,7 +2070,7 @@ export interface DescribeTopicListByGroupResponse {
2054
2070
  */
2055
2071
  export interface DescribeMessageTraceResponse {
2056
2072
  /**
2057
- * 展示Topic名
2073
+ * 主题名称
2058
2074
  */
2059
2075
  ShowTopicName?: string;
2060
2076
  /**
@@ -2180,13 +2196,15 @@ export interface InstanceItem {
2180
2196
  */
2181
2197
  GroupNumLimit?: number;
2182
2198
  /**
2183
- * 计费模式,
2184
- POSTPAID,按量计费
2185
- PREPAID,包年包月
2199
+ * 计费模式,枚举值如下:
2200
+
2201
+ - POSTPAID:按量计费
2202
+
2203
+ - PREPAID:包年包月
2186
2204
  */
2187
2205
  PayMode?: string;
2188
2206
  /**
2189
- * 到期时间,秒为单位
2207
+ * 到期时间戳,**Unix时间戳(毫秒)**
2190
2208
  注意:此字段可能返回 null,表示取不到有效值。
2191
2209
  */
2192
2210
  ExpiryTime?: number;
@@ -2214,27 +2232,22 @@ export interface InstanceItem {
2214
2232
  SkuCode?: string;
2215
2233
  /**
2216
2234
  * TPS限流值
2217
- 注意:此字段可能返回 null,表示取不到有效值。
2218
2235
  */
2219
2236
  TpsLimit?: number;
2220
2237
  /**
2221
2238
  * 弹性TPS限流值
2222
- 注意:此字段可能返回 null,表示取不到有效值。
2223
2239
  */
2224
2240
  ScaledTpsLimit?: number;
2225
2241
  /**
2226
2242
  * 消息保留时间,小时为单位
2227
- 注意:此字段可能返回 null,表示取不到有效值。
2228
2243
  */
2229
2244
  MessageRetention?: number;
2230
2245
  /**
2231
2246
  * 延迟消息最大时长,小时为单位
2232
- 注意:此字段可能返回 null,表示取不到有效值。
2233
2247
  */
2234
2248
  MaxMessageDelay?: number;
2235
2249
  /**
2236
- * 是否自动续费
2237
- 注意:此字段可能返回 null,表示取不到有效值。
2250
+ * 是否自动续费,仅针对预付费集群(0: 不自动续费;1:自动续费)
2238
2251
  */
2239
2252
  RenewFlag?: number;
2240
2253
  }
@@ -2286,23 +2299,23 @@ export interface DeleteMQTTInstanceRequest {
2286
2299
  */
2287
2300
  export interface DescribeMessageTraceRequest {
2288
2301
  /**
2289
- * 集群ID
2302
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2290
2303
  */
2291
2304
  InstanceId: string;
2292
2305
  /**
2293
- * 主题名称
2306
+ * 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2294
2307
  */
2295
2308
  Topic: string;
2296
2309
  /**
2297
- * 消息ID
2310
+ * 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2298
2311
  */
2299
2312
  MsgId: string;
2300
2313
  /**
2301
- * 是否是死信消息
2314
+ * 是否是死信消息,默认为false
2302
2315
  */
2303
2316
  QueryDeadLetterMessage?: boolean;
2304
2317
  /**
2305
- * 是否是延时消息
2318
+ * 是否是延时消息,默认为false
2306
2319
  */
2307
2320
  QueryDelayMessage?: boolean;
2308
2321
  }
@@ -2524,7 +2537,8 @@ export interface RemoveMigratingTopicRequest {
2524
2537
  */
2525
2538
  TaskId: string;
2526
2539
  /**
2527
- * 消费组名称,可在[DescribeSourceClusterGroupList](https://cloud.tencent.com/document/api/1493/118006)接口返回的[SourceClusterGroupConfig](https://cloud.tencent.com/document/api/1493/96031#SourceClusterGroupConfig)或控制台中获取。
2540
+ * 主题名称,可在[DescribeMigratingTopicList](https://cloud.tencent.com/document/api/1493/118007)接口返回的[MigratingTopic](https://cloud.tencent.com/document/api/1493/96031#MigratingTopic)数据结构中获得。
2541
+
2528
2542
  */
2529
2543
  TopicName: string;
2530
2544
  /**
@@ -2563,7 +2577,7 @@ export interface DescribeMessageResponse {
2563
2577
  */
2564
2578
  MessageTracks?: Array<MessageTrackItem>;
2565
2579
  /**
2566
- * Topic
2580
+ * 主题名称
2567
2581
  */
2568
2582
  ShowTopicName?: string;
2569
2583
  /**
@@ -2634,19 +2648,19 @@ export interface ImportSourceClusterTopicsResponse {
2634
2648
  */
2635
2649
  export interface DescribeTopicListRequest {
2636
2650
  /**
2637
- * 集群ID
2651
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2638
2652
  */
2639
2653
  InstanceId: string;
2640
2654
  /**
2641
- * 查询条件列表
2655
+ * 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
2642
2656
  */
2643
2657
  Filters?: Array<Filter>;
2644
2658
  /**
2645
- * 查询起始位置
2659
+ * 查询起始位置,默认为0。
2646
2660
  */
2647
2661
  Offset?: number;
2648
2662
  /**
2649
- * 查询结果限制数量
2663
+ * 查询结果限制数量,默认20。
2650
2664
  */
2651
2665
  Limit?: number;
2652
2666
  }
@@ -2698,19 +2712,19 @@ export interface DescribeConsumerGroupRequest {
2698
2712
  */
2699
2713
  export interface DescribeConsumerGroupListRequest {
2700
2714
  /**
2701
- * 集群ID
2715
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2702
2716
  */
2703
2717
  InstanceId: string;
2704
2718
  /**
2705
- * 查询条件列表
2719
+ * 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
2706
2720
  */
2707
2721
  Filters?: Array<Filter>;
2708
2722
  /**
2709
- * 查询起始位置
2723
+ * 查询起始位置,默认为0。
2710
2724
  */
2711
2725
  Offset?: number;
2712
2726
  /**
2713
- * 查询结果限制数量
2727
+ * 查询结果限制数量,默认20。
2714
2728
  */
2715
2729
  Limit?: number;
2716
2730
  /**
@@ -2864,19 +2878,23 @@ export interface SubscriptionData {
2864
2878
  */
2865
2879
  export interface CreateInstanceRequest {
2866
2880
  /**
2867
- * 实例类型,
2868
- EXPERIMENT 体验版
2869
- BASIC 基础版
2870
- PRO 专业版
2871
- PLATINUM 铂金版
2881
+ * 实例类型,枚举值如下:
2882
+
2883
+ - EXPERIMENT:体验版
2884
+
2885
+ - BASIC:基础版
2886
+
2887
+ - PRO:专业版
2888
+
2889
+ - PLATINUM:铂金版
2872
2890
  */
2873
2891
  InstanceType: string;
2874
2892
  /**
2875
- * 集群名称
2893
+ * 集群名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
2876
2894
  */
2877
2895
  Name: string;
2878
2896
  /**
2879
- * 商品规格,可用规格如下: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
2897
+ * 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
2880
2898
  */
2881
2899
  SkuCode: string;
2882
2900
  /**
@@ -2904,11 +2922,15 @@ export interface CreateInstanceRequest {
2904
2922
  */
2905
2923
  Bandwidth?: number;
2906
2924
  /**
2907
- * 公网访问白名单
2925
+ * 公网访问白名单,不填表示拒绝所有 IP 访问
2908
2926
  */
2909
2927
  IpRules?: Array<IpRule>;
2910
2928
  /**
2911
- * 消息保留时长(单位:小时)
2929
+ * 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
2930
+
2931
+ - 默认值:DefaultRetention 参数
2932
+ - 最小值:RetentionLowerLimit 参数
2933
+ - 最大值:RetentionUpperLimit 参数
2912
2934
  */
2913
2935
  MessageRetention?: number;
2914
2936
  /**
@@ -2916,19 +2938,22 @@ export interface CreateInstanceRequest {
2916
2938
  */
2917
2939
  PayMode?: number;
2918
2940
  /**
2919
- * 是否自动续费(0: 不自动续费;1: 自动续费),默认值为0
2941
+ * 预付费集群是否自动续费(0: 不自动续费;1: 自动续费),默认值为0
2920
2942
  */
2921
2943
  RenewFlag?: number;
2922
2944
  /**
2923
- * 购买时长(单位:月),默认值为1
2945
+ * 预付费集群的购买时长(单位:月),取值范围为1~60,默认值为1
2924
2946
  */
2925
2947
  TimeSpan?: number;
2926
2948
  /**
2927
- * 最大可创建主题数
2949
+ * 最大可创建主题数,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
2950
+
2951
+ - 默认值和最小值:TopicNumLimit 参数
2952
+ - 最大值:TopicNumUpperLimit 参数
2928
2953
  */
2929
2954
  MaxTopicNum?: number;
2930
2955
  /**
2931
- * 部署可用区列表
2956
+ * 部署可用区列表,从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口获得。
2932
2957
  */
2933
2958
  ZoneIds?: Array<number | bigint>;
2934
2959
  }
@@ -2958,7 +2983,12 @@ export interface ConsumerClient {
2958
2983
  */
2959
2984
  ConsumerLag?: number;
2960
2985
  /**
2961
- * 消费者客户端类型(grpc;remoting;http)
2986
+ * 消费者客户端类型,枚举值如下:
2987
+
2988
+ - grpc:GRPC协议
2989
+ - remoting:Remoting协议
2990
+ - http:HTTP协议
2991
+ 注意:此字段可能返回 null,表示取不到有效值。
2962
2992
  */
2963
2993
  ChannelProtocol?: string;
2964
2994
  }
@@ -3191,7 +3221,13 @@ export interface MQTTClientSubscription {
3191
3221
  */
3192
3222
  export interface MessageTraceItem {
3193
3223
  /**
3194
- * 步骤
3224
+ * 消息处理阶段,枚举值如下:
3225
+
3226
+ - produce:消息生产
3227
+
3228
+ - persist:消息存储
3229
+
3230
+ - consume:消息消费
3195
3231
  注意:此字段可能返回 null,表示取不到有效值。
3196
3232
  */
3197
3233
  Stage?: string;
@@ -3287,7 +3323,7 @@ export interface DescribeInstanceResponse {
3287
3323
  */
3288
3324
  MaxMessageDelay?: number;
3289
3325
  /**
3290
- * 创建时间,秒为单位
3326
+ * 创建时间,**Unix时间戳(毫秒)**
3291
3327
  */
3292
3328
  CreatedTime?: number;
3293
3329
  /**
@@ -3317,7 +3353,17 @@ export interface DescribeInstanceResponse {
3317
3353
  */
3318
3354
  Remark?: string;
3319
3355
  /**
3320
- * 实例状态
3356
+ * 实例状态,枚举值如下:
3357
+
3358
+ - RUNNING:运行中
3359
+ - ABNORMAL:异常
3360
+ - OVERDUE:隔离中
3361
+ - DESTROYED:已销毁
3362
+ - CREATING:创建中
3363
+ - MODIFYING:变配中
3364
+ - CREATE_FAILURE:创建失败
3365
+ - MODIFY_FAILURE:变配失败
3366
+ - DELETING:删除中
3321
3367
  */
3322
3368
  InstanceStatus?: string;
3323
3369
  /**
@@ -3325,7 +3371,10 @@ export interface DescribeInstanceResponse {
3325
3371
  */
3326
3372
  SkuCode?: string;
3327
3373
  /**
3328
- * 计费模式
3374
+ * 计费模式,枚举值如下:
3375
+
3376
+ - POSTPAID:后付费按量计费
3377
+ - PREPAID:预付费包年包月
3329
3378
  */
3330
3379
  PayMode?: string;
3331
3380
  /**
@@ -3333,11 +3382,14 @@ export interface DescribeInstanceResponse {
3333
3382
  */
3334
3383
  ScaledTpsEnabled?: boolean;
3335
3384
  /**
3336
- * 是否自动续费
3385
+ * 预付费集群是否自动续费,枚举值如下:
3386
+
3387
+ - 0: 不自动续费
3388
+ - 1: 自动续费
3337
3389
  */
3338
3390
  RenewFlag?: number;
3339
3391
  /**
3340
- * 到期时间
3392
+ * 到期时间,**Unix时间戳(毫秒)**
3341
3393
  */
3342
3394
  ExpiryTime?: number;
3343
3395
  /**
@@ -3360,7 +3412,7 @@ export interface DescribeInstanceResponse {
3360
3412
  */
3361
3413
  TopicNumUpperLimit?: number;
3362
3414
  /**
3363
- * 可用区列表
3415
+ * 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
3364
3416
  */
3365
3417
  ZoneIds?: Array<number | bigint>;
3366
3418
  /**
@@ -3516,15 +3568,15 @@ export interface RollbackMigratingTopicStageResponse {
3516
3568
  */
3517
3569
  export interface DescribeFusionInstanceListRequest {
3518
3570
  /**
3519
- * 查询起始位置
3571
+ * 查询起始位置,默认为0。
3520
3572
  */
3521
3573
  Offset?: number;
3522
3574
  /**
3523
- * 查询结果限制数量
3575
+ * 查询结果限制数量,默认20。
3524
3576
  */
3525
3577
  Limit?: number;
3526
3578
  /**
3527
- * 查询条件列表
3579
+ * 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3528
3580
  */
3529
3581
  Filters?: Array<Filter>;
3530
3582
  /**
@@ -3633,7 +3685,7 @@ export interface MQTTUserItem {
3633
3685
  */
3634
3686
  export interface ModifyInstanceEndpointRequest {
3635
3687
  /**
3636
- * 集群ID
3688
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3637
3689
  */
3638
3690
  InstanceId: string;
3639
3691
  /**
@@ -3791,6 +3843,31 @@ export interface DescribeTopicListResponse {
3791
3843
  */
3792
3844
  RequestId?: string;
3793
3845
  }
3846
+ /**
3847
+ * DescribeConsumerClientList请求参数结构体
3848
+ */
3849
+ export interface DescribeConsumerClientListRequest {
3850
+ /**
3851
+ * 集群ID
3852
+ */
3853
+ InstanceId: string;
3854
+ /**
3855
+ * 消费组名称
3856
+ */
3857
+ ConsumerGroup?: string;
3858
+ /**
3859
+ * 查询条件列表
3860
+ */
3861
+ Filters?: Array<Filter>;
3862
+ /**
3863
+ * 查询起始位置
3864
+ */
3865
+ Offset?: number;
3866
+ /**
3867
+ * 查询结果限制数量
3868
+ */
3869
+ Limit?: number;
3870
+ }
3794
3871
  /**
3795
3872
  * 主题消费进度
3796
3873
  */
@@ -3880,10 +3957,13 @@ export interface DeleteConsumerGroupResponse {
3880
3957
  */
3881
3958
  export interface Endpoint {
3882
3959
  /**
3883
- * 接入点类型,枚举值如下
3884
- VPC: VPC;
3885
- PUBLIC: 公网;
3886
- INTERNAL: 支撑网;
3960
+ * 接入点类型,枚举值如下:
3961
+
3962
+ - VPC:VPC 网络
3963
+
3964
+ - PUBLIC:公网
3965
+
3966
+ - INTERNAL:支撑网
3887
3967
  */
3888
3968
  Type?: string;
3889
3969
  /**
@@ -3972,12 +4052,11 @@ export interface IpRule {
3972
4052
  */
3973
4053
  Ip: string;
3974
4054
  /**
3975
- * 是否允许放行
4055
+ * 是否允许放行,默认为false表示拒绝
3976
4056
  */
3977
4057
  Allow: boolean;
3978
4058
  /**
3979
4059
  * 备注信息
3980
- 注意:此字段可能返回 null,表示取不到有效值。
3981
4060
  */
3982
4061
  Remark: string;
3983
4062
  }
@@ -4050,11 +4129,11 @@ export interface RoleItem {
4050
4129
  */
4051
4130
  Remark?: string;
4052
4131
  /**
4053
- * 创建时间,秒为单位
4132
+ * 角色的创建时间,**Unix时间戳(毫秒)**
4054
4133
  */
4055
4134
  CreatedTime?: number;
4056
4135
  /**
4057
- * 修改时间,秒为单位
4136
+ * 角色的更新时间,**Unix时间戳(毫秒)**
4058
4137
  */
4059
4138
  ModifiedTime?: number;
4060
4139
  /**
@@ -4233,7 +4312,7 @@ export interface ModifyInstanceEndpointResponse {
4233
4312
  */
4234
4313
  export interface DescribeInstanceRequest {
4235
4314
  /**
4236
- * 集群ID
4315
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4237
4316
  */
4238
4317
  InstanceId: string;
4239
4318
  }
@@ -4298,19 +4377,19 @@ export interface DescribeMQTTMessageListRequest {
4298
4377
  */
4299
4378
  export interface ResetConsumerGroupOffsetRequest {
4300
4379
  /**
4301
- * 集群ID
4380
+ * 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4302
4381
  */
4303
4382
  InstanceId: string;
4304
4383
  /**
4305
- * 主题名称
4384
+ * 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
4306
4385
  */
4307
4386
  Topic: string;
4308
4387
  /**
4309
- * 重置位点时间(单位:毫秒)-1表示重置到最新位点
4388
+ * 重置位点的时间戳(单位:毫秒),指定为 -1 时表示重置到最新位点
4310
4389
  */
4311
4390
  ResetTimestamp: number;
4312
4391
  /**
4313
- * 消费组名称
4392
+ * 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
4314
4393
  */
4315
4394
  ConsumerGroup?: string;
4316
4395
  }