tccli-intl-en 3.0.1241.1__py2.py3-none-any.whl → 3.1.16.1__py2.py3-none-any.whl

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 (239) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/services/__init__.py +29 -1
  4. tccli/services/advisor/advisor_client.py +10 -4
  5. tccli/services/ai3d/__init__.py +4 -0
  6. tccli/services/ai3d/ai3d_client.py +266 -0
  7. tccli/services/ai3d/v20250513/api.json +264 -0
  8. tccli/services/ai3d/v20250513/examples.json +20 -0
  9. tccli/services/aiart/aiart_client.py +5 -2
  10. tccli/services/ams/ams_client.py +20 -8
  11. tccli/services/antiddos/antiddos_client.py +350 -140
  12. tccli/services/apigateway/apigateway_client.py +465 -186
  13. tccli/services/apm/apm_client.py +835 -68
  14. tccli/services/apm/v20210622/api.json +3936 -1145
  15. tccli/services/apm/v20210622/examples.json +133 -23
  16. tccli/services/asr/asr_client.py +10 -4
  17. tccli/services/autoscaling/autoscaling_client.py +290 -116
  18. tccli/services/autoscaling/v20180419/api.json +78 -28
  19. tccli/services/batch/batch_client.py +140 -56
  20. tccli/services/bi/bi_client.py +1244 -6
  21. tccli/services/bi/v20220105/api.json +5340 -107
  22. tccli/services/bi/v20220105/examples.json +196 -1
  23. tccli/services/billing/billing_client.py +210 -84
  24. tccli/services/cam/cam_client.py +405 -162
  25. tccli/services/captcha/captcha_client.py +5 -2
  26. tccli/services/car/car_client.py +165 -66
  27. tccli/services/cbs/cbs_client.py +190 -76
  28. tccli/services/ccc/ccc_client.py +794 -160
  29. tccli/services/ccc/v20200210/api.json +1748 -217
  30. tccli/services/ccc/v20200210/examples.json +64 -0
  31. tccli/services/cdb/cdb_client.py +665 -266
  32. tccli/services/cdb/v20170320/api.json +334 -134
  33. tccli/services/cdb/v20170320/examples.json +3 -3
  34. tccli/services/cdc/cdc_client.py +100 -40
  35. tccli/services/cdc/v20201214/api.json +2 -2
  36. tccli/services/cdc/v20201214/examples.json +4 -4
  37. tccli/services/cdn/cdn_client.py +220 -88
  38. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  39. tccli/services/cdwpg/cdwpg_client.py +120 -48
  40. tccli/services/cdz/__init__.py +4 -0
  41. tccli/services/cdz/cdz_client.py +210 -0
  42. tccli/services/cdz/v20221123/api.json +233 -0
  43. tccli/services/cdz/v20221123/examples.json +12 -0
  44. tccli/services/cfg/cfg_client.py +80 -32
  45. tccli/services/cfs/cfs_client.py +195 -78
  46. tccli/services/cfw/cfw_client.py +330 -132
  47. tccli/services/chdfs/chdfs_client.py +145 -58
  48. tccli/services/ciam/ciam_client.py +80 -32
  49. tccli/services/ckafka/ckafka_client.py +1033 -255
  50. tccli/services/ckafka/v20190819/api.json +3378 -1681
  51. tccli/services/ckafka/v20190819/examples.json +254 -160
  52. tccli/services/clb/clb_client.py +1054 -469
  53. tccli/services/clb/v20180317/api.json +2273 -1020
  54. tccli/services/clb/v20180317/examples.json +184 -124
  55. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  56. tccli/services/cls/cls_client.py +434 -173
  57. tccli/services/cmq/cmq_client.py +14 -803
  58. tccli/services/cmq/v20190304/api.json +173 -1367
  59. tccli/services/cmq/v20190304/examples.json +0 -120
  60. tccli/services/config/config_client.py +30 -12
  61. tccli/services/controlcenter/controlcenter_client.py +229 -2
  62. tccli/services/controlcenter/v20230110/api.json +528 -5
  63. tccli/services/controlcenter/v20230110/examples.json +32 -0
  64. tccli/services/csip/csip_client.py +170 -68
  65. tccli/services/ctsdb/ctsdb_client.py +10 -4
  66. tccli/services/cvm/cvm_client.py +706 -189
  67. tccli/services/cvm/v20170312/api.json +851 -382
  68. tccli/services/cvm/v20170312/examples.json +173 -127
  69. tccli/services/cwp/cwp_client.py +2325 -930
  70. tccli/services/cynosdb/cynosdb_client.py +1887 -577
  71. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  72. tccli/services/cynosdb/v20190107/examples.json +132 -4
  73. tccli/services/dataintegration/dataintegration_client.py +5 -2
  74. tccli/services/dayu/dayu_client.py +515 -206
  75. tccli/services/dbbrain/dbbrain_client.py +210 -84
  76. tccli/services/dc/dc_client.py +90 -36
  77. tccli/services/dcdb/dcdb_client.py +310 -124
  78. tccli/services/dlc/dlc_client.py +859 -214
  79. tccli/services/dlc/v20210125/api.json +637 -13
  80. tccli/services/dlc/v20210125/examples.json +48 -0
  81. tccli/services/dms/dms_client.py +10 -4
  82. tccli/services/dnspod/dnspod_client.py +302 -76
  83. tccli/services/dnspod/v20210323/api.json +153 -0
  84. tccli/services/dnspod/v20210323/examples.json +16 -0
  85. tccli/services/domain/domain_client.py +120 -48
  86. tccli/services/dts/dts_client.py +415 -166
  87. tccli/services/eb/eb_client.py +130 -52
  88. tccli/services/ecdn/ecdn_client.py +75 -30
  89. tccli/services/ecm/ecm_client.py +620 -248
  90. tccli/services/eiam/eiam_client.py +200 -80
  91. tccli/services/emr/emr_client.py +2815 -146
  92. tccli/services/emr/v20190103/api.json +14527 -4841
  93. tccli/services/emr/v20190103/examples.json +404 -36
  94. tccli/services/es/es_client.py +105 -42
  95. tccli/services/facefusion/facefusion_client.py +15 -6
  96. tccli/services/faceid/faceid_client.py +95 -38
  97. tccli/services/faceid/v20180301/api.json +107 -14
  98. tccli/services/faceid/v20180301/examples.json +3 -3
  99. tccli/services/gaap/gaap_client.py +440 -176
  100. tccli/services/gme/gme_client.py +50 -20
  101. tccli/services/gpm/gpm_client.py +90 -36
  102. tccli/services/gse/gse_client.py +110 -44
  103. tccli/services/gwlb/gwlb_client.py +90 -36
  104. tccli/services/hunyuan/__init__.py +4 -0
  105. tccli/services/hunyuan/hunyuan_client.py +266 -0
  106. tccli/services/hunyuan/v20230901/api.json +270 -0
  107. tccli/services/hunyuan/v20230901/examples.json +20 -0
  108. tccli/services/iai/iai_client.py +145 -58
  109. tccli/services/iap/iap_client.py +30 -12
  110. tccli/services/ims/ims_client.py +5 -2
  111. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +210 -84
  112. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  113. tccli/services/iotcloud/iotcloud_client.py +100 -40
  114. tccli/services/ip/ip_client.py +30 -12
  115. tccli/services/kms/kms_client.py +340 -136
  116. tccli/services/kms/v20190118/api.json +80 -3
  117. tccli/services/kms/v20190118/examples.json +3 -3
  118. tccli/services/lcic/lcic_client.py +265 -106
  119. tccli/services/lighthouse/lighthouse_client.py +370 -148
  120. tccli/services/lighthouse/v20200324/api.json +14 -14
  121. tccli/services/lighthouse/v20200324/examples.json +5 -5
  122. tccli/services/live/live_client.py +600 -240
  123. tccli/services/lke/lke_client.py +450 -180
  124. tccli/services/lke/v20231130/api.json +182 -39
  125. tccli/services/lkeap/__init__.py +4 -0
  126. tccli/services/lkeap/lkeap_client.py +602 -0
  127. tccli/services/lkeap/v20240522/api.json +953 -0
  128. tccli/services/lkeap/v20240522/examples.json +92 -0
  129. tccli/services/mariadb/mariadb_client.py +250 -100
  130. tccli/services/mdc/mdc_client.py +90 -36
  131. tccli/services/mdl/mdl_client.py +357 -90
  132. tccli/services/mdl/v20200326/api.json +791 -24
  133. tccli/services/mdl/v20200326/examples.json +40 -16
  134. tccli/services/mdp/mdp_client.py +734 -124
  135. tccli/services/mdp/v20200527/api.json +748 -23
  136. tccli/services/mdp/v20200527/examples.json +143 -79
  137. tccli/services/message/__init__.py +4 -0
  138. tccli/services/message/message_client.py +210 -0
  139. tccli/services/message/v20181225/api.json +72 -0
  140. tccli/services/message/v20181225/examples.json +13 -0
  141. tccli/services/mongodb/mongodb_client.py +1404 -141
  142. tccli/services/mongodb/v20190725/api.json +2919 -677
  143. tccli/services/mongodb/v20190725/examples.json +190 -22
  144. tccli/services/monitor/monitor_client.py +1008 -296
  145. tccli/services/monitor/v20180724/api.json +660 -11
  146. tccli/services/monitor/v20180724/examples.json +152 -4
  147. tccli/services/mps/mps_client.py +1489 -429
  148. tccli/services/mps/v20190612/api.json +4750 -1077
  149. tccli/services/mps/v20190612/examples.json +182 -70
  150. tccli/services/msp/msp_client.py +35 -14
  151. tccli/services/ocr/ocr_client.py +417 -82
  152. tccli/services/ocr/v20181119/api.json +1486 -103
  153. tccli/services/ocr/v20181119/examples.json +42 -4
  154. tccli/services/omics/omics_client.py +100 -40
  155. tccli/services/organization/organization_client.py +580 -232
  156. tccli/services/postgres/postgres_client.py +455 -182
  157. tccli/services/privatedns/privatedns_client.py +155 -62
  158. tccli/services/pts/pts_client.py +240 -96
  159. tccli/services/quota/__init__.py +4 -0
  160. tccli/services/quota/quota_client.py +434 -0
  161. tccli/services/quota/v20241204/api.json +548 -0
  162. tccli/services/quota/v20241204/examples.json +51 -0
  163. tccli/services/rce/rce_client.py +5 -2
  164. tccli/services/redis/redis_client.py +545 -218
  165. tccli/services/redis/v20180412/api.json +225 -113
  166. tccli/services/redis/v20180412/examples.json +19 -19
  167. tccli/services/region/region_client.py +15 -6
  168. tccli/services/rum/rum_client.py +300 -120
  169. tccli/services/scf/scf_client.py +210 -84
  170. tccli/services/ses/ses_client.py +145 -58
  171. tccli/services/smh/__init__.py +4 -0
  172. tccli/services/smh/smh_client.py +714 -0
  173. tccli/services/smh/v20210712/api.json +1287 -0
  174. tccli/services/smh/v20210712/examples.json +85 -0
  175. tccli/services/sms/sms_client.py +90 -36
  176. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  177. tccli/services/sqlserver/v20180328/api.json +9725 -3356
  178. tccli/services/sqlserver/v20180328/examples.json +470 -10
  179. tccli/services/ssl/ssl_client.py +190 -76
  180. tccli/services/ssm/ssm_client.py +120 -48
  181. tccli/services/sts/sts_client.py +25 -10
  182. tccli/services/tag/tag_client.py +150 -60
  183. tccli/services/tat/tat_client.py +95 -38
  184. tccli/services/tbaas/tbaas_client.py +20 -8
  185. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  186. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  187. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  188. tccli/services/tchd/tchd_client.py +5 -2
  189. tccli/services/tcmpp/tcmpp_client.py +520 -208
  190. tccli/services/tcr/tcr_client.py +380 -152
  191. tccli/services/tcsas/tcsas_client.py +295 -118
  192. tccli/services/tcsas/v20250106/api.json +155 -79
  193. tccli/services/tcsas/v20250106/examples.json +3 -3
  194. tccli/services/tcss/tcss_client.py +1650 -660
  195. tccli/services/tdid/tdid_client.py +240 -96
  196. tccli/services/tdmq/tdmq_client.py +2876 -466
  197. tccli/services/tdmq/v20200217/api.json +11607 -3958
  198. tccli/services/tdmq/v20200217/examples.json +562 -264
  199. tccli/services/tem/tem_client.py +280 -112
  200. tccli/services/teo/teo_client.py +1590 -540
  201. tccli/services/teo/v20220901/api.json +703 -71
  202. tccli/services/teo/v20220901/examples.json +88 -22
  203. tccli/services/tione/__init__.py +4 -0
  204. tccli/services/tione/tione_client.py +210 -0
  205. tccli/services/tione/v20211111/api.json +3074 -0
  206. tccli/services/tione/v20211111/examples.json +12 -0
  207. tccli/services/tiw/tiw_client.py +255 -102
  208. tccli/services/tke/tke_client.py +690 -276
  209. tccli/services/tms/tms_client.py +5 -2
  210. tccli/services/tmt/tmt_client.py +5 -2
  211. tccli/services/trabbit/trabbit_client.py +145 -58
  212. tccli/services/trocket/__init__.py +4 -0
  213. tccli/services/trocket/trocket_client.py +2450 -0
  214. tccli/services/trocket/v20230308/api.json +6062 -0
  215. tccli/services/trocket/v20230308/examples.json +339 -0
  216. tccli/services/trro/trro_client.py +95 -38
  217. tccli/services/trtc/trtc_client.py +255 -102
  218. tccli/services/trtc/v20190722/api.json +135 -31
  219. tccli/services/trtc/v20190722/examples.json +7 -7
  220. tccli/services/tts/tts_client.py +5 -2
  221. tccli/services/vclm/vclm_client.py +10 -4
  222. tccli/services/vm/vm_client.py +20 -8
  223. tccli/services/vod/vod_client.py +895 -358
  224. tccli/services/vpc/v20170312/api.json +1032 -134
  225. tccli/services/vpc/v20170312/examples.json +119 -23
  226. tccli/services/vpc/vpc_client.py +2159 -644
  227. tccli/services/waf/v20180125/api.json +1372 -194
  228. tccli/services/waf/v20180125/examples.json +89 -1
  229. tccli/services/waf/waf_client.py +1149 -245
  230. tccli/services/wedata/v20250806/api.json +13644 -0
  231. tccli/services/wedata/v20250806/examples.json +621 -0
  232. tccli/services/wedata/wedata_client.py +6067 -1263
  233. tccli/services/yunjing/yunjing_client.py +355 -142
  234. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/METADATA +4 -7
  235. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/RECORD +239 -201
  236. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/WHEEL +1 -1
  237. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/entry_points.txt +0 -1
  238. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/LICENSE +0 -0
  239. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,339 @@
1
+ {
2
+ "actions": {
3
+ "ChangeMigratingTopicToNextStage": [
4
+ {
5
+ "document": "",
6
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChangeMigratingTopicToNextStage\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicNameList\": [\n \"TopicTest\"\n ],\n \"NamespaceList\": []\n}",
7
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Results\": [\n {\n \"TopicName\": \"TopicTest\",\n \"Success\": true,\n \"Namespace\": \"\"\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
8
+ "title": "Modify Migration Topic Enter Next Migration Stage"
9
+ }
10
+ ],
11
+ "CreateConsumerGroup": [
12
+ {
13
+ "document": "This example shows you how to create a consumer group successfully.",
14
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"MaxRetryTimes\": 16,\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": true,\n \"Remark\": \"remark info\"\n}",
15
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumerGroup\": \"test_group\",\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"RequestId\": \"58f60891-002f-4b8a-b71f-3767a645c28e\"\n }\n}",
16
+ "title": "Create consumer groups."
17
+ }
18
+ ],
19
+ "CreateInstance": [
20
+ {
21
+ "document": "This example shows you how to successfully create a RocketMQ 5.x cluster with TPS 2000.",
22
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateInstance\n<Common request parameters>\n\n{\n \"InstanceType\": \"BASIC\",\n \"Name\": \"test_instance\",\n \"SkuCode\": \"basic_2k\",\n \"VpcList\": [\n {\n \"VpcId\": \"vpc-xxxx\",\n \"SubnetId\": \"subnet-xxxx\"\n }\n ]\n}",
23
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"InstanceId\": \"rmq-72mo3a9or\",\n \"RequestId\": \"32759095-0372-4ec0-ae3a-e5a2759fd0ff\"\n }\n}",
24
+ "title": "Normal Response"
25
+ }
26
+ ],
27
+ "CreateRole": [
28
+ {
29
+ "document": "Add a role",
30
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\",\n\"Remark\": \"Test role\"\n \"PermWrite\": true,\n \"PermRead\": true\n}",
31
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"0bb79e96-2531-4088-8d90-e1372c15518a\",\n \"Role\": \"test_role_name\"\n }\n}",
32
+ "title": "Add Role"
33
+ }
34
+ ],
35
+ "DeleteConsumerGroup": [
36
+ {
37
+ "document": "Delete consumer groups.",
38
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\"\n}",
39
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"8221cd04-dafc-438d-bc1f-816fd87df24e\"\n }\n}",
40
+ "title": "Delete consumer groups."
41
+ }
42
+ ],
43
+ "DeleteInstance": [
44
+ {
45
+ "document": "This example shows you how to delete a RocketMQ 5.x cluster.",
46
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\"\n}",
47
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"97f45511-b653-4e2a-ade6-58c8d3ae523b\"\n }\n}",
48
+ "title": "Deleting a cluster"
49
+ }
50
+ ],
51
+ "DeleteRole": [
52
+ {
53
+ "document": "This example shows you how to delete a role.",
54
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\"\n}",
55
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"c6e5472a-231d-4bd0-84cf-447f76a8216e\"\n }\n}",
56
+ "title": "Delete a Role"
57
+ }
58
+ ],
59
+ "DeleteSmoothMigrationTask": [
60
+ {
61
+ "document": "",
62
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteSmoothMigrationTask\n<Common request parameters>\n\n{\n \"TaskId\": \"taskid-123\"\n}",
63
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"requestId\"\n }\n}",
64
+ "title": "Deleting a Smooth Migration Task"
65
+ }
66
+ ],
67
+ "DeleteTopic": [
68
+ {
69
+ "document": "This example shows you how to delete a topic.",
70
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\"\n}",
71
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"4687272f-f35c-4aef-9941-ced81c164d4b\"\n }\n}",
72
+ "title": "Deleting a Topic"
73
+ }
74
+ ],
75
+ "DescribeConsumerClient": [
76
+ {
77
+ "document": "Query consumer client details.",
78
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerClient\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"ConsumerGroup\": \"group\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\"\n}",
79
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Client\": {\n \"ClientAddr\": \"11.139.244.247:58330\",\n \"ClientId\": \"11.139.244.247@75043#6734858812769343\",\n \"ConsumerLag\": 0,\n \"Language\": \"JAVA\",\n \"Version\": \"V4_9_3\",\n \"ChannelProtocol\": \"remoting\"\n },\n \"RequestId\": \"7e3acbab-5b5f-457f-b276-68c2f7e16f5e\",\n \"TopicList\": [\n {\n \"ConsumerLag\": 0,\n \"LastUpdateTime\": 1683614607184,\n \"QueueNum\": 16,\n \"SubString\": \"test_tag\",\n \"Topic\": \"topic\",\n \"TopicType\": \"NORMAL\"\n }\n ]\n }\n}",
80
+ "title": "Query consumer client details."
81
+ }
82
+ ],
83
+ "DescribeConsumerClientList": [
84
+ {
85
+ "document": "Query client connections under a consumer group.",
86
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerClientList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"group\",\n \"Offset\": 0,\n \"Limit\": 1\n}",
87
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [],\n \"RequestId\": \"c2d581fa-d7b2-453c-ba1a-65c0e507a533\",\n \"TotalCount\": 0\n }\n}",
88
+ "title": "Query client connections under a consumer group."
89
+ }
90
+ ],
91
+ "DescribeConsumerGroup": [
92
+ {
93
+ "document": "This example shows you how to query consumer details.",
94
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"group\"\n}",
95
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": false,\n \"ConsumeType\": \"PUSH\",\n \"ConsumerLag\": 1580,\n \"ConsumerNum\": 2,\n \"CreatedTime\": 1683613488000,\n \"MaxRetryTimes\": 16,\n\"Remark\": \"Test consumption group\"\n \"RequestId\": \"bc4ffab1-65cc-4ef6-9114-0de06c333b84\",\n \"Tps\": 60\n }\n}",
96
+ "title": "Query consumer group details."
97
+ }
98
+ ],
99
+ "DescribeConsumerLag": [
100
+ {
101
+ "document": "Query the accumulation of successes for the designated client",
102
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsumerLag\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-24kzek2b\",\n \"ConsumerGroup\": \"test_group\"\n}",
103
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ConsumerLag\": 260,\n \"RequestId\": \"2b9eef15-a8bc-47a3-9445-9edcafccb459\"\n }\n}",
104
+ "title": "Normal Response"
105
+ }
106
+ ],
107
+ "DescribeFusionInstanceList": [
108
+ {
109
+ "document": "",
110
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFusionInstanceList\n<Common request parameters>\n\n{\n \"Offset\": 0,\n \"Limit\": 20\n}",
111
+ "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance5x\",\n \"Version\": \"5.0\",\n \"InstanceType\": \"EXPERIMENT\",\n \"InstanceStatus\": \"RUNNING\",\n \"TopicNumLimit\": 52,\n \"GroupNumLimit\": 520,\n \"PayMode\": \"PREPAID\",\n \"ExpiryTime\": 1731830193435,\n\"Remark\": \"Test cluster of version 5.X\"\n \"TopicNum\": 3,\n \"GroupNum\": 10,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag\",\n \"TagValue\": \"test_tag_key\"\n }\n ],\n \"SkuCode\": \"experiment_500\",\n \"TpsLimit\": 500,\n \"ScaledTpsLimit\": 0,\n \"MessageRetention\": 72,\n \"MaxMessageDelay\": 168,\n \"RenewFlag\": 1,\n \"InstanceItemExtraInfo\": {\n \"IsVip\": false,\n \"VipInstanceStatus\": 0,\n \"MaxBandWidth\": 0,\n \"SpecName\": \"\",\n \"NodeCount\": 0,\n \"MaxStorage\": 0,\n \"MaxRetention\": 0,\n \"MinRetention\": 0,\n \"InstanceStatus\": 0\n },\n \"DestroyTime\": 0\n },\n {\n \"InstanceId\": \"rocketmq-5kze4gr222mx\",\n \"InstanceName\": \"test_instance4x\",\n \"Version\": \"4\",\n \"InstanceType\": \"BASIC\",\n \"InstanceStatus\": \"RUNNING\",\n \"TopicNumLimit\": 400,\n \"GroupNumLimit\": 4000,\n \"PayMode\": \"PREPAID\",\n \"ExpiryTime\": 1730710586538,\n\"Remark\": \"4.X version testing cluster\"\n \"TopicNum\": 1,\n \"GroupNum\": 1,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag\",\n \"TagValue\": \"test_tag_key\"\n }\n ],\n \"SkuCode\": \"\",\n \"TpsLimit\": 8000,\n \"ScaledTpsLimit\": 0,\n \"MessageRetention\": 72,\n \"MaxMessageDelay\": 0,\n \"RenewFlag\": 1,\n \"DestroyTime\": 0,\n \"InstanceItemExtraInfo\": {\n \"IsVip\": true,\n \"InstanceStatus\": 1,\n \"VipInstanceStatus\": 1,\n \"MaxBandWidth\": 80,\n \"NodeCount\": 2,\n \"MaxStorage\": 200,\n \"SpecName\": \"rocket-vip-basic-0\",\n \"MaxRetention\": 168,\n \"MinRetention\": 24\n }\n }\n ],\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}",
112
+ "title": "Retrieve the Full Cluster List"
113
+ }
114
+ ],
115
+ "DescribeInstance": [
116
+ {
117
+ "document": "This example shows you how to query cluster information successfully.",
118
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\"\n}",
119
+ "output": "{\n \"Response\": {\n \"ScaledTpsEnabled\": false,\n \"InstanceType\": \"EXPERIMENT\",\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance\",\n \"TopicNum\": 2,\n \"TopicNumLimit\": 50,\n \"GroupNum\": 10,\n \"GroupNumLimit\": 500,\n \"MessageRetention\": 72,\n \"RetentionUpperLimit\": 168,\n \"RetentionLowerLimit\": 1,\n \"TpsLimit\": 500,\n \"ScaledTpsLimit\": 0,\n \"MaxMessageDelay\": 168,\n \"CreatedTime\": 1731920303801,\n \"SendReceiveRatio\": 0.5,\n \"TagList\": [\n {\n \"TagKey\": \"test_tag_key\",\n \"TagValue\": \"test_tag_value\"\n }\n ],\n \"EndpointList\": [\n {\n \"Type\": \"VPC\",\n \"Status\": \"OPEN\",\n \"PayMode\": \"PREPAID\",\n \"EndpointUrl\": \"rmq-72mo3a9o.rocketmq.xx.qcloud.tencenttdmq.com:8080\",\n \"VpcId\": \"vpc-be1tvrab\",\n \"SubnetId\": \"subnet-i6fjswac\",\n \"Bandwidth\": 0,\n \"IpRules\": []\n }\n ],\n \"TopicQueueNumUpperLimit\": 32,\n \"TopicQueueNumLowerLimit\": 1,\n\"Remark\": \"Test cluster\"\n \"InstanceStatus\": \"RUNNING\",\n \"SkuCode\": \"experiment_500\",\n \"PayMode\": \"PREPAID\",\n \"RequestId\": \"32759095-0372-4ec0-ae3a-e5a2759fd0ff\"\n }\n}",
120
+ "title": "Query Cluster Information Successfully"
121
+ }
122
+ ],
123
+ "DescribeInstanceList": [
124
+ {
125
+ "document": "This example shows you how to inquiry the cluster list of RocketMQ 5.X.",
126
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceList\n<Common request parameters>\n\n{\n \"Offset\": 0,\n \"Limit\": 20\n}",
127
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"ExpiryTime\": 1683601674000,\n \"GroupNum\": 10,\n \"GroupNumLimit\": 500,\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"InstanceName\": \"test_instance5x\",\n \"InstanceStatus\": \"RUNNING\",\n \"InstanceType\": \"EXPERIMENT\",\n \"MaxMessageDelay\": 48,\n \"MessageRetention\": 72,\n \"PayMode\": \"POSTPAID\",\n\"Remark\": \"Version 5.X test cluster\"\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"experiment_500\",\n \"TagList\": [\n {\n \"TagKey\": \"test_tag_key\",\n \"TagValue\": \"test_tag_value\"\n }\n ],\n \"TopicNum\": 10,\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 500,\n \"Version\": \"5.0\"\n }\n ],\n \"RequestId\": \"561a34ff-965b-4a2d-852e-973c0b2a6f01\",\n \"TotalCount\": 1\n }\n}",
128
+ "title": "Query a Cluster List"
129
+ }
130
+ ],
131
+ "DescribeMessage": [
132
+ {
133
+ "document": "",
134
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessage\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\"\n}",
135
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Body\": \"testBody\",\n \"MessageId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"MessageTracksCount\": 1,\n \"MessageTracks\": [\n {\n \"ConsumeStatus\": \"CONSUMED\",\n \"ConsumerGroup\": \"group\",\n \"ExceptionDesc\": null,\n \"TrackType\": \"CONSUMED\"\n }\n ],\n \"ProduceTime\": \"2023-05-09 14:43:27\",\n \"ProducerAddr\": \"30.174.57.21\",\n \"Properties\": \"{\\\"TRACE_ON\\\":\\\"true\\\",\\\"MSG_REGION\\\":\\\"cd\\\",\\\"KEYS\\\":\\\"testKey\\\",\\\"UNIQ_KEY\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"CLUSTER\\\":\\\"rmqbroker-cd-1\\\",\\\"WAIT\\\":\\\"true\\\",\\\"TAGS\\\":\\\"testTag\\\"}\",\n \"RequestId\": \"8e97b978-376b-4d94-96cc-db0ead5f2f99\",\n \"ShowTopicName\": \"topic\"\n }\n}",
136
+ "title": "Querying Regular Messages"
137
+ }
138
+ ],
139
+ "DescribeMessageList": [
140
+ {
141
+ "document": " ",
142
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"StartTime\": 1683613796174,\n \"EndTime\": 1683613796174,\n \"TaskRequestId\": \"901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d\"\n}",
143
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"DeadLetterResendSuccessTimes\": null,\n \"DeadLetterResendTimes\": null,\n \"Keys\": \"test_key\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\",\n \"ProduceTime\": \"2023-05-09 14:43:27\",\n \"ProducerAddr\": \"30.174.57.21\",\n \"Tags\": \"test_tag\"\n }\n ],\n \"RequestId\": \"7426c613-085b-48c4-9257-87a208a8adcc\",\n \"TaskRequestId\": \"901a6956-1ab9-7fb7-3bf5-9f02b7aa2a7d\",\n \"TotalCount\": 1\n }\n}",
144
+ "title": "Query a Message List"
145
+ }
146
+ ],
147
+ "DescribeMessageTrace": [
148
+ {
149
+ "document": "",
150
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageTrace\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"topic\",\n \"MsgId\": \"1EAE3915000721B8D17C2C5BB31638D1\"\n}",
151
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":0,\\\"ProduceTime\\\":\\\"2023-05-09 14:43:27,127\\\",\\\"ProducerAddr\\\":\\\"30.174.57.21\\\",\\\"MsgKey\\\":\\\"testKey\\\",\\\"MsgTags\\\":\\\"testTag\\\",\\\"Duration\\\":76}\",\n \"Stage\": \"produce\"\n },\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":0,\\\"PersistTime\\\":\\\"2023-05-09 14:43:27,184\\\"}\",\n \"Stage\": \"persist\"\n },\n {\n \"Data\": \"{\\\"TotalCount\\\":1,\\\"RocketMqConsumeLogs\\\":[{\\\"MsgId\\\":\\\"1EAE3915000721B8D17C2C5BB31638D1\\\",\\\"Status\\\":2,\\\"PushTime\\\":\\\"2023-05-09 14:43:27,205\\\",\\\"ConsumerAddr\\\":\\\"11.139.244.247\\\",\\\"ConsumerGroup\\\":\\\"group\\\",\\\"RetryTimes\\\":1}]}\",\n \"Stage\": \"consume\"\n }\n ],\n \"RequestId\": \"0112153a-8cba-44f1-b7a5-5e412d493940\",\n \"ShowTopicName\": \"test_topic\"\n }\n}",
152
+ "title": "Query the Path of Regular Messages"
153
+ },
154
+ {
155
+ "document": "",
156
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMessageTrace\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-cdqzmmgz8o\",\n \"Topic\": \"\",\n \"MsgId\": \"010242ECB90067325E06F41EFF00000000\",\n \"QueryDelayMessage\": true\n}",
157
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"010242ECB90067325E06F41EFF00000000\\\",\\\"Status\\\":0,\\\"ProduceTime\\\":\\\"2024-09-12 14:06:55,591\\\",\\\"ProducerAddr\\\":\\\"9.218.232.160:32038\\\",\\\"MsgKey\\\":\\\"topic1\\\",\\\"MsgTags\\\":\\\"tag0\\\",\\\"Duration\\\":2}\",\n \"Stage\": \"produce\"\n },\n {\n \"Data\": \"{\\\"MsgId\\\":\\\"010242ECB90067325E06F41EFF00000000\\\",\\\"Status\\\":0,\\\"PersistTime\\\":\\\"2024-09-12 14:06:55,590\\\"}\",\n \"Stage\": \"persist\"\n },\n {\n \"Data\": \"{\\\"TotalCount\\\":0,\\\"RocketMqConsumeLogs\\\":[]}\",\n \"Stage\": \"consume\"\n }\n ],\n \"RequestId\": \"2e4374f9-0c98-4d77-af20-2bc414ccaefd\",\n \"ShowTopicName\": \"test_topic\"\n }\n}",
158
+ "title": "Query the Path of Delayed Messages"
159
+ }
160
+ ],
161
+ "DescribeMigratingGroupStats": [
162
+ {
163
+ "document": "",
164
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingGroupStats\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"GroupName\": \"group-a\",\n \"Namespace\": \"\"\n}",
165
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"SourceConsumeLag\": 0,\n \"TargetConsumeLag\": 0,\n \"SourceConsumerClients\": [\n {\n \"ClientId\": \"client-a\",\n \"ClientAddr\": \"1.1.1.1\",\n \"Language\": \"JAVA\",\n \"Version\": \"5\",\n \"ConsumerLag\": 0,\n \"ChannelProtocol\": \"\"\n }\n ],\n \"TargetConsumerClients\": [\n {\n \"ClientId\": \"client-b\",\n \"ClientAddr\": \"2.2.2.2\",\n \"Language\": \"JAVA\",\n \"Version\": \"5.0\",\n \"ConsumerLag\": 0\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
166
+ "title": "Viewing Real-Time Information of a Migration Consumption Group"
167
+ }
168
+ ],
169
+ "DescribeMigratingTopicList": [
170
+ {
171
+ "document": "",
172
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10,\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
173
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"MigrateTopics\": [\n {\n \"TopicName\": \"topic-a\",\n \"MigrationStatus\": \"S_RW_D_NA\",\n \"HealthCheckPassed\": true,\n \"HealthCheckError\": \"\",\n \"Namespace\": \"\",\n \"FullNamespaceV4\": null,\n \"NamespaceV4\": null,\n \"TopicNameV4\": null,\n \"HealthCheckErrorList\": []\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
174
+ "title": "Querying Migration Topic List"
175
+ }
176
+ ],
177
+ "DescribeMigratingTopicStats": [
178
+ {
179
+ "document": "",
180
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigratingTopicStats\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"TopicTest\",\n \"Namespace\": \"\"\n}",
181
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"SourceClusterConsumerCount\": 0,\n \"TargetClusterConsumerCount\": 0,\n \"SourceClusterConsumerGroups\": [],\n \"TargetClusterConsumerGroups\": [],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
182
+ "title": "Querying Real-Time Data of Migration Topics"
183
+ }
184
+ ],
185
+ "DescribeMigrationTaskList": [
186
+ {
187
+ "document": "",
188
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigrationTaskList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 20\n}",
189
+ "output": "{\n \"Response\": {\n \"RequestId\": \"bd8c6783-04a4-419f-bc51-9af603872490\",\n \"TotalCount\": 1,\n \"Tasks\": [\n {\n \"TaskId\": \"603872-7a11-c67\",\n \"Type\": 1,\n \"InstanceId\": \"rmq-47zbegoa\",\n \"TopicNum\": 4,\n \"GroupNum\": 0,\n \"Status\": 1,\n \"CreateTime\": 1693219938000\n }\n ]\n }\n}",
190
+ "title": "Retrieving the Data Migration Task List"
191
+ }
192
+ ],
193
+ "DescribeProducerList": [
194
+ {
195
+ "document": "This example shows you how to query the producer list.",
196
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProducerList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-9j77qmrm\",\n \"Topic\": \"topic-normal\",\n \"Limit\": 10,\n \"Offset\": 0\n}",
197
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"ProducerList\": [\n {\n \"ClientId\": \"169.254.165.243@a3c02f03-5b27-425f-8632-83d1e9f7010b\",\n \"ClientIp\": \"/11.176.16.134:58560\",\n \"Language\": \"JAVA\",\n \"LastUpdateTimestamp\": 1725440379597,\n \"Version\": \"V4_9_3\"\n }\n ],\n \"RequestId\": \"6918ecdb-ee41-4f8a-bf5f-7b313cd5fca0\",\n \"TotalCount\": 1\n }\n}",
198
+ "title": "Querying the Producer List"
199
+ }
200
+ ],
201
+ "DescribeProductSKUs": [
202
+ {
203
+ "document": "This example shows you how to obtain product specification information.",
204
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProductSKUs\n<Common request parameters>\n\n{}",
205
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"EXPERIMENT\",\n \"MaxMessageDelay\": 48,\n \"OnSale\": false,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"experiment_500\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 500\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_1k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 1000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_2k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 2000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_4k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 4000\n },\n {\n \"DefaultRetention\": 72,\n \"GroupNumLimit\": 500,\n \"InstanceType\": \"BASIC\",\n \"MaxMessageDelay\": 168,\n \"OnSale\": true,\n \"PriceTags\": [\n {\n \"Name\": \"tps\"\n }\n ],\n \"RetentionLowerLimit\": 24,\n \"RetentionUpperLimit\": 72,\n \"ScaledTpsLimit\": 0,\n \"SkuCode\": \"basic_6k\",\n \"TopicNumLimit\": 50,\n \"TpsLimit\": 6000\n }\n ],\n \"RequestId\": \"010e2991-4b01-40f9-a4a6-30bdfb175448\"\n }\n}",
206
+ "title": "Obtaining Product Specification Information"
207
+ }
208
+ ],
209
+ "DescribeRoleList": [
210
+ {
211
+ "document": "This example shows you how to successfully query the list of roles.",
212
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRoleList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
213
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"c5d126b6-aeeb-40ad-81c0-a94abd43f157\",\n \"TotalCount\": 1,\n \"Data\": [\n {\n \"RoleName\": \"test_role_name\",\n \"AccessKey\": \"ak0000aaaa\",\n \"SecretKey\": \"sk0000aaaa\",\n \"PermRead\": true,\n \"PermWrite\": true,\n \"Remark\": \"\",\n \"CreatedTime\": 1729153015000,\n \"ModifiedTime\": 1729153015000\n }\n ]\n }\n}",
214
+ "title": "Queries the roles"
215
+ }
216
+ ],
217
+ "DescribeSmoothMigrationTaskList": [
218
+ {
219
+ "document": "",
220
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSmoothMigrationTaskList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10\n}",
221
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"Data\": [\n {\n \"TaskId\": \"28deebbb-d489-471e-bb21-69fab50aed36\",\n \"TaskName\": \"test-task\",\n \"SourceClusterName\": \"source-cluster\",\n \"InstanceId\": \"rmq-1gabcde\",\n \"ConnectionType\": \"VPC\",\n \"SourceNameServer\": \"1.1.1.1:9876\",\n \"TaskStatus\": \"ServiceMigration\",\n \"InstanceVersion\": \"5\"\n }\n ],\n \"RequestId\": \"9b299610-7402-47d3-91d1-f012faf13929\"\n }\n}",
222
+ "title": "Retrieving the Migration Task List"
223
+ }
224
+ ],
225
+ "DescribeSourceClusterGroupList": [
226
+ {
227
+ "document": "",
228
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSourceClusterGroupList\n<Common request parameters>\n\n{\n \"Filters\": [],\n \"Offset\": 0,\n \"Limit\": 10,\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n}",
229
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"TotalCount\": 10,\n \"Groups\": [\n {\n \"GroupName\": \"Test\",\n \"Remark\": \"remark\",\n \"Imported\": true,\n \"Namespace\": \"\",\n \"ImportStatus\": \"Success\",\n \"ConsumeMessageOrderly\": false,\n \"FullNamespaceV4\": null,\n \"GroupNameV4\": null,\n \"NamespaceV4\": null\n }\n ],\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
230
+ "title": "Querying Source Cluster Consumer Group List"
231
+ }
232
+ ],
233
+ "DescribeTopic": [
234
+ {
235
+ "document": "This example shows you how to query topic details.",
236
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"Offset\": 0,\n \"Limit\": 10\n}",
237
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CreatedTime\": 1683601674000,\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"LastUpdateTime\": 1683601674000,\n\"Remark\": \"Test topic\"\n \"RequestId\": \"f7f7ba8a-4335-4adb-9186-680b91502c42\",\n \"SubscriptionCount\": 0,\n \"SubscriptionData\": [],\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\"\n }\n}",
238
+ "title": "Query Topic Details"
239
+ }
240
+ ],
241
+ "DescribeTopicList": [
242
+ {
243
+ "document": "This example shows you how to query topic list.",
244
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicList\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
245
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"QueueNum\": 16,\n\"Remark\": \"Test topic\"\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\"\n }\n ],\n \"RequestId\": \"927cbd2c-be83-410e-a83f-24dcea1d88d9\",\n \"TotalCount\": 1\n }\n}",
246
+ "title": "Query Topic List"
247
+ }
248
+ ],
249
+ "DescribeTopicListByGroup": [
250
+ {
251
+ "document": "",
252
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicListByGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"ConsumerGroup\": \"test_group\"\n}",
253
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"06a6649b-76ec-4c5d-b4c8-8a48d24be07f\",\n \"TotalCount\": 1,\n \"Data\": [\n {\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"TopicType\": \"NORMAL\",\n \"TopicQueueNum\": 3,\n \"ConsumerGroup\": \"test_group\",\n \"IsOnline\": true,\n \"ConsumeType\": \"PUSH\",\n \"SubString\": \"test_tag\",\n \"ExpressionType\": \"TAG\",\n \"Consistency\": 0,\n \"ClientSubscriptionInfos\": [],\n \"ConsumerLag\": 0,\n \"LastUpdateTime\": 1750853702996,\n \"MaxRetryTimes\": 16,\n \"ConsumeMessageOrderly\": false,\n \"MessageModel\": \"CLUSTERING\"\n }\n ]\n }\n}",
254
+ "title": "Querying Subscribed Topic List of Consumption Group"
255
+ }
256
+ ],
257
+ "DoHealthCheckOnMigratingTopic": [
258
+ {
259
+ "document": "",
260
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DoHealthCheckOnMigratingTopic\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"Test\",\n \"IgnoreCheck\": true,\n \"Namespace\": \"\"\n}",
261
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Passed\": true,\n \"Reason\": null,\n \"ReasonList\": null,\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
262
+ "title": "Migration Topic Security Check"
263
+ }
264
+ ],
265
+ "ModifyConsumerGroup": [
266
+ {
267
+ "document": "This example shows you how to modify consumer group attributes successfully.",
268
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsumerGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"ConsumeEnable\": true,\n \"ConsumeMessageOrderly\": true,\n \"MaxRetryTimes\": 16,\n \"Remark\": \"Test modification\"\n}",
269
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"239a3769-8dc6-41e9-bc01-67be452db5a3\"\n }\n}",
270
+ "title": "Modify consumer group attributes."
271
+ }
272
+ ],
273
+ "ModifyInstance": [
274
+ {
275
+ "document": "This example shows you how to modify instance configuration.",
276
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n\"Remark\": \"Test modify message retention duration\"\n \"MessageRetention\": 25\n}",
277
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"becc23c2-b5e1-4df4-9df1-22ba8e5b20c3\"\n }\n}",
278
+ "title": "Modify Instance Configuration"
279
+ }
280
+ ],
281
+ "ModifyInstanceEndpoint": [
282
+ {
283
+ "document": "This example shows you how to modify the public network configuration of an instance.",
284
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceEndpoint\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-cdrgxq94om\",\n \"Type\": \"PUBLIC\",\n \"Bandwidth\": 2,\n \"IpRules\": [\n {\n \"Ip\": \"1.2.3.4\",\n \"Allow\": true,\n \"Remark\": \"test remark\"\n }\n ]\n}",
285
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"999bc587-90d9-4ec2-97e3-3ef170e1da96\"\n }\n}",
286
+ "title": "Modifying Public Network Configuration of an Instance"
287
+ }
288
+ ],
289
+ "ModifyRole": [
290
+ {
291
+ "document": "This example shows you how to modify a role successfully.",
292
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRole\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Role\": \"test_role_name\",\n\"Remark\": \"Test modification\"\n \"PermRead\": false,\n \"PermWrite\": false\n}",
293
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"0608515b-cde2-41d6-933c-169d0d1849c5\"\n }\n}",
294
+ "title": "Modify a Role"
295
+ }
296
+ ],
297
+ "ModifyTopic": [
298
+ {
299
+ "document": "Modify topic attributes.",
300
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopic\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"Topic\": \"test_topic\",\n \"QueueNum\": 6\n}",
301
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"945afc69-1c24-4891-a2ce-c5fa6032ba75\"\n }\n}",
302
+ "title": "Modify topic attributes."
303
+ }
304
+ ],
305
+ "RemoveMigratingTopic": [
306
+ {
307
+ "document": "",
308
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RemoveMigratingTopic\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"Namespace\": \"\",\n \"TopicName\": \"topic-a\"\n}",
309
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
310
+ "title": "Removing a Topic From a Migration Task"
311
+ }
312
+ ],
313
+ "ResendDeadLetterMessage": [
314
+ {
315
+ "document": "",
316
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResendDeadLetterMessage\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"MessageIds\": [\n \"01963F0B14BAF09F27077D244F00000000\"\n ]\n}",
317
+ "output": "{\n \"Response\": {\n \"RequestId\": \"f4f1d3ba-3ed2-4e03-b741-9f6f696b9689\"\n }\n}",
318
+ "title": "Resending Dead Letter Messages"
319
+ }
320
+ ],
321
+ "ResetConsumerGroupOffset": [
322
+ {
323
+ "document": " ",
324
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetConsumerGroupOffset\n<Common request parameters>\n\n{\n \"InstanceId\": \"rmq-72mo3a9o\",\n \"ConsumerGroup\": \"test_group\",\n \"Topic\": \"test_topic\",\n \"ResetTimestamp\": -1\n}",
325
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"707a78e5-019d-41f6-80fc-15743d99c81a\"\n }\n}",
326
+ "title": "Reset the consumption position."
327
+ }
328
+ ],
329
+ "RollbackMigratingTopicStage": [
330
+ {
331
+ "document": "",
332
+ "input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollbackMigratingTopicStage\n<Common request parameters>\n\n{\n \"TaskId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\",\n \"TopicName\": \"TopicTest\",\n \"Namespace\": \"\"\n}",
333
+ "output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"02f6c31a-9707-4244-8dd3-35ad868ef92a\"\n }\n}",
334
+ "title": "Rolling Back the Streaming State of a Migration Topic"
335
+ }
336
+ ]
337
+ },
338
+ "version": "1.0"
339
+ }