tccli-intl-en 3.0.1168.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 (294) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/plugins/sso/__init__.py +14 -0
  4. tccli/plugins/sso/login.py +23 -6
  5. tccli/plugins/sso/texts.py +4 -0
  6. tccli/services/__init__.py +49 -2
  7. tccli/services/advisor/advisor_client.py +10 -4
  8. tccli/services/ai3d/__init__.py +4 -0
  9. tccli/services/ai3d/ai3d_client.py +266 -0
  10. tccli/services/ai3d/v20250513/api.json +264 -0
  11. tccli/services/ai3d/v20250513/examples.json +20 -0
  12. tccli/services/aiart/aiart_client.py +5 -2
  13. tccli/services/ams/ams_client.py +20 -8
  14. tccli/services/antiddos/antiddos_client.py +350 -140
  15. tccli/services/apigateway/apigateway_client.py +465 -186
  16. tccli/services/apm/apm_client.py +835 -68
  17. tccli/services/apm/v20210622/api.json +3936 -1145
  18. tccli/services/apm/v20210622/examples.json +133 -23
  19. tccli/services/asr/asr_client.py +10 -4
  20. tccli/services/autoscaling/autoscaling_client.py +341 -114
  21. tccli/services/autoscaling/v20180419/api.json +514 -333
  22. tccli/services/autoscaling/v20180419/examples.json +46 -38
  23. tccli/services/batch/batch_client.py +140 -56
  24. tccli/services/bi/__init__.py +4 -0
  25. tccli/services/bi/bi_client.py +1498 -0
  26. tccli/services/bi/v20220105/api.json +5769 -0
  27. tccli/services/bi/v20220105/examples.json +215 -0
  28. tccli/services/billing/billing_client.py +1055 -134
  29. tccli/services/billing/v20180709/api.json +1654 -243
  30. tccli/services/billing/v20180709/examples.json +169 -25
  31. tccli/services/cam/cam_client.py +405 -162
  32. tccli/services/captcha/captcha_client.py +5 -2
  33. tccli/services/captcha/v20190722/api.json +16 -6
  34. tccli/services/captcha/v20190722/examples.json +3 -3
  35. tccli/services/car/car_client.py +165 -66
  36. tccli/services/cbs/cbs_client.py +190 -76
  37. tccli/services/ccc/ccc_client.py +1167 -268
  38. tccli/services/ccc/v20200210/api.json +2263 -202
  39. tccli/services/ccc/v20200210/examples.json +116 -12
  40. tccli/services/cdb/cdb_client.py +665 -266
  41. tccli/services/cdb/v20170320/api.json +426 -173
  42. tccli/services/cdb/v20170320/examples.json +6 -6
  43. tccli/services/cdc/cdc_client.py +100 -40
  44. tccli/services/cdc/v20201214/api.json +2 -2
  45. tccli/services/cdc/v20201214/examples.json +4 -4
  46. tccli/services/cdn/cdn_client.py +220 -88
  47. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  48. tccli/services/cdwpg/cdwpg_client.py +120 -48
  49. tccli/services/cdz/__init__.py +4 -0
  50. tccli/services/cdz/cdz_client.py +210 -0
  51. tccli/services/cdz/v20221123/api.json +233 -0
  52. tccli/services/cdz/v20221123/examples.json +12 -0
  53. tccli/services/cfg/cfg_client.py +80 -32
  54. tccli/services/cfg/v20210820/api.json +30 -10
  55. tccli/services/cfg/v20210820/examples.json +1 -1
  56. tccli/services/cfs/cfs_client.py +195 -78
  57. tccli/services/cfw/cfw_client.py +330 -132
  58. tccli/services/chdfs/chdfs_client.py +145 -58
  59. tccli/services/ciam/ciam_client.py +80 -32
  60. tccli/services/ckafka/ckafka_client.py +1033 -255
  61. tccli/services/ckafka/v20190819/api.json +3378 -1681
  62. tccli/services/ckafka/v20190819/examples.json +254 -160
  63. tccli/services/clb/clb_client.py +1054 -469
  64. tccli/services/clb/v20180317/api.json +2307 -1024
  65. tccli/services/clb/v20180317/examples.json +186 -126
  66. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  67. tccli/services/cls/cls_client.py +434 -173
  68. tccli/services/cmq/cmq_client.py +14 -803
  69. tccli/services/cmq/v20190304/api.json +173 -1367
  70. tccli/services/cmq/v20190304/examples.json +0 -120
  71. tccli/services/config/config_client.py +30 -12
  72. tccli/services/controlcenter/controlcenter_client.py +229 -2
  73. tccli/services/controlcenter/v20230110/api.json +528 -5
  74. tccli/services/controlcenter/v20230110/examples.json +32 -0
  75. tccli/services/csip/csip_client.py +339 -78
  76. tccli/services/csip/v20221121/api.json +1011 -38
  77. tccli/services/csip/v20221121/examples.json +24 -0
  78. tccli/services/ctsdb/__init__.py +4 -0
  79. tccli/services/ctsdb/ctsdb_client.py +266 -0
  80. tccli/services/ctsdb/v20230202/api.json +677 -0
  81. tccli/services/ctsdb/v20230202/examples.json +20 -0
  82. tccli/services/cvm/cvm_client.py +706 -189
  83. tccli/services/cvm/v20170312/api.json +1141 -510
  84. tccli/services/cvm/v20170312/examples.json +174 -128
  85. tccli/services/cwp/cwp_client.py +2325 -930
  86. tccli/services/cynosdb/cynosdb_client.py +3051 -575
  87. tccli/services/cynosdb/v20190107/api.json +14074 -7139
  88. tccli/services/cynosdb/v20190107/examples.json +597 -287
  89. tccli/services/dataintegration/dataintegration_client.py +5 -2
  90. tccli/services/dayu/dayu_client.py +515 -206
  91. tccli/services/dbbrain/dbbrain_client.py +210 -84
  92. tccli/services/dc/dc_client.py +90 -36
  93. tccli/services/dcdb/dcdb_client.py +310 -124
  94. tccli/services/dlc/dlc_client.py +859 -214
  95. tccli/services/dlc/v20210125/api.json +637 -13
  96. tccli/services/dlc/v20210125/examples.json +48 -0
  97. tccli/services/dms/dms_client.py +10 -4
  98. tccli/services/dnspod/dnspod_client.py +390 -111
  99. tccli/services/dnspod/v20210323/api.json +196 -0
  100. tccli/services/dnspod/v20210323/examples.json +24 -0
  101. tccli/services/domain/domain_client.py +120 -48
  102. tccli/services/dts/dts_client.py +415 -166
  103. tccli/services/eb/eb_client.py +130 -52
  104. tccli/services/ecdn/ecdn_client.py +75 -30
  105. tccli/services/ecm/ecm_client.py +620 -248
  106. tccli/services/eiam/eiam_client.py +200 -80
  107. tccli/services/emr/emr_client.py +3104 -117
  108. tccli/services/emr/v20190103/api.json +15311 -4361
  109. tccli/services/emr/v20190103/examples.json +452 -42
  110. tccli/services/es/es_client.py +105 -42
  111. tccli/services/facefusion/facefusion_client.py +15 -6
  112. tccli/services/faceid/faceid_client.py +95 -38
  113. tccli/services/faceid/v20180301/api.json +172 -45
  114. tccli/services/faceid/v20180301/examples.json +3 -3
  115. tccli/services/gaap/gaap_client.py +440 -176
  116. tccli/services/gme/gme_client.py +50 -20
  117. tccli/services/gpm/gpm_client.py +90 -36
  118. tccli/services/gse/gse_client.py +110 -44
  119. tccli/services/gwlb/gwlb_client.py +90 -36
  120. tccli/services/hunyuan/__init__.py +4 -0
  121. tccli/services/hunyuan/hunyuan_client.py +266 -0
  122. tccli/services/hunyuan/v20230901/api.json +270 -0
  123. tccli/services/hunyuan/v20230901/examples.json +20 -0
  124. tccli/services/iai/iai_client.py +145 -58
  125. tccli/services/iai/v20200303/api.json +187 -51
  126. tccli/services/iai/v20200303/examples.json +30 -12
  127. tccli/services/iap/iap_client.py +30 -12
  128. tccli/services/ims/ims_client.py +5 -2
  129. tccli/services/ims/v20201229/api.json +133 -141
  130. tccli/services/ims/v20201229/examples.json +3 -3
  131. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +516 -72
  132. tccli/services/intlpartnersmgt/v20220928/api.json +976 -60
  133. tccli/services/intlpartnersmgt/v20220928/examples.json +50 -2
  134. tccli/services/iotcloud/iotcloud_client.py +100 -40
  135. tccli/services/iotcloud/v20210408/api.json +216 -107
  136. tccli/services/iotcloud/v20210408/examples.json +9 -9
  137. tccli/services/ip/ip_client.py +30 -12
  138. tccli/services/kms/kms_client.py +1226 -227
  139. tccli/services/kms/v20190118/api.json +1562 -144
  140. tccli/services/kms/v20190118/examples.json +204 -78
  141. tccli/services/lcic/lcic_client.py +265 -106
  142. tccli/services/lighthouse/lighthouse_client.py +370 -148
  143. tccli/services/lighthouse/v20200324/api.json +14 -14
  144. tccli/services/lighthouse/v20200324/examples.json +5 -5
  145. tccli/services/live/live_client.py +804 -232
  146. tccli/services/live/v20180801/api.json +272 -0
  147. tccli/services/live/v20180801/examples.json +32 -0
  148. tccli/services/lke/__init__.py +4 -0
  149. tccli/services/lke/lke_client.py +5194 -0
  150. tccli/services/lke/v20231130/api.json +14803 -0
  151. tccli/services/lke/v20231130/examples.json +736 -0
  152. tccli/services/lkeap/__init__.py +4 -0
  153. tccli/services/lkeap/lkeap_client.py +602 -0
  154. tccli/services/lkeap/v20240522/api.json +953 -0
  155. tccli/services/lkeap/v20240522/examples.json +92 -0
  156. tccli/services/mariadb/mariadb_client.py +250 -100
  157. tccli/services/mdc/mdc_client.py +90 -36
  158. tccli/services/mdl/mdl_client.py +402 -82
  159. tccli/services/mdl/v20200326/api.json +1144 -58
  160. tccli/services/mdl/v20200326/examples.json +48 -16
  161. tccli/services/mdp/mdp_client.py +785 -122
  162. tccli/services/mdp/v20200527/api.json +1168 -44
  163. tccli/services/mdp/v20200527/examples.json +151 -79
  164. tccli/services/message/__init__.py +4 -0
  165. tccli/services/message/message_client.py +210 -0
  166. tccli/services/message/v20181225/api.json +72 -0
  167. tccli/services/message/v20181225/examples.json +13 -0
  168. tccli/services/mongodb/mongodb_client.py +1452 -136
  169. tccli/services/mongodb/v20190725/api.json +4393 -1462
  170. tccli/services/mongodb/v20190725/examples.json +265 -71
  171. tccli/services/monitor/monitor_client.py +1008 -296
  172. tccli/services/monitor/v20180724/api.json +660 -11
  173. tccli/services/monitor/v20180724/examples.json +152 -4
  174. tccli/services/mps/mps_client.py +1573 -354
  175. tccli/services/mps/v20190612/api.json +12394 -7243
  176. tccli/services/mps/v20190612/examples.json +244 -84
  177. tccli/services/msp/msp_client.py +35 -14
  178. tccli/services/ocr/ocr_client.py +596 -102
  179. tccli/services/ocr/v20181119/api.json +2271 -181
  180. tccli/services/ocr/v20181119/examples.json +70 -8
  181. tccli/services/omics/omics_client.py +100 -40
  182. tccli/services/organization/organization_client.py +580 -232
  183. tccli/services/postgres/postgres_client.py +455 -182
  184. tccli/services/postgres/v20170312/api.json +134 -109
  185. tccli/services/postgres/v20170312/examples.json +14 -14
  186. tccli/services/privatedns/privatedns_client.py +206 -60
  187. tccli/services/privatedns/v20201028/api.json +179 -0
  188. tccli/services/privatedns/v20201028/examples.json +8 -0
  189. tccli/services/pts/pts_client.py +240 -96
  190. tccli/services/quota/__init__.py +4 -0
  191. tccli/services/quota/quota_client.py +434 -0
  192. tccli/services/quota/v20241204/api.json +548 -0
  193. tccli/services/quota/v20241204/examples.json +51 -0
  194. tccli/services/rce/rce_client.py +5 -2
  195. tccli/services/redis/redis_client.py +698 -212
  196. tccli/services/redis/v20180412/api.json +968 -563
  197. tccli/services/redis/v20180412/examples.json +98 -56
  198. tccli/services/region/__init__.py +4 -0
  199. tccli/services/region/region_client.py +322 -0
  200. tccli/services/region/v20220627/api.json +399 -0
  201. tccli/services/region/v20220627/examples.json +29 -0
  202. tccli/services/rum/rum_client.py +300 -120
  203. tccli/services/scf/scf_client.py +210 -84
  204. tccli/services/ses/ses_client.py +368 -69
  205. tccli/services/ses/v20201002/api.json +240 -0
  206. tccli/services/ses/v20201002/examples.json +32 -0
  207. tccli/services/smh/__init__.py +4 -0
  208. tccli/services/smh/smh_client.py +714 -0
  209. tccli/services/smh/v20210712/api.json +1287 -0
  210. tccli/services/smh/v20210712/examples.json +85 -0
  211. tccli/services/sms/sms_client.py +90 -36
  212. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  213. tccli/services/sqlserver/v20180328/api.json +9757 -3347
  214. tccli/services/sqlserver/v20180328/examples.json +480 -20
  215. tccli/services/ssl/ssl_client.py +504 -72
  216. tccli/services/ssl/v20191205/api.json +789 -21
  217. tccli/services/ssl/v20191205/examples.json +54 -0
  218. tccli/services/ssm/ssm_client.py +120 -48
  219. tccli/services/sts/sts_client.py +25 -10
  220. tccli/services/tag/tag_client.py +150 -60
  221. tccli/services/tat/tat_client.py +95 -38
  222. tccli/services/tbaas/__init__.py +4 -0
  223. tccli/services/tbaas/tbaas_client.py +378 -0
  224. tccli/services/tbaas/v20180416/api.json +551 -0
  225. tccli/services/tbaas/v20180416/examples.json +37 -0
  226. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  227. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  228. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  229. tccli/services/tchd/tchd_client.py +5 -2
  230. tccli/services/tcmpp/tcmpp_client.py +520 -208
  231. tccli/services/tcr/tcr_client.py +380 -152
  232. tccli/services/tcsas/tcsas_client.py +295 -118
  233. tccli/services/tcsas/v20250106/api.json +155 -79
  234. tccli/services/tcsas/v20250106/examples.json +3 -3
  235. tccli/services/tcss/tcss_client.py +1650 -660
  236. tccli/services/tdid/tdid_client.py +240 -96
  237. tccli/services/tdmq/tdmq_client.py +2876 -466
  238. tccli/services/tdmq/v20200217/api.json +11607 -3958
  239. tccli/services/tdmq/v20200217/examples.json +562 -264
  240. tccli/services/tem/tem_client.py +280 -112
  241. tccli/services/teo/teo_client.py +4507 -966
  242. tccli/services/teo/v20220901/api.json +7341 -1405
  243. tccli/services/teo/v20220901/examples.json +679 -99
  244. tccli/services/tione/__init__.py +4 -0
  245. tccli/services/tione/tione_client.py +210 -0
  246. tccli/services/tione/v20211111/api.json +3074 -0
  247. tccli/services/tione/v20211111/examples.json +12 -0
  248. tccli/services/tiw/tiw_client.py +255 -102
  249. tccli/services/tke/tke_client.py +741 -274
  250. tccli/services/tke/v20180525/api.json +132 -7
  251. tccli/services/tke/v20180525/examples.json +42 -16
  252. tccli/services/tms/tms_client.py +5 -2
  253. tccli/services/tms/v20201229/api.json +91 -100
  254. tccli/services/tmt/tmt_client.py +5 -2
  255. tccli/services/trabbit/__init__.py +4 -0
  256. tccli/services/trabbit/trabbit_client.py +1778 -0
  257. tccli/services/trabbit/v20230418/api.json +4772 -0
  258. tccli/services/trabbit/v20230418/examples.json +237 -0
  259. tccli/services/trocket/__init__.py +4 -0
  260. tccli/services/trocket/trocket_client.py +2450 -0
  261. tccli/services/trocket/v20230308/api.json +6062 -0
  262. tccli/services/trocket/v20230308/examples.json +339 -0
  263. tccli/services/trro/trro_client.py +95 -38
  264. tccli/services/trtc/trtc_client.py +928 -192
  265. tccli/services/trtc/v20190722/api.json +1810 -256
  266. tccli/services/trtc/v20190722/examples.json +100 -6
  267. tccli/services/tts/tts_client.py +5 -2
  268. tccli/services/vclm/vclm_client.py +10 -4
  269. tccli/services/vm/v20210922/api.json +61 -30
  270. tccli/services/vm/v20210922/examples.json +0 -12
  271. tccli/services/vm/vm_client.py +20 -8
  272. tccli/services/vod/v20180717/api.json +332 -52
  273. tccli/services/vod/v20180717/examples.json +9 -1
  274. tccli/services/vod/v20240718/api.json +1105 -0
  275. tccli/services/vod/v20240718/examples.json +97 -0
  276. tccli/services/vod/vod_client.py +1316 -350
  277. tccli/services/vpc/v20170312/api.json +1166 -106
  278. tccli/services/vpc/v20170312/examples.json +197 -23
  279. tccli/services/vpc/vpc_client.py +2413 -739
  280. tccli/services/waf/v20180125/api.json +1372 -194
  281. tccli/services/waf/v20180125/examples.json +89 -1
  282. tccli/services/waf/waf_client.py +1149 -245
  283. tccli/services/wedata/v20210820/api.json +1577 -231
  284. tccli/services/wedata/v20210820/examples.json +74 -12
  285. tccli/services/wedata/v20250806/api.json +13644 -0
  286. tccli/services/wedata/v20250806/examples.json +621 -0
  287. tccli/services/wedata/wedata_client.py +6366 -1191
  288. tccli/services/yunjing/yunjing_client.py +355 -142
  289. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/METADATA +4 -7
  290. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/RECORD +294 -230
  291. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/WHEEL +1 -1
  292. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/entry_points.txt +0 -1
  293. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/LICENSE +0 -0
  294. {tccli_intl_en-3.0.1168.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/top_level.txt +0 -0
tccli/services/ckafka/v20190819/examples.json CHANGED
@@ -3,141 +3,179 @@
3
3
  "BatchCreateAcl": [
4
4
  {
5
5
  "document": " ",
6
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchCreateAcl\n<Common request parameters>\n\n{\n \"InstanceId\": \"xx\",\n \"ResourceType\": 2,\n \"RuleList\": [\n {\n \"Operation\": \"xx\",\n \"PermissionType\": \"xx\",\n \"Host\": \"xx\",\n \"Principal\": \"xx\"\n }\n ],\n \"ResourceNames\": [\n \"******\"\n ]\n}",
6
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchCreateAcl\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-xx\",\n \"ResourceType\": 2,\n \"RuleList\": [\n {\n \"Operation\": \"Read\",\n \"PermissionType\": \"Allow\",\n \"Host\": \"10.1.1.0/24\",\n \"Principal\": \"User:*\"\n }\n ],\n \"ResourceNames\": [\n \"rewr\",\n \"topic-1\"\n ]\n}",
7
7
  "output": "{\n \"Response\": {\n \"Result\": 0,\n \"RequestId\": \"20e995ed-75b9-43bb-84c0-35676567e1a8\"\n }\n}",
8
- "title": "Creating ACL policies in batches"
8
+ "title": "Batch Creating ACLs"
9
9
  }
10
10
  ],
11
11
  "BatchModifyGroupOffsets": [
12
12
  {
13
- "document": "This example shows you how to batch set consumer group offsets.",
14
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchModifyGroupOffsets\n<Common request parameters>\n\n{\n \"InstanceId\": \"xx\",\n \"GroupName\": \"xx\",\n \"TopicName\": [\n \"xx\"\n ],\n \"Partitions\": [\n {\n \"Partition\": 0,\n \"Offset\": 0\n }\n ]\n}",
15
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": \"ok\"\n },\n \"RequestId\": \"ae362db8-81f6-4441-b0cc-1f6ffa31127e\"\n }\n}",
16
- "title": "Setting consumer group offsets in batches"
13
+ "document": "This example shows you how to bulk set the consumer group offset for Groups.",
14
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchModifyGroupOffsets\n<Common request parameters>\n\n{\n \"GroupName\": \"group-test\",\n \"TopicName\": [\n \"topic-abc\"\n ],\n \"InstanceId\": \"ckafka-test\",\n \"Partitions\": [\n {\n \"Partition\": 0,\n \"Offset\": 0\n }\n ]\n}",
15
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"OK\",\n \"ReturnMessage\": \"success\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"abc\"\n }\n}",
16
+ "title": "Bulk Setting the Consumer Group offset for Groups"
17
17
  }
18
18
  ],
19
19
  "BatchModifyTopicAttributes": [
20
20
  {
21
- "document": "This example shows you how to batch set topic attributes.",
22
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchModifyTopicAttributes\n<Common request parameters>\n\n{\n \"InstanceId\": \"xx\",\n \"Topic\": [\n {\n \"UncleanLeaderElectionEnable\": true,\n \"PartitionNum\": 0,\n \"MinInsyncReplicas\": 0,\n \"ReplicaNum\": 0,\n \"CleanUpPolicy\": \"xx\",\n \"Note\": \"xx\",\n \"SegmentMs\": 0,\n \"RetentionMs\": 0,\n \"MaxMessageBytes\": 0,\n \"TopicName\": \"xx\",\n \"RetentionBytes\": 0\n }\n ]\n}",
23
- "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"InstanceId\": \"ckafka-jam3ao99\",\n \"TopicName\": \"test\",\n \"ReturnCode\": \"20018\",\n \"Message\": \"get topic information fail\"\n },\n {\n \"InstanceId\": \"ckafka-jam3ao99\",\n \"TopicName\": \"test1\",\n \"ReturnCode\": \"20018\",\n \"Message\": \"get topic information fail\"\n }\n ],\n \"RequestId\": \"xxxxxxxx0001\"\n }\n}",
24
- "title": "Setting topic attributes in batches"
21
+ "document": "This example shows you how to batch set topic properties.",
22
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: BatchModifyTopicAttributes\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-o99zq5mv\",\n \"Topic\": [\n {\n \"TopicName\": \"test_leader\",\n \"RetentionMs\": 3600000,\n \"SegmentMs\": 86400000,\n \"MaxMessageBytes\": 1024,\n \"RetentionBytes\": 1099511627776,\n \"LogMsgTimestampType\": null\n }\n ]\n}",
23
+ "output": "{\n \"Response\": {\n \"RequestId\": \"cb00bc01-cda1-40b9-9c39-edad90b802d6\",\n \"Result\": [\n {\n \"InstanceId\": \"ckafka-o99zq5mv\",\n \"Message\": \"ok[apply success]\",\n \"ReturnCode\": \"0\",\n \"TopicName\": \"test_leader\"\n }\n ]\n }\n}",
24
+ "title": "Batch Set Topic Properties"
25
25
  }
26
26
  ],
27
27
  "CreateAcl": [
28
28
  {
29
29
  "document": " ",
30
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreateAcl\n&InstanceId=xxx\n&ResourceType=2\n&ResourceName=test1\n&Operation=2\n&PermissionType=2\n&Host=1.1.1.1\n&Principal=User:user1\n&<Common request parameters>",
31
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"b1ce770b-3623-47d3-b31b-538f8941142d\"\n }\n}",
32
- "title": "Adding an ACL policy"
30
+ "input": "https://ckafka.tencentcloudapi.com/?Action=CreateAcl\n&InstanceId=ckafka-test\n&ResourceType=2\n&ResourceName=yourresourcetest1\n&Operation=2\n&PermissionType=2\n&Host=1.1.1.1\n&Principal=User:user1\n&<Common request parameters>",
31
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"b1ce770b-3623-47d3-b31b-538f8941142d\"\n }\n}",
32
+ "title": "Adding an ACL Policy"
33
33
  }
34
34
  ],
35
35
  "CreateAclRule": [
36
36
  {
37
37
  "document": " ",
38
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAclRule\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-12345678\",\n \"ResourceType\": \"Topic\",\n \"RuleList\": [\n {\n \"Host\": \"1.2.3.4\",\n \"Principal\": \"User:*\",\n \"Operation\": \"WRITE\",\n \"PermissionType\": \"ALLOW\"\n }\n ],\n \"RuleName\": \"testRule\",\n \"PatternType\": \"PREFIXED\",\n \"Pattern\": \"testPattern\"\n}",
38
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAclRule\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-12345678\",\n \"ResourceType\": \"Topic\",\n \"RuleList\": [\n {\n \"Host\": \"1.2.3.4\",\n \"Principal\": \"User:*\",\n \"Operation\": \"Write\",\n \"PermissionType\": \"Allow\"\n }\n ],\n \"RuleName\": \"testRule\",\n \"PatternType\": \"PREFIXED\",\n \"Pattern\": \"testPattern\"\n}",
39
39
  "output": "{\n \"Response\": {\n \"Result\": 12,\n \"RequestId\": \"8c3daa3a-d87b-47ef-9ccd-f0905eeb8d84\"\n }\n}",
40
- "title": "Creating an ACL rule"
40
+ "title": "Adding ACL Rules Example"
41
41
  }
42
42
  ],
43
43
  "CreateConsumer": [
44
44
  {
45
45
  "document": "This example shows you how to create a consumer.",
46
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumer\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-xxx\",\n \"TopicName\": \"topic-xxx\",\n \"GroupName\": \"group-xxx\"\n}",
47
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"xx\",\n \"ReturnCode\": \"xx\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
48
- "title": "Creating a consumer"
46
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsumer\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"TopicName\": \"topic-test\",\n \"GroupName\": \"group-test\"\n}",
47
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"success\",\n \"ReturnCode\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"9e6d209b-69fd-4a00-b064-75131aa0a0f8\"\n }\n}",
48
+ "title": "Creating a Consumer"
49
49
  }
50
50
  ],
51
51
  "CreateDatahubTopic": [
52
52
  {
53
53
  "document": " ",
54
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreateDatahubTopic\n&Name=xxx\n&PartitionNum=1\n&RetentionMs=3600000\n&<Common request parameters>",
55
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TopicName\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
56
- "title": "Creating a topic"
54
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDatahubTopic\n<Common request parameters>\n\n{\n \"Name\": \"12345-test\",\n \"PartitionNum\": \"1\",\n \"RetentionMs\": \"3600000\"\n}",
55
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TopicName\": \"mytopic\",\n \"TopicId\": \"topic-test\"\n },\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
56
+ "title": "Create topics."
57
57
  }
58
58
  ],
59
- "CreateInstancePost": [
59
+ "CreateInstancePre": [
60
60
  {
61
- "document": "This example shows you how to create a Pro Edition instance, with the peak bandwidth being 20 MB/sec and disk capacity being 200 GB.",
62
- "input": "POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateInstancePost<Common request parameters>{ \"InstanceName\": \"test45\", \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\", \"KafkaVersion\": \"2.4.2\", \"SpecificationsType\": \"profession\", \"DiskType\": \"CLOUD_BASIC\", \"BandWidth\": 20, \"DiskSize\": 200, \"Partition\": 400, \"TopicNum\": 200, \"ZoneId\": 450001}",
63
- "output": "{\n \"Response\": {\n \"RequestId\": \"9432af9d-8c3e-4474-b5eb-0f5298dbb6e5\",\n \"Result\": {\n \"Data\": {\n \"FlowId\": 0\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
64
- "title": "Creating a Pro Edition instance"
61
+ "document": "This example shows you how to create a professional edition prepaid instance with a disk capacity of 200GB and a peak bandwidth of 20MB/s.",
62
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateInstancePre\n<Common request parameters>\n\n{\n \"InstanceName\": \"test55\",\n \"VpcId\": \"vpc-rmcgxxxx\",\n \"SubnetId\": \"subnet-mnzcxxxx\",\n \"ZoneId\": 450001,\n \"Period\": \"1m\",\n \"RenewFlag\": 0,\n \"InstanceType\": 1,\n \"KafkaVersion\": \"2.4.1\",\n \"SpecificationsType\": \"profession\",\n \"DiskSize\": 200,\n \"BandWidth\": 20,\n \"Partition\": 400,\n \"DiskType\": \"CLOUD_BASIC\",\n \"PublicNetworkMonthly\": 0\n}",
63
+ "output": "{\n \"Response\": {\n \"RequestId\": \"323c3bbe-db79-48c3-9b76-63aacd65b169\",\n \"Result\": {\n \"Data\": {\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"20230608002033899990000\",\n \"InstanceIdList\": [\n \"ckafka-mom5xxxx\"\n ]\n }\n ],\n \"DealNames\": [\n \"2023060800203389990000\"\n ],\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-mom5xxxx\"\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
64
+ "title": "Creating a Prepaid Instance"
65
+ },
66
+ {
67
+ "document": "This example shows you how to create a prepaid standard edition instance with an entry-level specification for one month.",
68
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateInstancePre\n<Common request parameters>\n\n{\n \"InstanceName\": \"test57\",\n \"VpcId\": \"vpc-rmcgxxxx\",\n \"SubnetId\": \"subnet-mnzcxxxx\",\n \"ZoneId\": 450001,\n \"Period\": \"1m\",\n \"RenewFlag\": 2,\n \"InstanceType\": 1,\n \"KafkaVersion\": \"2.4.1\",\n \"SpecificationsType\": \"standard\",\n \"DiskSize\": 200,\n \"BandWidth\": 20,\n \"Partition\": 400\n}",
69
+ "output": "{\n \"Response\": {\n \"RequestId\": \"2050ebf8-e255-4b90-ba0c-2fe8465e821a\",\n \"Result\": {\n \"Data\": {\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"20230608002033922780000\",\n \"InstanceIdList\": [\n \"ckafka-bz4dxxxx\"\n ]\n }\n ],\n \"DealNames\": [\n \"20230608002033922780000\"\n ],\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-bz4dxxxx\"\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
70
+ "title": "Creating a Prepaid Standard Edition Instance"
65
71
  }
66
72
  ],
67
73
  "CreatePartition": [
68
74
  {
69
75
  "document": " ",
70
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreatePartition\r\n&InstanceId=xxx\r\n&TopicName=xxx\r\n&PartitionNum=xxx\r\n&<Common request parameters>",
71
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\"\n },\n \"RequestId\": \"483c3edd-a2ac-420c-905d-47a5ec7de4ad\"\n }\n}",
72
- "title": "Adding a topic partition"
76
+ "input": "https://ckafka.tencentcloudapi.com/?Action=CreatePartition\n&InstanceId=ckafka-test\n&TopicName=mytopic\n&PartitionNum=3\n&<Common request parameters>",
77
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\",\n \"Data\": null\n },\n \"RequestId\": \"483c3edd-a2ac-420c-905d-47a5ec7de4ad\"\n }\n}",
78
+ "title": "Increasing Topic Partitions"
73
79
  }
74
80
  ],
75
81
  "CreatePostPaidInstance": [
76
82
  {
77
- "document": "This example shows you how to create a pay-as-you-go Pro Edition instance, with the peak bandwidth being 20 MB/sec and disk capacity being 200 GB.",
78
- "input": "POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreatePostPaidInstance<Common request parameters>{ \"InstanceName\": \"test55\", \"VpcId\": \"vpc-rmcgxxxx\", \"SubnetId\": \"subnet-mnzcxxxx\", \"ZoneId\": 450001, \"InstanceType\": 1, \"KafkaVersion\": \"1.1.1\", \"SpecificationsType\": \"profession\", \"DiskSize\": 200, \"BandWidth\": 20, \"Partition\": 400, \"DiskType\": \"CLOUD_BASIC\", \"PublicNetworkMonthly\": 0}",
83
+ "document": "This example shows you how to create a post-payment for professional edition instance with a disk size of 200GB and peak bandwidth of 20MB/s.",
84
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<Common request parameters>\n\n{\n \"InstanceName\": \"test55\",\n \"VpcId\": \"vpc-rmcgxxxx\",\n \"SubnetId\": \"subnet-mnzcxxxx\",\n \"ZoneId\": 450001,\n \"InstanceType\": 1,\n \"KafkaVersion\": \"2.4.2\",\n \"SpecificationsType\": \"profession\",\n \"DiskSize\": 200,\n \"BandWidth\": 20,\n \"Partition\": 400,\n \"DiskType\": \"CLOUD_BASIC\",\n \"PublicNetworkMonthly\": 0\n}",
79
85
  "output": "{\n \"Response\": {\n \"RequestId\": \"323c3bbe-db79-48c3-9b76-63aacd65b169\",\n \"Result\": {\n \"Data\": {\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"20230608002033899990000\",\n \"InstanceIdList\": [\n \"ckafka-mom5xxxx\"\n ]\n }\n ],\n \"DealNames\": [\n \"2023060800203389990000\"\n ],\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-mom5xxxx\"\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
80
- "title": "Creating a pay-as-you-go Pro Edition instance"
86
+ "title": "Creating a Postpaid Pro Edition Instance"
81
87
  },
82
88
  {
83
- "document": "This example shows you how to create three pay-as-you-go Pro Edition instances at a time.",
84
- "input": "POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreatePostPaidInstance<Common request parameters>{ \"InstanceName\": \"test58\", \"VpcId\": \"vpc-rmcg5cpf\", \"SubnetId\": \"subnet-mnzcs7gk\", \"KafkaVersion\": \"2.4.2\", \"SpecificationsType\": \"profession\", \"BandWidth\": 20, \"DiskSize\": 200, \"Partition\": 400, \"TopicNum\": 200, \"ZoneId\": 450001, \"InstanceNum\": 3, \"PublicNetworkMonthly\": 12}",
89
+ "document": "This example shows you how to create three postpaid Pro Edition instances simultaneously.",
90
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<Common request parameters>\n\n{\n \"InstanceName\": \"test58\",\n \"VpcId\": \"vpc-rmcg5cpf\",\n \"SubnetId\": \"subnet-mnzcs7gk\",\n \"KafkaVersion\": \"2.4.2\",\n \"SpecificationsType\": \"profession\",\n \"BandWidth\": 20,\n \"DiskSize\": 200,\n \"Partition\": 400,\n \"TopicNum\": 200,\n \"ZoneId\": 450001,\n \"InstanceNum\": 3,\n \"PublicNetworkMonthly\": 12\n}",
85
91
  "output": "{\n \"Response\": {\n \"RequestId\": \"cda79237-6424-482a-b2d2-97d4853b33b4\",\n \"Result\": {\n \"Data\": {\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"20230608002033915320000\",\n \"InstanceIdList\": [\n \"ckafka-bz4dxxxx\",\n \"ckafka-o9gdxxxx\",\n \"ckafka-aj5gxxxx\"\n ]\n }\n ],\n \"DealNames\": [\n \"20230608002033915320000\"\n ],\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-bz4dxxxx\"\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
86
- "title": "Creating pay-as-you-go Pro Edition instances in batches"
92
+ "title": "Creating Pay-As-You-Go Pro Edition Instances in Batches"
87
93
  },
88
94
  {
89
- "document": "This example shows you how to create a Pro Edition instance across three AZs.",
90
- "input": "POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreatePostPaidInstance<Common request parameters>{ \"InstanceName\": \"test55\", \"VpcId\": \"vpc-rmcgxxxx\", \"SubnetId\": \"subnet-mnzcxxxx\", \"ZoneId\": 450001, \"InstanceType\": 1, \"KafkaVersion\": \"1.1.1\", \"SpecificationsType\": \"profession\", \"DiskSize\": 200, \"BandWidth\": 20, \"Partition\": 400, \"DiskType\": \"CLOUD_BASIC\", \"PublicNetworkMonthly\": 0, \"MultiZoneFlag\": true, \"ZoneIds\": [ 450001, 450002, 450003 ]}",
95
+ "document": "This example shows you how to create a triple-az Pro Edition instance.",
96
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePostPaidInstance\n<Common request parameters>\n\n{\n \"InstanceName\": \"test55\",\n \"VpcId\": \"vpc-rmcgxxxx\",\n \"SubnetId\": \"subnet-mnzcxxxx\",\n \"ZoneId\": 450001,\n \"InstanceType\": 1,\n \"KafkaVersion\": \"2.4.2\",\n \"SpecificationsType\": \"profession\",\n \"DiskSize\": 200,\n \"BandWidth\": 20,\n \"Partition\": 400,\n \"DiskType\": \"CLOUD_BASIC\",\n \"PublicNetworkMonthly\": 0,\n \"MultiZoneFlag\": true,\n \"ZoneIds\": [\n 450001,\n 450002,\n 450003\n ]\n}",
91
97
  "output": "{\n \"Response\": {\n \"RequestId\": \"323c3bbe-db79-48c3-9b76-63aacd65b169\",\n \"Result\": {\n \"Data\": {\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"20230608002033899990000\",\n \"InstanceIdList\": [\n \"ckafka-mom5xxxx\"\n ]\n }\n ],\n \"DealNames\": [\n \"2023060800203389990000\"\n ],\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-mom5xxxx\"\n },\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply ok]\"\n }\n }\n}",
92
- "title": "Creating a pay-as-you-go Pro Edition instances across multiple AZs"
98
+ "title": "Creating a Postpaid Multi-AZ Pro Edition Instance"
99
+ }
100
+ ],
101
+ "CreateRoute": [
102
+ {
103
+ "document": " ",
104
+ "input": "https://ckafka.tencentcloudapi.com/?Action=CreateRoute\n&InstanceId=ckafka-test\n&VipType=1\n&<Common request parameters>",
105
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"success\",\n \"Data\": {\n \"FlowId\": 111,\n \"RouteDTO\": {\n \"RouteId\": 132321\n }\n }\n },\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\"\n }\n}",
106
+ "title": "Successfully Request"
93
107
  }
94
108
  ],
95
109
  "CreateTopic": [
96
110
  {
97
111
  "document": " ",
98
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreateTopic\n&InstanceId=xxx\n&TopicName=xxx\n&PartitionNum=1\n&ReplicaNum=2\n&<Common request parameters>",
112
+ "input": "https://ckafka.tencentcloudapi.com/?Action=CreateTopic\n&InstanceId=ckafka-test\n&TopicName=topic-name\n&PartitionNum=1\n&ReplicaNum=2\n&<Common request parameters>",
99
113
  "output": "{\n \"Response\": {\n \"Result\": {\n \"TopicId\": \"topic-k766ruye\"\n },\n \"RequestId\": \"1305a410-b030-476d-acdf-eba0dfd5323b\"\n }\n}",
100
- "title": "Creating a topic"
114
+ "title": "Create topics."
101
115
  }
102
116
  ],
103
117
  "CreateTopicIpWhiteList": [
104
118
  {
105
119
  "document": " ",
106
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreateTopicIpWhiteList\r\n&InstanceId=xxxx\r\n&TopicName=xxx\r\n&IpWhiteList.n=xxx\r\n&<Common request parameters>",
107
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\"\n },\n \"RequestId\": \"7a6f7927-a435-4e55-8687-f24a8838f744\"\n }\n}",
108
- "title": "Creating an IP allowlist for a topic"
120
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateTopicIpWhiteList\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"TopicName\": \"topic-name\",\n \"IpWhiteList\": [\n \"1.1.1.1\",\n \"10.3.3.4\"\n ]\n}",
121
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"b800c966-083a-40f5-8d54-44f40c6b364f\"\n }\n}",
122
+ "title": "Creating a Topic IP Allowlist"
109
123
  }
110
124
  ],
111
125
  "CreateUser": [
112
126
  {
113
127
  "document": " ",
114
- "input": "https://ckafka.tencentcloudapi.com/?Action=CreateUser\r\n&InstanceId=xxx\r\n&Name=xxx\r\n&Password=Password\r\n&<Common request parameters>",
115
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\"\n },\n \"RequestId\": \"8bdec3bf-585d-4129-9a87-5a7813797c1f\"\n }\n}",
116
- "title": "Adding a user"
128
+ "input": "https://ckafka.tencentcloudapi.com/?Action=CreateUser\n&InstanceId=ckafka-test\n&Name=yourname\n&Password=Password\n&<Common request parameters>",
129
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": null\n },\n \"RequestId\": \"8bdec3bf-585d-4129-9a87-5a7813797c1f\"\n }\n}",
130
+ "title": "Adding a User"
117
131
  }
118
132
  ],
119
133
  "DeleteAcl": [
120
134
  {
121
135
  "document": " ",
122
- "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteAcl\n&InstanceId=xxx\n&ResourceType=2\n&ResourceName=1\n&Operation=2\n&PermissionType=2\n&<Common request parameters>",
123
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"ok[apply ok]\",\n \"ReturnCode\": \"0\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"2140f435-b350-4429-a105-9b83efe104b0\"\n }\n}",
136
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteAcl\n&InstanceId=ckafka\n&ResourceType=2\n&ResourceName=1\n&Operation=2\n&PermissionType=2\n&<Common request parameters>",
137
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"ok[apply ok]\",\n \"ReturnCode\": \"0\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"2140f435-b350-4429-a105-9b83efe104b0\"\n }\n}",
124
138
  "title": "Deleting an ACL"
125
139
  }
126
140
  ],
141
+ "DeleteAclRule": [
142
+ {
143
+ "document": " ",
144
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAclRule\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-123456\",\n \"RuleName\": \"testRule\"\n}",
145
+ "output": "{\n \"Response\": {\n \"Result\": 12,\n \"RequestId\": \"8c3daa3a-d87b-47ef-9ddd-f0905eeb8d84\"\n }\n}",
146
+ "title": "Deleting an ACL Rule Example"
147
+ }
148
+ ],
149
+ "DeleteGroup": [
150
+ {
151
+ "document": " ",
152
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-6er88krk\",\n \"Group\": \"grouptest\"\n}",
153
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"group delete success\",\n \"Data\": null\n },\n \"RequestId\": \"7118b7f95-43de-4d27-8sdadsa-dsadsadsa\"\n }\n}",
154
+ "title": "Deleting a Consumer Group Instance"
155
+ }
156
+ ],
157
+ "DeleteInstancePost": [
158
+ {
159
+ "document": "This example shows you how to delete post-payment instances.",
160
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteInstancePost\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\"\n}",
161
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"FlowId\": 0\n },\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
162
+ "title": "Deleting Post-Payment Instances"
163
+ }
164
+ ],
127
165
  "DeleteInstancePre": [
128
166
  {
129
- "document": "This example shows you how to delete a monthly subscribed (prepaid) instance.",
167
+ "document": "This example shows you how to delete a prepaid annual and monthly instance.",
130
168
  "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteInstancePre\n&InstanceId=ckafka-xxxx\n&<Common request parameters>",
131
- "output": "{\n \"Response\": {\n \"Result\": {\n \"DeleteRouteTimestamp\": \"xx\",\n \"ReturnMessage\": \"xx\",\n \"ReturnCode\": \"xx\",\n \"Data\": {\n \"InstanceId\": \"xx\",\n \"FlowId\": 0,\n \"DealNames\": [\n \"1111111111\"\n ]\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
132
- "title": "Deleting a monthly subscribed (prepaid) instance"
169
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"DeleteRouteTimestamp\": null,\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"DealNames\": [\n \"20240624186060707999999\"\n ],\n \"InstanceId\": \"ckafka-7777xxxx\",\n \"DealNameInstanceIdMapping\": null\n }\n },\n \"RequestId\": \"0b56102f-b4a4-4225-8ae5-60aea1234567\"\n }\n}",
170
+ "title": "Deleting Prepaid Annual and Monthly Instances"
133
171
  }
134
172
  ],
135
173
  "DeleteRoute": [
136
174
  {
137
175
  "document": " ",
138
- "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteRoute\n&InstanceId=xxx\n&RouteId=1\n&CallerAppid=1\n&<Common request parameters>",
139
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"xx\",\n \"ReturnCode\": \"xx\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
140
- "title": "Deleting a route"
176
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteRoute\n&InstanceId=ckafka\n&RouteId=1\n&CallerAppid=1\n&<Common request parameters>",
177
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"success\",\n \"ReturnCode\": \"0\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"3d0d9aeb-82f9-440a-ab9b-a016212c6fb0\"\n }\n}",
178
+ "title": "Deleting Routes"
141
179
  }
142
180
  ],
143
181
  "DeleteRouteTriggerTime": [
@@ -151,113 +189,121 @@
151
189
  "DeleteTopic": [
152
190
  {
153
191
  "document": " ",
154
- "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteTopic\r\n&InstanceId=xxx\r\n&TopicName=xxx\r\n&<Common request parameters>",
155
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\"\n },\n \"RequestId\": \"bf88d4c8-06f5-4643-be86-5ffc179dc325\"\n }\n}",
156
- "title": "Deleting a topic"
192
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteTopic\n&InstanceId=ckafka\n&TopicName=topicname\n&<Common request parameters>",
193
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\",\n \"Data\": null\n },\n \"RequestId\": \"bf88d4c8-06f5-4643-be86-5ffc179dc325\"\n }\n}",
194
+ "title": "Deleting a Topic"
157
195
  }
158
196
  ],
159
197
  "DeleteTopicIpWhiteList": [
160
198
  {
161
199
  "document": " ",
162
- "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteTopicIpWhiteList\r\n&InstanceId=xxx\r\n&TopicName=xxxx\r\n&IpWhiteList.n=xxx\r\n&<Common request parameters>",
163
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\"\n },\n \"RequestId\": \"b800c966-083a-40f5-8d54-44f40c6b364f\"\n }\n}",
164
- "title": "Deleting an IP allowlist for a topic"
200
+ "input": "POST / HTTP/1.1\nHost: xxx.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteTopicIpWhiteList\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"TopicName\": \"topic-abc\",\n \"IpWhiteList\": [\n \"10.1.1.4\"\n ]\n}",
201
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[apply success]\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"b800c966-083a-40f5-8d54-44f40c6b364f\"\n }\n}",
202
+ "title": "Deleting a Topic IP Allowlist"
165
203
  }
166
204
  ],
167
205
  "DeleteUser": [
168
206
  {
169
207
  "document": " ",
170
- "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteUser\r\n&InstanceId=xxx\r\n&Name=xxx\r\n&<Common request parameters>",
171
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\"\n },\n \"RequestId\": \"c0f25f9c-4a80-48bb-ad2a-a5107041d486\"\n }\n}",
172
- "title": "Deleting a user"
208
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DeleteUser\n&InstanceId=ckafka-test\n&Name=name\n&<Common request parameters>",
209
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": null\n },\n \"RequestId\": \"c0f25f9c-4a80-48bb-ad2a-a5107041d486\"\n }\n}",
210
+ "title": "Deleting a User"
173
211
  }
174
212
  ],
175
213
  "DescribeACL": [
176
214
  {
177
215
  "document": " ",
178
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeACL\n&InstanceId=xxx\n&ResourceType=2\n&ResourceName=xxx\n&<Common request parameters>",
179
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"AclList\": [\n {\n \"ResourceType\": 2,\n \"ResourceName\": \"test\",\n \"Principal\": \"User:test\",\n \"Host\": \"*\",\n \"Operation\": 3,\n \"PermissionType\": 3\n }\n ]\n },\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
180
- "title": "Enumerating ACLs"
216
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeACL\n&InstanceId=ckafka-test\n&ResourceType=2\n&ResourceName=resourcename\n&<Common request parameters>",
217
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"AclList\": [\n {\n \"ResourceType\": 2,\n \"ResourceName\": \"ResourcetTest\",\n \"Principal\": \"User:test\",\n \"Host\": \"10.1.2.4\",\n \"Operation\": 3,\n \"PermissionType\": 3\n }\n ]\n },\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
218
+ "title": "Enumerating ACL"
181
219
  }
182
220
  ],
183
221
  "DescribeAclRule": [
184
222
  {
185
223
  "document": " ",
186
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeAclRule\n&InstanceId=xxx\n&RuleName=xxx\n&PatternType=xxx\n&IsSimplified=false\n&<Common request parameters>",
187
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"AclRuleList\": [\n {\n \"RuleName\": \"testRule\",\n \"ResourceType\": 2\n }\n ]\n },\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
188
- "title": "Enumerating ACL rules"
224
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeAclRule\n&InstanceId=ckafka-test\n&RuleName=deny-all\n&PatternType=PREFIXED\n&IsSimplified=false\n&<Common request parameters>",
225
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"AclRuleList\": [\n {\n \"RuleName\": \"deny-all\",\n \"InstanceId\": \"ckafka-abc\",\n \"PatternType\": \"PRESET\",\n \"Pattern\": \"topic123\",\n \"ResourceType\": \"Topic\",\n \"AclList\": \"[{\\\"host\\\":\\\"*\\\",\\\"operation\\\":\\\"Read\\\",\\\"permissionType\\\":\\\"Allow\\\",\\\"principal\\\":\\\"User:*\\\"}]\",\n \"CreateTimeStamp\": \"Thu Jun 06 13:07:13 CST 2024\",\n \"IsApplied\": 0,\n \"UpdateTimeStamp\": \"Thu Jun 06 13:07:13 CST 2024\",\n \"Comment\": \"\",\n \"TopicName\": \"\",\n \"TopicCount\": 0,\n \"PatternTypeTitle\": \"Preset Policy\"\n }\n ]\n },\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
226
+ "title": "Enumerating ACL"
189
227
  }
190
228
  ],
191
- "DescribeAppInfo": [
229
+ "DescribeCkafkaVersion": [
192
230
  {
193
- "document": " ",
194
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeAppInfo\r\n&Limit=10\r\n&<Common request parameters>",
195
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 11,\n \"AppIdList\": [\n 1251000011,\n 1255426940,\n 251000873,\n 251000691,\n 251006545,\n 1251762227,\n 1256134262,\n 251006131,\n 1251006288,\n 1251006373\n ]\n },\n \"RequestId\": \"8d7551b2-651e-4f47-80bc-13a478fda732\"\n }\n}",
196
- "title": "Querying the user list"
231
+ "document": "This example shows you how to query the Instance Version Information.",
232
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCkafkaVersion\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-bqwlyrg8\"\n}",
233
+ "output": "{\n \"Response\": {\n \"RequestId\": \"d173b4fb-c6d0-4507-a822-b6f277fc4016\"\n }\n}",
234
+ "title": "Querying Instance Version Information"
197
235
  }
198
236
  ],
199
237
  "DescribeCkafkaZone": [
200
238
  {
201
239
  "document": " ",
202
240
  "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCkafkaZone\n<Common request parameters>\n\n{}",
203
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ZoneList\": [\n {\n \"ZoneId\": \"300001\",\n \"IsInternalApp\": 2,\n \"AppId\": 1255613487,\n \"Flag\": true,\n \"ZoneName\": \"Hong Kong Zone 1\",\n \"ZoneStatus\": 4,\n \"Exflag\": \"1\",\n \"SoldOut\": \"false\",\n \"SalesInfo\": [\n {\n \"Platform\": \"xx\",\n \"Flag\": true,\n \"Version\": \"xx\",\n \"SoldOut\": true\n }\n ]\n },\n {\n \"ZoneId\": \"300002\",\n \"IsInternalApp\": 2,\n \"AppId\": 1255613487,\n \"Flag\": false,\n \"ZoneName\": \"Hong Kong Zone 2\",\n \"ZoneStatus\": 4,\n \"Exflag\": \"1\",\n \"SoldOut\": \"false\",\n \"SalesInfo\": [\n {\n \"Platform\": \"xx\",\n \"Flag\": true,\n \"Version\": \"xx\",\n \"SoldOut\": true\n }\n ]\n },\n {\n \"ZoneId\": \"300003\",\n \"IsInternalApp\": 2,\n \"AppId\": 1255613487,\n \"Flag\": false,\n \"ZoneName\": \"Hong Kong Zone 3\",\n \"ZoneStatus\": 4,\n \"Exflag\": \"1\",\n \"SalesInfo\": [\n {\n \"Platform\": \"xx\",\n \"Flag\": true,\n \"Version\": \"xx\",\n \"SoldOut\": true\n }\n ],\n \"SoldOut\": \"true\"\n }\n ],\n \"MaxBuyInstanceNum\": 20,\n \"MaxBandwidth\": 1200,\n \"UnitPrice\": {\n \"RealTotalCost\": 2.376,\n \"TotalCost\": 0\n },\n \"MessagePrice\": {\n \"RealTotalCost\": 0.18,\n \"TotalCost\": 0\n },\n \"ClusterInfo\": [],\n \"Standard\": \"{}\",\n \"StandardS2\": \"{\\\"InstanceTypeConfigSet\\\":[{\\\"Type\\\":\\\"sv_ckafka_instance_s2_1\\\",\\\"Desc\\\":\\\"Small\\\",\\\"Bandwidth\\\":320,\\\"DiskSize\\\":500,\\\"Pid\\\":15127,\\\"MaximumInstancePartition\\\":100,\\\"MaximumInstanceTopic\\\":40},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_2\\\",\\\"Desc\\\":\\\"Standard\\\",\\\"Bandwidth\\\":800,\\\"DiskSize\\\":1500,\\\"Pid\\\":15128,\\\"MaximumInstancePartition\\\":160,\\\"MaximumInstanceTopic\\\":80},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_3\\\",\\\"Desc\\\":\\\"Advanced\\\",\\\"Bandwidth\\\":1200,\\\"DiskSize\\\":3000,\\\"Pid\\\":15129,\\\"MaximumInstancePartition\\\":200,\\\"MaximumInstanceTopic\\\":100},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_4\\\",\\\"Desc\\\":\\\"Large\\\",\\\"Bandwidth\\\":1600,\\\"DiskSize\\\":4500,\\\"Pid\\\":15130,\\\"MaximumInstancePartition\\\":300,\\\"MaximumInstanceTopic\\\":150},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_5\\\",\\\"Desc\\\":\\\"Xlarge 1\\\",\\\"Bandwidth\\\":2400,\\\"DiskSize\\\":6000,\\\"Pid\\\":15131,\\\"MaximumInstancePartition\\\":500,\\\"MaximumInstanceTopic\\\":250},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_6\\\",\\\"Desc\\\":\\\"Xlarge 2\\\",\\\"Bandwidth\\\":3200,\\\"DiskSize\\\":8000,\\\"Pid\\\":15132,\\\"MaximumInstancePartition\\\":600,\\\"MaximumInstanceTopic\\\":300},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_7\\\",\\\"Desc\\\":\\\"Xlarge 3\\\",\\\"Bandwidth\\\":4800,\\\"DiskSize\\\":10000,\\\"Pid\\\":15133,\\\"MaximumInstancePartition\\\":800,\\\"MaximumInstanceTopic\\\":400},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_8\\\",\\\"Desc\\\":\\\"Xlarge 4\\\",\\\"Bandwidth\\\":7200,\\\"DiskSize\\\":12000,\\\"Pid\\\":15134,\\\"MaximumInstancePartition\\\":1000,\\\"MaximumInstanceTopic\\\":500}],\\\"maximumTopicPartition\\\":1000,\\\"maximumInstanceConsumerGroup\\\":0}\\n\",\n \"Profession\": \"{\\\"BasicEdition\\\":{\\\"Bandwidth\\\":{\\\"Maximum\\\":1200,\\\"Minimal\\\":40,\\\"Step\\\":20},\\\"DiskCapacity\\\":{\\\"40\\\":{\\\"Maximum\\\":5000,\\\"Minimal\\\":500,\\\"Step\\\":100},\\\"120\\\":{\\\"Maximum\\\":10000,\\\"Minimal\\\":1000,\\\"Step\\\":100},\\\"320\\\":{\\\"Maximum\\\":30000,\\\"Minimal\\\":3000,\\\"Step\\\":100},\\\"620\\\":{\\\"Maximum\\\":54000,\\\"Minimal\\\":5400,\\\"Step\\\":100},\\\"920\\\":{\\\"Maximum\\\":75000,\\\"Minimal\\\":7500,\\\"Step\\\":100}},\\\"DiskTypes\\\":[\\\"SSD\\\",\\\"CLOUD_BASIC\\\"],\\\"MessageRetention\\\":{\\\"Maximum\\\":2160,\\\"Minimal\\\":24,\\\"Step\\\":1},\\\"Partition\\\":{\\\"40\\\":{\\\"Maximum\\\":1000,\\\"Minimal\\\":500,\\\"Step\\\":100},\\\"60\\\":{\\\"Maximum\\\":1200,\\\"Minimal\\\":600,\\\"Step\\\":100},\\\"120\\\":{\\\"Maximum\\\":1600,\\\"Minimal\\\":800,\\\"Step\\\":100},\\\"180\\\":{\\\"Maximum\\\":2000,\\\"Minimal\\\":1000,\\\"Step\\\":100},\\\"240\\\":{\\\"Maximum\\\":2400,\\\"Minimal\\\":1200,\\\"Step\\\":100},\\\"320\\\":{\\\"Maximum\\\":2800,\\\"Minimal\\\":1400,\\\"Step\\\":100},\\\"400\\\":{\\\"Maximum\\\":3200,\\\"Minimal\\\":1600,\\\"Step\\\":100},\\\"500\\\":{\\\"Maximum\\\":3600,\\\"Minimal\\\":1800,\\\"Step\\\":100},\\\"600\\\":{\\\"Maximum\\\":4000,\\\"Minimal\\\":2000,\\\"Step\\\":100},\\\"800\\\":{\\\"Maximum\\\":4500,\\\"Minimal\\\":2400,\\\"Step\\\":100},\\\"1000\\\":{\\\"Maximum\\\":5000,\\\"Minimal\\\":2800,\\\"Step\\\":100},\\\"1200\\\":{\\\"Maximum\\\":5500,\\\"Minimal\\\":3200,\\\"Step\\\":100}},\\\"Topic\\\":{\\\"40\\\":{\\\"Maximum\\\":100,\\\"Minimal\\\":50,\\\"Step\\\":1},\\\"60\\\":{\\\"Maximum\\\":120,\\\"Minimal\\\":60,\\\"Step\\\":1},\\\"120\\\":{\\\"Maximum\\\":160,\\\"Minimal\\\":80,\\\"Step\\\":1},\\\"180\\\":{\\\"Maximum\\\":200,\\\"Minimal\\\":100,\\\"Step\\\":1},\\\"240\\\":{\\\"Maximum\\\":240,\\\"Minimal\\\":120,\\\"Step\\\":1},\\\"320\\\":{\\\"Maximum\\\":280,\\\"Minimal\\\":160,\\\"Step\\\":1},\\\"400\\\":{\\\"Maximum\\\":320,\\\"Minimal\\\":200,\\\"Step\\\":1},\\\"500\\\":{\\\"Maximum\\\":360,\\\"Minimal\\\":240,\\\"Step\\\":1},\\\"600\\\":{\\\"Maximum\\\":400,\\\"Minimal\\\":280,\\\"Step\\\":1},\\\"800\\\":{\\\"Maximum\\\":450,\\\"Minimal\\\":320,\\\"Step\\\":1},\\\"1000\\\":{\\\"Maximum\\\":500,\\\"Minimal\\\":360,\\\"Step\\\":1},\\\"1200\\\":{\\\"Maximum\\\":550,\\\"Minimal\\\":400,\\\"Step\\\":1}}},\\\"HighPerformanceEdition\\\":{\\\"Bandwidth\\\":{\\\"Maximum\\\":3200,\\\"Minimal\\\":1600,\\\"Step\\\":400},\\\"DiskCapacity\\\":{\\\"1600\\\":{\\\"Maximum\\\":120000,\\\"Minimal\\\":12000,\\\"Step\\\":100},\\\"2000\\\":{\\\"Maximum\\\":160000,\\\"Minimal\\\":16000,\\\"Step\\\":100},\\\"2400\\\":{\\\"Maximum\\\":200000,\\\"Minimal\\\":20000,\\\"Step\\\":100},\\\"2800\\\":{\\\"Maximum\\\":240000,\\\"Minimal\\\":24000,\\\"Step\\\":100},\\\"3200\\\":{\\\"Maximum\\\":280000,\\\"Minimal\\\":28000,\\\"Step\\\":100}},\\\"DiskTypes\\\":[\\\"SSD\\\",\\\"CLOUD_BASIC\\\"],\\\"MessageRetention\\\":{\\\"Maximum\\\":2160,\\\"Minimal\\\":24,\\\"Step\\\":1},\\\"Partition\\\":{\\\"1600\\\":{\\\"Maximum\\\":6000,\\\"Minimal\\\":4000,\\\"Step\\\":100},\\\"2000\\\":{\\\"Maximum\\\":7000,\\\"Minimal\\\":4500,\\\"Step\\\":100},\\\"2400\\\":{\\\"Maximum\\\":8000,\\\"Minimal\\\":5000,\\\"Step\\\":100},\\\"2800\\\":{\\\"Maximum\\\":9000,\\\"Minimal\\\":5500,\\\"Step\\\":100},\\\"3200\\\":{\\\"Maximum\\\":10000,\\\"Minimal\\\":6000,\\\"Step\\\":100}},\\\"Topic\\\":{\\\"1600\\\":{\\\"Maximum\\\":600,\\\"Minimal\\\":500,\\\"Step\\\":1},\\\"2000\\\":{\\\"Maximum\\\":700,\\\"Minimal\\\":600,\\\"Step\\\":1},\\\"2400\\\":{\\\"Maximum\\\":800,\\\"Minimal\\\":700,\\\"Step\\\":1},\\\"2800\\\":{\\\"Maximum\\\":900,\\\"Minimal\\\":800,\\\"Step\\\":1},\\\"3200\\\":{\\\"Maximum\\\":1000,\\\"Minimal\\\":900,\\\"Step\\\":1}}}}\",\n \"Physical\": \"{}\",\n \"PublicNetwork\": \"{}\",\n \"PublicNetworkLimit\": \"{}\"\n },\n \"RequestId\": \"4831a936-0a03-408e-9ffc-a813a11ad769\"\n }\n}",
204
- "title": "Viewing the AZ list"
241
+ "output": "{\n \"Response\": {\n \"RequestId\": \"65192154-338c-4cd4-b3c0-1457dfdd2e4c\",\n \"Result\": {\n \"ClusterInfo\": [],\n \"MaxBandwidth\": 1200,\n \"MaxBuyInstanceNum\": 20,\n \"MessagePrice\": {\n \"RealTotalCost\": 0,\n \"TotalCost\": 0\n },\n \"Physical\": \"\",\n \"Profession\": \"{\\\"BasicEdition\\\":{\\\"Bandwidth\\\":{\\\"Maximum\\\":1200,\\\"Minimal\\\":20,\\\"Step\\\":20},\\\"DiskCapacity\\\":{\\\"20\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":200,\\\"Step\\\":100},\\\"40\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":500,\\\"Step\\\":100},\\\"120\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":1000,\\\"Step\\\":100},\\\"320\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":3000,\\\"Step\\\":100},\\\"800\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":5400,\\\"Step\\\":100},\\\"1000\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":7500,\\\"Step\\\":100}},\\\"DiskTypes\\\":[\\\"SSD\\\",\\\"CLOUD_BASIC\\\"],\\\"MessageRetention\\\":{\\\"Maximum\\\":2160,\\\"Minimal\\\":24,\\\"Step\\\":1},\\\"Partition\\\":{\\\"20\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":400,\\\"Step\\\":100},\\\"40\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":800,\\\"Step\\\":100},\\\"60\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":900,\\\"Step\\\":100},\\\"120\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":1200,\\\"Step\\\":100},\\\"180\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":1400,\\\"Step\\\":100},\\\"240\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":1600,\\\"Step\\\":100},\\\"320\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":1800,\\\"Step\\\":100},\\\"400\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":2000,\\\"Step\\\":100},\\\"500\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":2200,\\\"Step\\\":100},\\\"600\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":2400,\\\"Step\\\":100},\\\"800\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":2600,\\\"Step\\\":100},\\\"1000\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":2800,\\\"Step\\\":100},\\\"1200\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":3200,\\\"Step\\\":100}}},\\\"HighPerformanceEdition\\\":{\\\"Bandwidth\\\":{\\\"Maximum\\\":100000,\\\"Minimal\\\":1600,\\\"Step\\\":200},\\\"DiskCapacity\\\":{\\\"1600\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":10000,\\\"Step\\\":100},\\\"2000\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":10000,\\\"Step\\\":100},\\\"2400\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":10000,\\\"Step\\\":100},\\\"2800\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":10000,\\\"Step\\\":100},\\\"3200\\\":{\\\"Maximum\\\":500000,\\\"Minimal\\\":10000,\\\"Step\\\":100}},\\\"DiskTypes\\\":[\\\"SSD\\\",\\\"CLOUD_BASIC\\\"],\\\"MessageRetention\\\":{\\\"Maximum\\\":2160,\\\"Minimal\\\":24,\\\"Step\\\":1},\\\"Partition\\\":{\\\"1600\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":4000,\\\"Step\\\":100},\\\"2000\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":4500,\\\"Step\\\":100},\\\"2400\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":5000,\\\"Step\\\":100},\\\"2800\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":5500,\\\"Step\\\":100},\\\"3200\\\":{\\\"Maximum\\\":40000,\\\"Minimal\\\":6000,\\\"Step\\\":100}}}}\\n\",\n \"PublicNetwork\": \"[{\\\"Maximum\\\":198,\\\"Minimal\\\":3,\\\"step\\\":3}]\",\n \"PublicNetworkLimit\": \"{\\\"Maximum\\\":999,\\\"Minimal\\\":198,\\\"step\\\":3,\\\"minimalZoneIds\\\":[100001,100002,200001,300001,400001],\\\"unsupportedRegionId\\\":[32,78]}\",\n \"Standard\": \"\",\n\"StandardS2\": \"{\\\"InstanceTypeConfigSet\\\":[{\\\"Type\\\":\\\"sv_ckafka_instance_s2_1\\\",\\\"Desc\\\":\\\"entry-level\\\",\\\"DescEn\\\":\\\"Small\\\",\\\"Bandwidth\\\":320,\\\"MinDiskSize\\\":300,\\\"MaxDiskSize\\\":1000,\\\"DiskSize\\\":500,\\\"Pid\\\":1004034,\\\"MaximumInstancePartition\\\":60,\\\"MaximumInstanceTopic\\\":25},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_2\\\",\\\"Desc\\\":\\\"standard type\\\",\\\"DescEn\\\":\\\"Standard\\\",\\\"Bandwidth\\\":800,\\\"DiskSize\\\":1500,\\\"MinDiskSize\\\":500,\\\"MaxDiskSize\\\":2500,\\\"Pid\\\":1004037,\\\"MaximumInstancePartition\\\":100,\\\"MaximumInstanceTopic\\\":40},{\\\"Type\\\":\\\"sv_ckafka_instance_s2_3\\\",\\\"Desc\\\":\\\"advanced\\\",\\\"DescEn\\\":\\\"Advanced\\\",\\\"Bandwidth\\\":1200,\\\"DiskSize\\\":3000,\\\"MinDiskSize\\\":1000,\\\"MaxDiskSize\\\":4000,\\\"Pid\\\":1004038,\\\"MaximumInstancePartition\\\":150,\\\"MaximumInstanceTopic\\\":50}],\\\"maximumTopicPartition\\\":2500,\\\"maximumInstanceConsumerGroup\\\":0}\"\n \"UnitPrice\": {\n \"RealTotalCost\": 0,\n \"TotalCost\": 0\n },\n \"ZoneList\": [\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"1\",\n \"Flag\": true,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": true,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": true,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"true\",\n \"ZoneId\": \"800001\",\n\"ZoneName\": \"Beijing Zone 1\",\n \"ZoneStatus\": 4\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"true\",\n \"ZoneId\": \"800002\",\n\"ZoneName\": \"Beijing Zone 2\",\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"false\",\n \"ZoneId\": \"800003\",\n\"ZoneName\": \"Beijing Zone 3\"\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"true\",\n \"ZoneId\": \"800004\",\n\"ZoneName\": \"Beijing Zone 4\"\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": true,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"true\",\n \"ZoneId\": \"800005\",\n\"ZoneName\": \"Beijing Zone 5\"\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"false\",\n \"ZoneId\": \"800006\",\n\"ZoneName\": \"Beijing Zone 6\"\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"false\",\n \"ZoneId\": \"800007\",\n\"ZoneName\": \"Beijing Zone 7\",\n \"ZoneStatus\": 3\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"1\",\n \"Flag\": true,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": true,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": true,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"false\",\n \"ZoneId\": \"2000800004\",\n\"ZoneName\": \"Tencent Maps CDZ Beijing Zone 1\"\n \"ZoneStatus\": 4\n },\n {\n \"AppId\": 1300957330,\n \"ExtraFlag\": \"0\",\n \"Flag\": false,\n \"IsInternalApp\": 1,\n \"SalesInfo\": [\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"0.10.2.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"standard\",\n \"SoldOut\": true,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"0.10.2\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"1.1.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"profession\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.4.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"2.8.1\"\n },\n {\n \"Flag\": false,\n \"Platform\": \"premium\",\n \"SoldOut\": false,\n \"Version\": \"3.2.3\"\n }\n ],\n \"SoldOut\": \"false\",\n \"ZoneId\": \"800008\",\n\"ZoneName\": \"Beijing Zone 8\"\n \"ZoneStatus\": 3\n }\n ]\n }\n }\n}",
242
+ "title": "View Available Zone List"
205
243
  }
206
244
  ],
207
245
  "DescribeConsumerGroup": [
208
246
  {
209
247
  "document": " ",
210
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeConsumerGroup\r\n&InstanceId=10\r\n&<Common request parameters>",
211
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 2,\n \"TopicList\": [\n {\n \"TopicId\": \"topic-g8ud11it\",\n \"TopicName\": \"connect-offset\"\n }\n ],\n \"GroupList\": [\n {\n \"ConsumerGroupName\": \"connect-cluster-1\",\n \"SubscribedInfo\": []\n },\n {\n \"ConsumerGroupName\": \"qcloud_tocos\",\n \"SubscribedInfo\": [\n {\n \"TopicName\": \"connect-offset\",\n \"PartitionOffset\": [\n {\n \"Partition\": \"0\",\n \"Offset\": 966186803\n },\n {\n \"Partition\": \"1\",\n \"Offset\": 968552882\n },\n {\n \"Partition\": \"2\",\n \"Offset\": 957792934\n }\n ]\n }\n ]\n }\n ],\n \"TotalPartition\": 0,\n \"PartitionListForMonitor\": [],\n \"TotalTopic\": 1,\n \"TopicListForMonitor\": [\n {\n \"TopicId\": \"topic-g8ud11it\",\n \"TopicName\": \"connect-offset\"\n }\n ],\n \"GroupListForMonitor\": [\n {\n \"GroupName\": \"connect-cluster-1\"\n },\n {\n \"GroupName\": \"qcloud_tocos\"\n }\n ]\n },\n \"RequestId\": \"3c8a91a3-5921-4d7f-9fd9-6b4261cca363\"\n }\n}",
212
- "title": "Listing consumer groups"
248
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeConsumerGroup\n&InstanceId=ckafka-test\n&<Common request parameters>",
249
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e59b15f1-8c26-4f28-8d7a-31fdbb5d2e90\",\n \"Result\": {\n \"GroupList\": [\n {\n \"ConsumerGroupName\": \"hh\",\n \"SubscribedInfo\": [\n {\n \"Partition\": [\n 0,\n 1,\n 2\n ],\n \"PartitionOffset\": [\n {\n \"Offset\": 3395,\n \"Partition\": \"0\"\n },\n {\n \"Offset\": 3269,\n \"Partition\": \"1\"\n },\n {\n \"Offset\": 3336,\n \"Partition\": \"2\"\n }\n ],\n \"TopicId\": \"topic-brany0f0\",\n \"TopicName\": \"dev\"\n },\n {\n \"Partition\": [\n 0,\n 1,\n 2\n ],\n \"PartitionOffset\": [\n {\n \"Offset\": 2110,\n \"Partition\": \"0\"\n },\n {\n \"Offset\": 2239,\n \"Partition\": \"1\"\n },\n {\n \"Offset\": 2197,\n \"Partition\": \"2\"\n }\n ],\n \"TopicId\": \"topic-4f78nggi\",\n \"TopicName\": \"te\"\n }\n ]\n },\n {\n \"ConsumerGroupName\": \"tes\",\n \"SubscribedInfo\": [\n {\n \"Partition\": [\n 0,\n 1,\n 2\n ],\n \"PartitionOffset\": [\n {\n \"Offset\": 3395,\n \"Partition\": \"0\"\n },\n {\n \"Offset\": 3269,\n \"Partition\": \"1\"\n },\n {\n \"Offset\": 3336,\n \"Partition\": \"2\"\n }\n ],\n \"TopicId\": \"topic-brany0f0\",\n \"TopicName\": \"dev\"\n },\n {\n \"Partition\": [\n 0,\n 1,\n 2\n ],\n \"PartitionOffset\": [\n {\n \"Offset\": 1409,\n \"Partition\": \"0\"\n },\n {\n \"Offset\": 1474,\n \"Partition\": \"1\"\n },\n {\n \"Offset\": 1453,\n \"Partition\": \"2\"\n }\n ],\n \"TopicId\": \"topic-4f78nggi\",\n \"TopicName\": \"te\"\n }\n ]\n },\n {\n \"ConsumerGroupName\": \"vv\",\n \"SubscribedInfo\": [\n {\n \"Partition\": [\n 0,\n 1,\n 2\n ],\n \"PartitionOffset\": [\n {\n \"Offset\": 3395,\n \"Partition\": \"0\"\n },\n {\n \"Offset\": 3269,\n \"Partition\": \"1\"\n },\n {\n \"Offset\": 3336,\n \"Partition\": \"2\"\n }\n ],\n \"TopicId\": \"topic-brany0f0\",\n \"TopicName\": \"dev\"\n }\n ]\n }\n ],\n \"GroupListForMonitor\": [\n {\n \"GroupName\": \"hh\"\n },\n {\n \"GroupName\": \"tes\"\n },\n {\n \"GroupName\": \"vv\"\n }\n ],\n \"PartitionListForMonitor\": [],\n \"TopicList\": [\n {\n \"TopicId\": \"topic-brany0f0\",\n \"TopicName\": \"dev\"\n },\n {\n \"TopicId\": \"topic-4f78nggi\",\n \"TopicName\": \"te\"\n }\n ],\n \"TopicListForMonitor\": [\n {\n \"TopicId\": \"topic-brany0f0\",\n \"TopicName\": \"dev\"\n },\n {\n \"TopicId\": \"topic-4f78nggi\",\n \"TopicName\": \"te\"\n }\n ],\n \"TotalCount\": 3,\n \"TotalPartition\": 0,\n \"TotalTopic\": 2\n }\n }\n}",
250
+ "title": "Listing Consumption Groups"
251
+ }
252
+ ],
253
+ "DescribeCvmInfo": [
254
+ {
255
+ "document": " ",
256
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeCvmInfo\n&InstanceId=ckafka-6er88krk\n&<Common request parameters>",
257
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"CvmList\": [\n {\n \"CkafkaInstanceId\": \"ckafka-6er88krk\",\n \"InstanceId\": \"ins-axxxas\",\n \"Ip\": \"10.0.0.23\"\n }\n ]\n },\n \"RequestId\": \"31740399-5d06-404b-a4b5-3652e21c8a1d\"\n }\n}",
258
+ "title": "Getting Instance CVM Information Example"
213
259
  }
214
260
  ],
215
261
  "DescribeDatahubTopic": [
216
262
  {
217
263
  "document": " ",
218
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeDatahubTopic\n&Name=xxx\n&<Common request parameters>",
219
- "output": "{\n \"Response\": {\n \"Result\": {\n \"UserName\": \"xx\",\n \"TopicId\": \"xx\",\n \"Name\": \"xx\",\n \"PartitionNum\": 1,\n \"Status\": 1,\n \"Note\": \"xx\",\n \"RetentionMs\": 1,\n \"Password\": \"xx\",\n \"TopicName\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
220
- "title": "Getting the topic attributes"
264
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatahubTopic\n<Common request parameters>\n\n{\n \"Name\": \"1300957330-tanxing-qiang-2nd\"\n}",
265
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e4edf3bd-b2b1-4add-9a87-d41f35091395\",\n \"Result\": {\n \"Address\": \"dip.tencentcloudmq.com:6000\",\n \"Name\": \"1300957330-tanxing-qiang-2nd\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"Password\": \"923274dd1f22496590f7ff598d773895\",\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-g1ntq6se\",\n \"TopicName\": \"1300957330-tanxing-qiang-2nd\",\n \"UserName\": \"ougeml7y4ky0\"\n }\n }\n}",
266
+ "title": "Retrieving Topic Attributes"
221
267
  }
222
268
  ],
223
269
  "DescribeDatahubTopics": [
224
270
  {
225
271
  "document": " ",
226
272
  "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatahubTopics\n<Common request parameters>\n\n{}",
227
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"TopicList\": [\n {}\n ]\n },\n \"RequestId\": \"fd9afa97-cc0f-4ea7-9da8-63914a0877e1\"\n }\n}",
228
- "title": "Querying the DataHub topic list"
273
+ "output": "{\n \"Response\": {\n \"RequestId\": \"136d14bc-109d-4b1a-8b2c-de58cd04536d\",\n \"Result\": {\n \"TopicList\": [\n {\n \"Name\": \"1300957330-devin-topic-test\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-elo4dm34\",\n \"TopicName\": \"1300957330-devin-topic-test\"\n },\n {\n \"Name\": \"1300957330-rxtest\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-2kcw8efy\",\n \"TopicName\": \"1300957330-rxtest\"\n },\n {\n \"Name\": \"1300957330-tanxing-qiang-2nd\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-g1ntq6se\",\n \"TopicName\": \"1300957330-tanxing-qiang-2nd\"\n },\n {\n \"Name\": \"1300957330-test\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-4621aeam\",\n \"TopicName\": \"1300957330-test\"\n },\n {\n \"Name\": \"1300957330-test-1\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-houq8qfw\",\n \"TopicName\": \"1300957330-test-1\"\n },\n {\n \"Name\": \"1300957330-test-topic2\",\n \"Note\": \"\",\n \"PartitionNum\": 2,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-ar3abkmu\",\n \"TopicName\": \"1300957330-test-topic2\"\n },\n {\n \"Name\": \"1300957330-testttt\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-gdbt9w28\",\n \"TopicName\": \"1300957330-testttt\"\n },\n {\n \"Name\": \"1300957330-topic1\",\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"RetentionMs\": 86400000,\n \"Status\": 1,\n \"TopicId\": \"topic-ehzi5lue\",\n \"TopicName\": \"1300957330-topic1\"\n }\n ],\n \"TotalCount\": 8\n }\n }\n}",
274
+ "title": "Querying Datahub Topic List"
229
275
  }
230
276
  ],
231
277
  "DescribeGroup": [
232
278
  {
233
279
  "document": " ",
234
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroup\r\n&InstanceId=xxxx\r\n&<Common request parameters>",
235
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"GroupList\": [\n {\n \"Group\": \"qcloud_tocos\",\n \"Protocol\": \"consumer\"\n }\n ]\n },\n \"RequestId\": \"c931f394-7d72-4ad4-8d70-5a225708c762\"\n }\n}",
236
- "title": "Enumerating consumer groups"
280
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroup\n&InstanceId=ckafka-pkwxedpq\n&<Common request parameters>",
281
+ "output": "{\n \"Response\": {\n \"RequestId\": \"5936dc43-9496-44fa-977b-25f3048352be\",\n \"Result\": {\n \"GroupCountQuota\": 200,\n \"GroupList\": [\n {\n \"Group\": \"test-group\",\n \"Protocol\": \"consumer\"\n }\n ],\n \"TotalCount\": 1\n }\n }\n}",
282
+ "title": "Enumerating Consumption Groups"
237
283
  }
238
284
  ],
239
285
  "DescribeGroupInfo": [
240
286
  {
241
287
  "document": " ",
242
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupInfo\r\n&InstanceId=xxxx\r\n&GroupList.0=xx\r\n&<Common request parameters>",
243
- "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"ErrorCode\": \"0\",\n \"State\": \"Stable\",\n \"ProtocolType\": \"consumer\",\n \"Protocol\": \"range\",\n \"Members\": [\n {\n \"MemberId\": \"consumer-1-/10.53.88.65-2018-08-10 10:17:19:639-88206ef1-9248-43a0-9ff4-e22c3ab21e92\",\n \"ClientId\": \"consumer-1\",\n \"ClientHost\": \"/10.53.88.65\",\n \"Assignment\": {\n \"Version\": 0,\n \"Topics\": [\n {\n \"Topic\": \"test\",\n \"Partitions\": [\n 0\n ]\n }\n ]\n }\n }\n ],\n \"Group\": \"perf-consumer-97910\"\n }\n ],\n \"RequestId\": \"8e9b234e-0c3e-4340-9733-adbd05879b10\"\n }\n}",
244
- "title": "Getting consumer group information"
288
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupInfo\n&InstanceId=ckafka-ivn43n20\n&GroupList.0=groupName\n&<Common request parameters>",
289
+ "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"ErrorCode\": \"0\",\n \"State\": \"Stable\",\n \"ProtocolType\": \"consumer\",\n \"Protocol\": \"range\",\n \"Members\": [\n {\n \"MemberId\": \"consumer-1-/10.53.88.65-2018-08-10 10:17:19:639-88206ef1-9248-43a0-9ff4-e22c3ab21e92\",\n \"ClientId\": \"consumer-1\",\n \"ClientHost\": \"/10.53.88.65\",\n \"Assignment\": {\n \"Version\": 0,\n \"Topics\": [\n {\n \"Topic\": \"topic-test\",\n \"Partitions\": [\n 0\n ]\n }\n ]\n }\n }\n ],\n \"Group\": \"perf-consumer-97910\"\n }\n ],\n \"RequestId\": \"8e9b234e-0c3e-4340-9733-adbd05879b10\"\n }\n}",
290
+ "title": "Obtaining Consumer Group Information"
245
291
  }
246
292
  ],
247
293
  "DescribeGroupOffsets": [
248
294
  {
249
295
  "document": " ",
250
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupOffsets\r\n&InstanceId=10\r\n&Group=\"group\"\r\n&<Common request parameters>",
251
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"TopicList\": [\n {\n \"Topic\": \"test\",\n \"Partitions\": [\n {\n \"Partition\": 0,\n \"Offset\": 22689638,\n \"Metadata\": \"\",\n \"ErrorCode\": 0,\n \"LogEndOffset\": 207927929,\n \"Lag\": 185238291\n }\n ]\n }\n ]\n },\n \"RequestId\": \"fd9afa97-cc0f-4ea7-9da8-63914a0877e1\"\n }\n}",
252
- "title": "Getting consumer group offsets"
296
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeGroupOffsets\n&InstanceId=ckafka-test\n&Group=\"group\"\n&<Common request parameters>",
297
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"TopicList\": [\n {\n \"Topic\": \"topic-test\",\n \"Partitions\": [\n {\n \"Partition\": 0,\n \"Offset\": 22689638,\n \"Metadata\": \"\",\n \"ErrorCode\": 0,\n \"LogEndOffset\": 207927929,\n \"Lag\": 185238291\n }\n ]\n }\n ]\n },\n \"RequestId\": \"fd9afa97-cc0f-4ea7-9da8-63914a0877e1\"\n }\n}",
298
+ "title": "Retrieving Consumer Group offset"
253
299
  }
254
300
  ],
255
301
  "DescribeInstanceAttributes": [
256
302
  {
257
303
  "document": " ",
258
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeInstanceAttributes\n&InstanceId=xxx\n&<Common request parameters>",
259
- "output": "{\n \"Response\": {\n \"Result\": {\n \"MsgRetentionTime\": 1440,\n \"DeleteRouteTimestamp\": \"xx\",\n \"Version\": \"xx\",\n \"Config\": {\n \"DefaultNumPartitions\": 0,\n \"AutoCreateTopicsEnable\": true,\n \"DefaultReplicationFactor\": 2\n },\n \"RemainingPartitions\": 0,\n \"Status\": 1,\n \"CreatedTopics\": 0,\n \"VpcId\": \"xx\",\n \"Tags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"InstanceId\": \"xx\",\n \"Vip\": \"xx\",\n \"SubnetId\": \"xx\",\n \"InstanceType\": \"xx\",\n \"RemainderTopics\": 17,\n \"MaxConnection\": 1,\n \"PublicNetwork\": 48000,\n \"Healthy\": 1,\n \"ZoneId\": 100003,\n \"Cvm\": 0,\n \"DiskSize\": 120000,\n \"HealthyMessage\": \"xx\",\n \"RemainderPartitions\": 45,\n \"InstanceName\": \"xx\",\n \"CreatedPartitions\": 0,\n \"Features\": [\n \"xx\"\n ],\n \"ZoneIds\": [\n 0\n ],\n \"ExpireTime\": 1,\n \"Bandwidth\": 48000,\n \"MaxGroupNum\": 0,\n \"RetentionTimeConfig\": {\n \"StepForwardPercentage\": 10,\n \"DiskQuotaPercentage\": 90,\n \"Enable\": 0,\n \"BottomRetention\": 360\n },\n \"DynamicDiskConfig\": {\n \"Enable\": 1,\n \"DiskQuotaPercentage\": 30,\n \"StepForwardPercentage\": 15,\n \"MaxDiskSpace\": 1000\n },\n \"Vport\": \"xx\",\n \"CreateTime\": 1,\n \"VipList\": [\n {\n \"Vip\": \"xx\",\n \"Vport\": \"xx\"\n }\n ],\n \"RemainingTopics\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
260
- "title": "Getting instance attributes"
304
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeInstanceAttributes\n&InstanceId=ckafka-pkwxedpq\n&<Common request parameters>",
305
+ "output": "{\n \"Response\": {\n \"RequestId\": \"dc67ed1b-3ada-4dad-9c5e-dc2a3619558e\",\n \"Result\": {\n \"Bandwidth\": 1200,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"Config\": {\n \"AutoCreateTopicsEnable\": true,\n \"DefaultNumPartitions\": 10,\n \"DefaultReplicationFactor\": 2\n },\n \"CreateTime\": 1667461825,\n \"CreatedPartitions\": 1026,\n \"CreatedTopics\": 61,\n \"CustomCertId\": \"certid\",\n \"Cvm\": 1,\n \"DeleteRouteTimestamp\": \"\",\n \"DiskSize\": 1000,\n \"DynamicDiskConfig\": {\n \"DiskQuotaPercentage\": 75,\n \"Enable\": 1,\n \"MaxDiskSpace\": 500000,\n \"StepForwardPercentage\": 10\n },\n \"ElasticFloatBandwidth\": 480,\n \"ExpireTime\": 1735890625,\n \"Features\": [\n \"FEATURE_SUBNET_ACL\",\n \"FEATURE_SASL_SSL\",\n \"FEATURE_MULIT_SASL_PLAINTEXT\",\n \"FEATURE_TOPIC_QUOTA\",\n \"FEATURE_SASL_SCRAM_512\",\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"FreePartitionNumber\": 1200,\n \"Healthy\": 1,\n \"HealthyMessage\": \"healthy\",\n \"InstanceChargeType\": \"PREPAID\",\n \"InstanceId\": \"ckafka-pkwxedpq\",\n\"InstanceName\": \"[Do not delete - Do not create public network domains, security tickets may occur] spock-test.\"\n \"InstanceType\": \"profession\",\n \"MaxConnection\": 10000,\n \"MaxGroupNum\": 200,\n \"MsgRetentionTime\": 2880,\n \"PublicNetwork\": 6,\n \"RemainderPartitions\": 174,\n \"RemainderTopics\": 539,\n \"RemainingPartitions\": 174,\n \"RemainingTopics\": 539,\n \"RetentionTimeConfig\": {\n \"BottomRetention\": 360,\n \"DiskQuotaPercentage\": 75,\n \"Enable\": 0,\n \"StepForwardPercentage\": 10\n },\n \"Status\": 1,\n \"SubnetId\": \"subnet-kg07707y\",\n \"Tags\": [\n {\n \"TagKey\": \"Application\",\n \"TagValue\": \"underlay-domain\"\n },\n {\n \"TagKey\": \"key\",\n \"TagValue\": \"555555\"\n }\n ],\n \"Version\": \"2.4.1\",\n \"Vip\": \"172.16.0.17\",\n \"VipList\": [\n {\n \"Vip\": \"172.16.0.17\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-apwrtw01\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n }\n }\n}",
306
+ "title": "Obtaining Instance Attributes"
261
307
  }
262
308
  ],
263
309
  "DescribeInstances": [
@@ -271,33 +317,41 @@
271
317
  "DescribeInstancesDetail": [
272
318
  {
273
319
  "document": "1",
274
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeInstancesDetail\n&InstanceId=instance-will-s\n&SearchWord=tre\n&Offset=0\n&Limit=10\n&Status.0=0\n&Status.1=1\n&Status.2=2\n&<Common request parameters>",
275
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 0,\n \"InstanceList\": [\n {\n \"InstanceId\": \"xx\",\n \"InstanceName\": \"xx\",\n \"Vip\": \"xx\",\n \"Vport\": \"xx\",\n \"VipList\": [\n {\n \"Vip\": \"xx\",\n \"Vport\": \"xx\"\n }\n ],\n \"Status\": 0,\n \"Bandwidth\": 0,\n \"DiskSize\": 0,\n \"ZoneId\": 0,\n \"VpcId\": \"xx\",\n \"SubnetId\": \"xx\",\n \"RenewFlag\": 0,\n \"Healthy\": 0,\n \"HealthyMessage\": \"xx\",\n \"CreateTime\": 0,\n \"ExpireTime\": 0,\n \"IsInternal\": 0,\n \"TopicNum\": 0,\n \"Tags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"Version\": \"xx\",\n \"ZoneIds\": [\n 0\n ],\n \"Cvm\": 0,\n \"InstanceType\": \"xx\",\n \"DiskType\": \"xx\",\n \"MaxTopicNumber\": 0,\n \"MaxPartitionNumber\": 0,\n \"RebalanceTime\": \"xx\",\n \"PartitionNumber\": 1,\n \"PublicNetworkChargeType\": \"xx\",\n \"PublicNetwork\": 0,\n \"ClusterType\": \"xx\",\n \"Features\": [\n \"xx\"\n ]\n }\n ]\n },\n \"RequestId\": \"xx\"\n }\n}",
276
- "title": "Obtaining instance list details"
320
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeInstancesDetail\n&<Common request parameters>",
321
+ "output": "{\n \"Response\": {\n \"RequestId\": \"84b84177-c5aa-4fa9-aae0-14618af7d251\",\n \"Result\": {\n \"InstanceList\": [\n {\n \"Bandwidth\": 800,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1732245392,\n \"Cvm\": 1,\n \"DiskSize\": 1000,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 1734837392,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"\",\n \"InstanceId\": \"ckafka-wdvgwwx2\",\n \"InstanceName\": \"test-public-network\",\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 1200,\n \"MaxTopicNumber\": 600,\n \"PartitionNumber\": 60,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 0,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 6,\n \"Version\": \"2.8.1\",\n \"Vip\": \"10.0.1.17\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.17\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n },\n {\n \"Bandwidth\": 19200,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1732086196,\n \"Cvm\": 1,\n \"DiskSize\": -1,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 0,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"\",\n \"InstanceId\": \"ckafka-vv7wpp93\",\n\"InstanceName\": \"wenbingshen-test\"\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 5000,\n \"MaxTopicNumber\": 2500,\n \"PartitionNumber\": 46,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_POSTPAID_BY_HOUR\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 0,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 3,\n \"Version\": \"2.8.1\",\n \"Vip\": \"10.0.1.31\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.31\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n },\n {\n \"Bandwidth\": 160,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1731479434,\n \"Cvm\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 1734071434,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"\",\n \"InstanceId\": \"ckafka-bzmjpp4z\",\n \"InstanceName\": \"Reserved_hdq_0.6_2.8\",\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 400,\n \"MaxTopicNumber\": 200,\n \"PartitionNumber\": 18,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 0,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 3,\n \"Version\": \"2.8.1\",\n \"Vip\": \"10.0.1.3\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.3\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": []\n },\n {\n \"Bandwidth\": 160,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1724071025,\n \"Cvm\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 1734611825,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"\",\n \"InstanceId\": \"ckafka-mon24787\",\n\"InstanceName\": \"carwyn-test Do not delete\"\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 400,\n \"MaxTopicNumber\": 200,\n \"PartitionNumber\": 26,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 1,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 5,\n \"Version\": \"1.1.1\",\n \"Vip\": \"10.0.1.29\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.29\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n },\n {\n \"Bandwidth\": 1600,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1722481364,\n \"Cvm\": 1,\n \"DiskSize\": 1000,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 0,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"\",\n \"InstanceId\": \"ckafka-5k7va2bv\",\n\"InstanceName\": \"shilinlu-test-Do not modify\",\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 1400,\n \"MaxTopicNumber\": 700,\n \"PartitionNumber\": 72,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_POSTPAID_BY_HOUR\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 0,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 5,\n \"Version\": \"2.8.1\",\n \"Vip\": \"10.0.1.40\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.40\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n },\n {\n \"Bandwidth\": 3200,\n \"ClusterType\": \"CLOUD_CVM\",\n \"CreateTime\": 1716451701,\n \"Cvm\": 1,\n \"DiskSize\": 3000,\n \"DiskType\": \"CLOUD_SSD\",\n \"ExpireTime\": 0,\n \"Features\": [\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"healthy\",\n \"InstanceId\": \"ckafka-na37x9qa\",\n\"InstanceName\": \"shilinlu-exporter test\",\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 2000,\n \"MaxTopicNumber\": 1000,\n \"PartitionNumber\": 22,\n \"PublicNetwork\": 3,\n \"PublicNetworkChargeType\": \"BANDWIDTH_POSTPAID_BY_HOUR\",\n \"RebalanceTime\": \"0000-00-00 00:00:00\",\n \"RenewFlag\": 0,\n \"Status\": 1,\n \"SubnetId\": \"subnet-5rhipsse\",\n \"Tags\": [],\n \"TopicNum\": 2,\n \"Version\": \"2.4.1\",\n \"Vip\": \"10.0.1.25\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.1.25\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-ks7w9y0b\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": []\n },\n {\n \"Bandwidth\": 1200,\n \"ClusterType\": \"CLOUD_EKS_TSE\",\n \"CreateTime\": 1667461825,\n \"Cvm\": 1,\n \"DiskSize\": 1000,\n \"DiskType\": \"CLOUD_BASIC\",\n \"ExpireTime\": 1735890625,\n \"Features\": [\n \"CLOUD_EKS_TSE\",\n \"CLOUD_EKS_CROS_ZONE\",\n \"FEATURE_SASL_SCRAM\"\n ],\n \"Healthy\": 1,\n \"HealthyMessage\": \"healthy\",\n \"InstanceId\": \"ckafka-pkwxedpq\",\n\"InstanceName\": \"[Do not delete - Do not create public network domains, security tickets may occur] spock-test.\"\n \"InstanceType\": \"profession\",\n \"IsInternal\": 0,\n \"MaxPartitionNumber\": 1200,\n \"MaxTopicNumber\": 600,\n \"PartitionNumber\": 1026,\n \"PublicNetwork\": 6,\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"RebalanceTime\": \"2023-07-04 10:30:58\",\n \"RenewFlag\": 1,\n \"Status\": 1,\n \"SubnetId\": \"subnet-kg07707y\",\n \"Tags\": [\n {\n \"TagKey\": \"Application\",\n \"TagValue\": \"underlay-domain\"\n },\n {\n \"TagKey\": \"tagkey\",\n \"TagValue\": \"555555\"\n }\n ],\n \"TopicNum\": 61,\n \"Version\": \"2.4.1\",\n \"Vip\": \"172.16.0.17\",\n \"VipList\": [\n {\n \"Vip\": \"172.16.0.17\",\n \"Vport\": \"9092\"\n }\n ],\n \"VpcId\": \"vpc-apwrtw01\",\n \"Vport\": \"9092\",\n \"ZoneId\": 100006,\n \"ZoneIds\": [\n 100006,\n 100007\n ]\n }\n ],\n \"TotalCount\": 7\n }\n }\n}",
322
+ "title": "Retrieving Instance List Details"
277
323
  }
278
324
  ],
279
325
  "DescribeRegion": [
280
326
  {
281
327
  "document": " ",
282
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRegion\n<Common request parameters>\n\n{\n \"Business\": \"10\"\n}",
283
- "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"RegionId\": 8,\n \"RegionName\": \"Beijing\",\n \"AreaName\": \"North China\",\n \"RegionCode\": \"bj\",\n \"RegionCodeV3\": \"ap-beijing\"\n },\n {\n \"RegionId\": 16,\n \"RegionName\": \"Chengdu\",\n \"AreaName\": \"Southwest China\",\n \"RegionCode\": \"cd\",\n \"RegionCodeV3\": \"ap-chengdu\"\n },\n {\n \"RegionId\": 19,\n \"RegionName\": \"Chongqing\",\n \"AreaName\": \"Southwest China\",\n \"RegionCode\": \"cq\",\n \"RegionCodeV3\": \"ap-chongqing\"\n },\n {\n \"RegionId\": 5,\n \"RegionName\": \"Hong Kong (China)\",\n \"AreaName\": \"Southeast Asia\",\n \"RegionCode\": \"hk\",\n \"RegionCodeV3\": \"ap-hongkong\"\n },\n {\n \"RegionId\": 9,\n \"RegionName\": \"Singapore\",\n \"AreaName\": \"Southeast Asia\",\n \"RegionCode\": \"sg\",\n \"RegionCodeV3\": \"ap-singapore\"\n },\n {\n \"RegionId\": 21,\n \"RegionName\": \"Mumbai\",\n \"AreaName\": \"Asia Pacific\",\n \"RegionCode\": \"in\",\n \"RegionCodeV3\": \"ap-mumbai\"\n },\n {\n \"RegionId\": 25,\n \"RegionName\": \"Tokyo\",\n \"AreaName\": \"Asia Pacific\",\n \"RegionCode\": \"jp\",\n \"RegionCodeV3\": \"ap-tokyo\"\n },\n {\n \"RegionId\": 6,\n \"RegionName\": \"Toronto\",\n \"AreaName\": \"North America\",\n \"RegionCode\": \"ca\",\n \"RegionCodeV3\": \"na-toronto\"\n },\n {\n \"RegionId\": 15,\n \"RegionName\": \"Silicon Valley\",\n \"AreaName\": \"West US\",\n \"RegionCode\": \"usw\",\n \"RegionCodeV3\": \"na-siliconvalley\"\n },\n {\n \"RegionId\": 22,\n \"RegionName\": \"Ashburn\",\n \"AreaName\": \"East US\",\n \"RegionCode\": \"use\",\n \"RegionCodeV3\": \"na-ashburn\"\n }\n ],\n \"RequestId\": \"fe2ba3b1-90bb-425d-abd4-08a62d0c3686\"\n }\n}",
284
- "title": "Enumerating regions"
328
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRegion\n<Common request parameters>\n\n{\n \"Business\": \"ckafka\"\n}",
329
+ "output": "{\n \"Response\": {\n \"RequestId\": \"4b44eaee-3807-482d-a589-9f0126615d9d\",\n \"Result\": [\n {\n\"AreaName\": \"South China\"\n \"Ipv6\": 0,\n \"MultiZone\": 1,\n \"RegionCode\": \"gz\",\n \"RegionCodeV3\": \"ap-guangzhou\",\n \"RegionId\": 1,\n\"RegionName\": \"Guangzhou\"\n \"Support\": \"profession,serverless\"\n }\n ]\n }\n}",
330
+ "title": "Enumerate Regions"
285
331
  }
286
332
  ],
287
333
  "DescribeRoute": [
288
334
  {
289
- "document": "This example shows you how to query the routing information.",
290
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeRoute&InstanceId=xxx&<Common request parameters>",
291
- "output": "{\n \"Response\": {\n \"Result\": {\n \"Routers\": [\n {\n \"AccessType\": 0,\n \"RouteId\": 0,\n \"VipType\": 0,\n \"VipList\": [\n {\n \"Vip\": \"1.1.1.1\",\n \"Vport\": \"8080\"\n }\n ],\n \"Domain\": \"abc\",\n \"DomainPort\": 0,\n \"DeleteTimestamp\": \"abc\"\n }\n ]\n },\n \"RequestId\": \"abc\"\n }\n}",
292
- "title": "Querying the routing information"
335
+ "document": "Views routing information",
336
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeRoute\n&InstanceId=ckafka-na37x9qa\n&<Common request parameters>",
337
+ "output": "{\n \"Response\": {\n \"RequestId\": \"972ab361-b677-4431-9f49-f54f8e1e62ab\",\n \"Result\": {\n \"Routers\": [\n {\n \"AccessType\": 0,\n \"BrokerVipList\": [\n {\n \"Vip\": \"11.135.14.76\",\n \"Vport\": \"7609\"\n },\n {\n \"Vip\": \"11.135.14.76\",\n \"Vport\": \"7610\"\n },\n {\n \"Vip\": \"11.135.14.76\",\n \"Vport\": \"7611\"\n }\n ],\n \"DeleteTimestamp\": \"\",\n \"Domain\": \"\",\n \"DomainPort\": 0,\n \"RouteId\": 136207,\n \"Subnet\": \"subnet-m7o87b20\",\n \"VipList\": [\n {\n \"Vip\": \"11.135.14.76\",\n \"Vport\": \"7608\"\n }\n ],\n \"VipType\": 7,\n \"VpcId\": \"vpc-n3n50e5r\"\n },\n {\n \"AccessType\": 0,\n \"BrokerVipList\": [\n {\n \"Vip\": \"10.0.0.15\",\n \"Vport\": \"9093\"\n },\n {\n \"Vip\": \"10.0.0.15\",\n \"Vport\": \"9094\"\n },\n {\n \"Vip\": \"10.0.0.15\",\n \"Vport\": \"9095\"\n }\n ],\n \"DeleteTimestamp\": \"\",\n \"Domain\": \"\",\n \"DomainPort\": 0,\n \"RouteId\": 137005,\n \"Subnet\": \"subnet-pu55o55e\",\n \"VipList\": [\n {\n \"Vip\": \"10.0.0.15\",\n \"Vport\": \"9092\"\n }\n ],\n \"VipType\": 3,\n \"VpcId\": \"vpc-ktradax5\"\n },\n {\n \"AccessType\": 1,\n \"BrokerVipList\": [\n {\n \"Vip\": \"106.55.222.195\",\n \"Vport\": \"50009\"\n },\n {\n \"Vip\": \"106.55.222.195\",\n \"Vport\": \"50010\"\n },\n {\n \"Vip\": \"106.55.222.195\",\n \"Vport\": \"50011\"\n }\n ],\n \"DeleteTimestamp\": \"\",\n \"Domain\": \"ckafka-na37x9qa.ap-guangzhou.ckafka.tencentcloudmq.com\",\n \"DomainPort\": 50000,\n \"RouteId\": 137270,\n \"Subnet\": \"\",\n \"VipList\": [\n {\n \"Vip\": \"81.71.20.57\",\n \"Vport\": \"50000\"\n }\n ],\n \"VipType\": 1,\n \"VpcId\": \"vpc-ks7w9y0b\"\n },\n {\n \"AccessType\": 0,\n \"BrokerVipList\": [\n {\n \"Vip\": \"11.135.14.109\",\n \"Vport\": \"8281\"\n },\n {\n \"Vip\": \"11.135.14.109\",\n \"Vport\": \"8282\"\n },\n {\n \"Vip\": \"11.135.14.109\",\n \"Vport\": \"8283\"\n }\n ],\n \"DeleteTimestamp\": \"\",\n \"Domain\": \"\",\n \"DomainPort\": 0,\n \"RouteId\": 137606,\n \"Subnet\": \"subnet-m7o87b20\",\n \"VipList\": [\n {\n \"Vip\": \"11.135.14.109\",\n \"Vport\": \"8280\"\n }\n ],\n \"VipType\": 7,\n \"VpcId\": \"vpc-n3n50e5r\"\n }\n ]\n }\n }\n}",
338
+ "title": "Views routing information"
339
+ }
340
+ ],
341
+ "DescribeSecurityGroupRoutes": [
342
+ {
343
+ "document": "",
344
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSecurityGroupRoutes\n<Common request parameters>\n\n{\n \"Offset\": 0,\n \"Limit\": 10\n}",
345
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"SecurityGroupRoutes\": [\n {\n \"InstanceRoute\": {\n \"InstanceId\": \"ckafka-test\",\n \"RouteId\": 1234\n },\n \"SecurityGroupIds\": [],\n\"InstanceName\": \"ckafka-test\"\n \"VpcId\": \"vpc-test\",\n \"Vip\": \"10.0.0.5\"\n }\n ],\n \"TotalCount\": 1\n },\n \"RequestId\": \"test-reqId-1134\"\n }\n}",
346
+ "title": "Retrieving the Security Group Route Information List"
293
347
  }
294
348
  ],
295
349
  "DescribeTaskStatus": [
296
350
  {
297
351
  "document": " ",
298
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTaskStatus&FlowId=123&<Common request parameters>",
299
- "output": "{\n \"Response\": {\n \"Result\": {\n \"Status\": 0\n },\n \"RequestId\": \"ca7d6645-e33b-436c-8c83-b2a1229a57fa\"\n }\n}",
300
- "title": "Querying the task status"
352
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTaskStatus\n&FlowId=1003\n&<Common request parameters>",
353
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"Status\": 0,\n \"Output\": \"success\"\n },\n \"RequestId\": \"ca7d6645-e33b-436c-8c83-b2a1229a57fa\"\n }\n}",
354
+ "title": "Querying Task Status"
301
355
  }
302
356
  ],
303
357
  "DescribeTopic": [
@@ -311,137 +365,177 @@
311
365
  "DescribeTopicAttributes": [
312
366
  {
313
367
  "document": " ",
314
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTopicAttributes\n&InstanceId=xxx\n&TopicName=xxx\n&<Common request parameters>",
315
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TopicId\": \"xx\",\n \"PartitionNum\": 3,\n \"AclRuleList\": [\n {\n \"Comment\": \"xx\",\n \"PatternType\": \"xx\",\n \"UpdateTimeStamp\": \"xx\",\n \"InstanceId\": \"xx\",\n \"Pattern\": \"xx\",\n \"ResourceType\": \"xx\",\n \"AclList\": \"xx\",\n \"PatternTypeTitle\": \"xx\",\n \"IsApplied\": 0,\n \"RuleName\": \"xx\",\n \"TopicCount\": 0,\n \"CreateTimeStamp\": \"xx\",\n \"TopicName\": \"xx\"\n }\n ],\n \"Note\": \"xx\",\n \"IpWhiteList\": [\n \"xx\"\n ],\n \"EnableAclRule\": 0,\n \"QuotaConfig\": {\n \"QuotaConsumerByteRate\": 0,\n \"QuotaProducerByteRate\": 0\n },\n \"Partitions\": [\n {\n \"Partition\": 0,\n \"IsrNum\": 2,\n \"LeaderStatus\": 0,\n \"ReplicaNum\": 2\n },\n {\n \"Partition\": 1,\n \"IsrNum\": 2,\n \"LeaderStatus\": 0,\n \"ReplicaNum\": 2\n },\n {\n \"Partition\": 2,\n \"IsrNum\": 2,\n \"LeaderStatus\": 0,\n \"ReplicaNum\": 2\n }\n ],\n \"Config\": {\n \"UncleanLeaderElectionEnable\": 0,\n \"MinInsyncReplicas\": 0,\n \"SegmentMs\": 0,\n \"CleanUpPolicy\": \"xx\",\n \"SegmentBytes\": 0,\n \"RetentionBytes\": 0,\n \"MaxMessageBytes\": 0,\n \"Retention\": 300000000\n },\n \"CreateTime\": 111,\n \"EnableWhiteList\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
316
- "title": "Getting topic attributes"
368
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTopicAttributes\n&InstanceId=ckafka-na37x9qa\n&TopicName=test-sh\n&<Common request parameters>",
369
+ "output": "{\n \"Response\": {\n \"RequestId\": \"2631ff19-2dd4-41a6-9391-c7543dc22c8a\",\n \"Result\": {\n \"AclRuleList\": [],\n \"Config\": {\n \"CleanUpPolicy\": \"delete\",\n \"LogMsgTimestampType\": null,\n \"MaxMessageBytes\": 8388608,\n \"MinInsyncReplicas\": 1,\n \"Retention\": 86400000,\n \"RetentionBytes\": null,\n \"SegmentBytes\": null,\n \"SegmentMs\": null,\n \"UncleanLeaderElectionEnable\": 1\n },\n \"CreateTime\": 1720525148,\n \"EnableAclRule\": 0,\n \"EnableWhiteList\": 0,\n \"IpWhiteList\": [],\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"Partitions\": [\n {\n \"IsrNum\": 2,\n \"LeaderStatus\": 0,\n \"Partition\": 0,\n \"ReplicaNum\": 2\n }\n ],\n \"QuotaConfig\": {\n \"QuotaConsumerByteRate\": null,\n \"QuotaProducerByteRate\": null\n },\n \"ReplicaNum\": 2,\n \"TopicId\": \"topic-24gugwns\"\n }\n }\n}",
370
+ "title": "Retrieving Topic Attributes"
317
371
  }
318
372
  ],
319
373
  "DescribeTopicDetail": [
320
374
  {
321
375
  "document": " ",
322
376
  "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTopicDetail\n&InstanceId=ckafka-xxooa0\n&<Common request parameters>",
323
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TopicList\": [\n {\n \"TopicName\": \"test\",\n \"TopicId\": \"inter-topic-d7a2f7fq\",\n \"PartitionNum\": 3,\n \"ReplicaNum\": 2,\n \"Note\": \"\",\n \"CreateTime\": 1561637447,\n \"EnableWhiteList\": false,\n \"IpWhiteListCount\": 0,\n \"ForwardCosBucket\": \"\",\n \"ForwardStatus\": 1,\n \"ForwardInterval\": 0,\n \"Config\": {\n \"Retention\": 300000000\n },\n \"RetentionTimeConfig\": {\n \"Expect\": 1440,\n \"Current\": 480,\n \"ModTimeStamp\": 1561637447\n }\n }\n ],\n \"TotalCount\": 12\n },\n \"RequestId\": \"98fdae03-9bc2-4c2e-b429-0a96cca7144b\"\n }\n}",
324
- "title": "Getting topic list details"
377
+ "output": "{\n \"Response\": {\n \"RequestId\": \"071db315-27d5-4a7c-8bb3-e05c23e7a69c\",\n \"Result\": {\n \"TopicList\": [\n {\n \"Config\": {\n \"CleanUpPolicy\": \"delete\",\n \"LogMsgTimestampType\": null,\n \"MaxMessageBytes\": 8388608,\n \"MinInsyncReplicas\": 1,\n \"Retention\": 259200000,\n \"RetentionBytes\": null,\n \"SegmentBytes\": null,\n \"SegmentMs\": null,\n \"UncleanLeaderElectionEnable\": 1\n },\n \"CreateTime\": 1716452124,\n \"EnableWhiteList\": false,\n \"ForwardCosBucket\": \"\",\n \"ForwardInterval\": 0,\n \"ForwardStatus\": 1,\n \"IpWhiteListCount\": 0,\n \"Note\": \"\",\n \"PartitionNum\": 10,\n \"ReplicaNum\": 2,\n \"RetentionTimeConfig\": {\n \"Current\": 4320,\n \"Expect\": 4320,\n \"ModTimeStamp\": 1716452125000\n },\n \"Status\": 0,\n \"Tags\": null,\n \"TopicId\": \"topic-4mi2t5w2\",\n \"TopicName\": \"yourname\"\n },\n {\n \"Config\": {\n \"CleanUpPolicy\": \"delete\",\n \"LogMsgTimestampType\": null,\n \"MaxMessageBytes\": 8388608,\n \"MinInsyncReplicas\": 1,\n \"Retention\": 86400000,\n \"RetentionBytes\": null,\n \"SegmentBytes\": null,\n \"SegmentMs\": null,\n \"UncleanLeaderElectionEnable\": 1\n },\n \"CreateTime\": 1720525148,\n \"EnableWhiteList\": false,\n \"ForwardCosBucket\": \"\",\n \"ForwardInterval\": 0,\n \"ForwardStatus\": 1,\n \"IpWhiteListCount\": 0,\n \"Note\": \"\",\n \"PartitionNum\": 1,\n \"ReplicaNum\": 2,\n \"RetentionTimeConfig\": {\n \"Current\": 1440,\n \"Expect\": 1440,\n \"ModTimeStamp\": 1720525149000\n },\n \"Status\": 0,\n \"Tags\": null,\n \"TopicId\": \"topic-24gugwns\",\n \"TopicName\": \"test-shilinlu\"\n }\n ],\n \"TotalCount\": 2\n }\n }\n}",
378
+ "title": "Retrieving Instance List Details"
325
379
  }
326
380
  ],
327
381
  "DescribeTopicProduceConnection": [
328
382
  {
329
- "document": "This example shows you how to get the topic connection information.",
330
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicProduceConnection\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-xxxx\",\n \"TopicName\": \"xxxx\"\n}",
331
- "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"IpAddr\": \"xxxxx\",\n \"Time\": \"2021-10-10 21:10:48\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
332
- "title": "Getting the topic connection information"
383
+ "document": "This example shows you how to get topic connection information.",
384
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicProduceConnection\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"TopicName\": \"topic-name\"\n}",
385
+ "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"IpAddr\": \"10.23.1.1\",\n \"Time\": \"2020-08-21 11:15:54\",\n \"IsUnSupportVersion\": true\n }\n ],\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
386
+ "title": "Retrieving topic Connection Information"
333
387
  }
334
388
  ],
335
389
  "DescribeTopicSubscribeGroup": [
336
390
  {
337
391
  "document": " ",
338
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicSubscribeGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-kmex0nvv\",\n \"TopicName\": \"test\"\n}",
339
- "output": "{\n \"Response\": {\n \"Result\": {\n \"Status\": 0,\n \"TotalCount\": 1,\n \"StatusCountInfo\": \"xx\",\n \"GroupsInfo\": [\n {\n \"Protocol\": \"xx\",\n \"ProtocolType\": \"xx\",\n \"ErrorCode\": \"xx\",\n \"State\": \"xx\",\n \"Members\": [\n {\n \"ClientHost\": \"xx\",\n \"MemberId\": \"xx\",\n \"ClientId\": \"xx\",\n \"Assignment\": {\n \"Topics\": [\n {\n \"Topic\": \"xx\",\n \"Partitions\": [\n 0\n ]\n }\n ],\n \"Version\": 0\n }\n }\n ],\n \"Group\": \"xx\"\n }\n ]\n },\n \"RequestId\": \"xx\"\n }\n}",
340
- "title": "Searching and subscribing the message group information of a topic"
392
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicSubscribeGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-kmex0nvv\",\n \"TopicName\": \"topic-test\"\n}",
393
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"Status\": 1,\n \"TotalCount\": 2,\n \"StatusCountInfo\": \"1 Empty, 1 Stable\",\n \"GroupsInfo\": [\n {\n \"Protocol\": \"\",\n \"ProtocolType\": \"\",\n \"ErrorCode\": \"0\",\n \"State\": \"Empty\",\n \"Members\": [],\n \"Group\": \"xx1\"\n },\n {\n \"Protocol\": \"roundrobin\",\n \"ProtocolType\": \"consumer\",\n \"ErrorCode\": \"0\",\n \"State\": \"Stable\",\n \"Members\": [\n {\n \"ClientHost\": \"10.0.0.0\",\n \"MemberId\": \"consumer-63-/10.0.0.0-2022-07-31 19:09:08:169-73e4xx82-4c42-4ccf-8d01-7c74c8xxxxx2\",\n \"ClientId\": \"consumer-63\",\n \"Assignment\": {\n \"Topics\": [\n {\n \"Topic\": \"xx_topic\",\n \"Partitions\": [\n 10\n ]\n }\n ],\n \"Version\": 0\n }\n }\n ],\n \"Group\": \"xx2\"\n }\n ]\n },\n \"RequestId\": \"91b6b112-7f0a-4e18-b353-5202bcafd2c2\"\n }\n}",
394
+ "title": "Querying Subscription Topic Message Group Information"
341
395
  }
342
396
  ],
343
397
  "DescribeTopicSyncReplica": [
344
398
  {
345
399
  "document": " ",
346
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicSyncReplica\n<Common request parameters>\n\n{\n \"InstanceId\": \"xx\",\n \"TopicName\": \"xxx\",\n \"Offset\": 0,\n \"Limit\": 10,\n \"OutOfSyncReplicaOnly\": true\n}",
347
- "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"TopicInSyncReplicaList\": [\n {\n \"Partition\": \"xxxx\",\n \"Leader\": 1,\n \"Replica\": \"110,3551,2315\",\n \"InSyncReplica\": \"100,5526\",\n \"BeginOffset\": 10,\n \"EndOffset\": 10,\n \"MessageCount\": 1,\n \"OutOfSyncReplica\": \"120,51\"\n }\n ]\n },\n \"RequestId\": \"xx\"\n }\n}",
348
- "title": "Getting the details of unsynced topic"
400
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTopicSyncReplica\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"TopicName\": \"topic-test\",\n \"Offset\": 1,\n \"Limit\": 0,\n \"OutOfSyncReplicaOnly\": true\n}",
401
+ "output": "{\n \"Response\": {\n \"RequestId\": \"3faffeb7-6e6b-4689-8a00-4d5e5f9e9f22\",\n \"Result\": {\n \"TopicInSyncReplicaList\": [\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150032,150033\",\n \"Leader\": 150032,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-0\",\n \"Replica\": \"150032,150033\"\n },\n {\n \"BeginOffset\": 1,\n \"EndOffset\": 3,\n \"InSyncReplica\": \"150033,150034\",\n \"Leader\": 150033,\n \"MessageCount\": 2,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-1\",\n \"Replica\": \"150033,150034\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150034,150035\",\n \"Leader\": 150034,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-2\",\n \"Replica\": \"150034,150035\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150035,150032\",\n \"Leader\": 150035,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-3\",\n \"Replica\": \"150035,150032\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150032,150033\",\n \"Leader\": 150032,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-4\",\n \"Replica\": \"150032,150033\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150033,150034\",\n \"Leader\": 150033,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-5\",\n \"Replica\": \"150033,150034\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150034,150035\",\n \"Leader\": 150034,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-6\",\n \"Replica\": \"150034,150035\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150035,150032\",\n \"Leader\": 150035,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-7\",\n \"Replica\": \"150035,150032\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150032,150033\",\n \"Leader\": 150032,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-8\",\n \"Replica\": \"150032,150033\"\n },\n {\n \"BeginOffset\": 0,\n \"EndOffset\": 0,\n \"InSyncReplica\": \"150033,150034\",\n \"Leader\": 150033,\n \"MessageCount\": 0,\n \"OutOfSyncReplica\": \"\",\n \"Partition\": \"partition-9\",\n \"Replica\": \"150033,150034\"\n }\n ],\n \"TotalCount\": 10\n }\n }\n}",
402
+ "title": "Topic Synchronization Details"
403
+ }
404
+ ],
405
+ "DescribeTypeInstances": [
406
+ {
407
+ "document": " ",
408
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeTypeInstances\n&InstanceId=instance-will-s\n&SearchWord=tre\n&Offset=0\n&Limit=10\n&Status.0=0\n&Status.1=1\n&Status.2=2\n&Type=profession\n&<Common request parameters>",
409
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"TotalCount\": 1,\n \"InstanceList\": [\n {\n \"InstanceId\": \"instance-will-s\",\n \"InstanceName\": \"treTest\",\n \"IfCommunity\": true,\n \"Status\": 1\n }\n ]\n },\n \"RequestId\": \"31740399-5d06-404b-a4b5-3652e21c8a1d\"\n }\n}",
410
+ "title": "This API is used to obtain instance lists."
349
411
  }
350
412
  ],
351
413
  "DescribeUser": [
352
414
  {
353
415
  "document": " ",
354
- "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeUser\r\n&InstanceId=xxx\r\n&<Common request parameters>",
355
- "output": "{\n \"Response\": {\n \"Result\": {\n \"Users\": [\n {\n \"UserId\": 41,\n \"Name\": \"ANONYMOUS\",\n \"CreateTime\": \"2019-09-05 00:53:28\",\n \"UpdateTime\": \"2019-09-05 00:53:28\"\n },\n {\n \"UserId\": 40,\n \"Name\": \"test\",\n \"CreateTime\": \"2019-09-05 00:20:36\",\n \"UpdateTime\": \"2019-09-05 00:20:36\"\n }\n ],\n \"TotalCount\": 2\n },\n \"RequestId\": \"26f6afd4-2966-43f5-a7a2-d506de3e881f\"\n }\n}",
356
- "title": "Querying user information"
416
+ "input": "https://ckafka.tencentcloudapi.com/?Action=DescribeUser\n&InstanceId=ckafka-test\n&<Common request parameters>",
417
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"Users\": [\n {\n \"UserId\": 41,\n \"Name\": \"ANONYMOUS\",\n \"CreateTime\": \"2019-09-05 00:53:28\",\n \"UpdateTime\": \"2019-09-05 00:53:28\"\n },\n {\n \"UserId\": 40,\n \"Name\": \"Nametest\",\n \"CreateTime\": \"2019-09-05 00:20:36\",\n \"UpdateTime\": \"2019-09-05 00:20:36\"\n }\n ],\n \"TotalCount\": 2\n },\n \"RequestId\": \"26f6afd4-2966-43f5-a7a2-d506de3e881f\"\n }\n}",
418
+ "title": "Querying the User Information"
357
419
  }
358
420
  ],
359
421
  "FetchMessageByOffset": [
360
422
  {
361
423
  "document": " ",
362
- "input": "https://ckafka.tencentcloudapi.com/?Action=FetchMessageByOffset\n&InstanceId=xxx\n&Topic=xxx\n&Partition=1\n&Offset=1\n&<Common request parameters>",
363
- "output": "{\n \"Response\": {\n \"Result\": {\n \"Timestamp\": 0,\n \"Topic\": \"xxx\",\n \"Partition\": 2,\n \"Offset\": 2,\n \"Key\": \"xxx\",\n \"Value\": \"xxx\"\n },\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
364
- "title": "Querying messages"
424
+ "input": "https://ckafka.tencentcloudapi.com/?Action=FetchMessageByOffset\n&InstanceId=ckafka\n&Topic=topic-test\n&Partition=1\n&Offset=1\n&<Common request parameters>",
425
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"Topic\": \"topic-test\",\n \"Partition\": 0,\n \"Offset\": 0,\n \"Key\": \"key\",\n \"Value\": \"value\",\n \"Timestamp\": 0,\n \"Headers\": \"head\"\n },\n \"RequestId\": \"4a88011d-763d-446d-802e-fcbe970a4043\"\n }\n}",
426
+ "title": "Message Query"
365
427
  }
366
428
  ],
367
429
  "FetchMessageListByOffset": [
368
430
  {
369
431
  "document": " ",
370
- "input": "https://ckafka.tencentcloudapi.com/?Action=FetchMessageListByOffset\n&InstanceId=xxx\n&Topic=xxx\n&Partition=1\n&Offset=1\n&SinglePartitionRecordNumber=20\n&<Common request parameters>",
371
- "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"Topic\": \"xxx\",\n \"Partition\": 2,\n \"Offset\": 1,\n \"Key\": \"xxx\",\n \"Value\": \"xxx\",\n \"Timestamp\": 1\n },\n {\n \"Topic\": \"xxx\",\n \"Partition\": 2,\n \"Offset\": 2,\n \"Key\": \"xxx\",\n \"Value\": \"xxx\",\n \"Timestamp\": 1\n }\n ],\n \"RequestId\": \"62d589e0-53d5-47e0-95ff-237c48b8fb77\"\n }\n}",
372
- "title": "Querying messages based on an offset"
432
+ "input": "https://ckafka.tencentcloudapi.com/?Action=FetchMessageListByOffset\n&InstanceId=ckafka-test\n&Topic=topic-test\n&Partition=1\n&Offset=1\n&SinglePartitionRecordNumber=20\n&<Common request parameters>",
433
+ "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"Topic\": \"topic-test\",\n \"Partition\": 0,\n \"Offset\": 0,\n \"Key\": \"key\",\n \"Value\": \"value\",\n \"Timestamp\": 0,\n \"Headers\": \"head\"\n }\n ],\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
434
+ "title": "Querying Messages by offset"
435
+ }
436
+ ],
437
+ "FetchMessageListByTimestamp": [
438
+ {
439
+ "document": " ",
440
+ "input": "https://ckafka.tencentcloudapi.com/?Action=FetchMessageListByTimestamp\n&InstanceId=ckafka-test\n&Topic=topic-test\n&Partition=1\n&StartTime=1577808000000\n&SinglePartitionRecordNumber=20\n&<Common request parameters>",
441
+ "output": "{\n \"Response\": {\n \"Result\": [\n {\n \"Topic\": \"topic-test\",\n \"Partition\": 0,\n \"Offset\": 0,\n \"Key\": \"key\",\n \"Value\": \"value\",\n \"Timestamp\": 0,\n \"Headers\": \"head\"\n }\n ],\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
442
+ "title": "Message Query"
373
443
  }
374
444
  ],
375
445
  "InquireCkafkaPrice": [
376
446
  {
377
447
  "document": " ",
378
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquireCkafkaPrice\n<Common request parameters>\n\n{\n \"Partition\": 40,\n \"InstanceNum\": 1,\n \"InquiryDiskParam\": {\n \"DiskSize\": 500,\n \"DiskType\": \"SSD\"\n },\n \"ZoneIds\": [\n 100001\n ],\n \"Topic\": 30,\n \"Bandwidth\": 40,\n \"MessageRetention\": 4,\n \"PublicNetworkParam\": {\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"PublicNetworkMonthly\": 10\n },\n \"InstanceChargeParam\": {\n \"InstanceChargePeriod\": 1,\n \"InstanceChargeType\": \"PREPAID\"\n },\n \"InstanceType\": \"profession\",\n \"CategoryAction\": \"purchase\"\n}",
379
- "output": "{\n \"Response\": {\n \"Result\": {\n \"InstancePrice\": {\n \"DiscountPrice\": 0.0,\n \"GoodsNum\": 0,\n \"TimeSpan\": 0,\n \"DetailPrices\": {\n \"TopicPrice\": {\n \"DiscountPrice\": 0.0,\n \"Value\": 0,\n \"Discount\": 0.0,\n \"OriginalPrice\": 0.0,\n \"UnitPriceDiscount\": 0.0,\n \"UnitPrice\": 0.0\n },\n \"PartitionPrice\": {\n \"DiscountPrice\": 0.0,\n \"Value\": 0,\n \"Discount\": 0.0,\n \"OriginalPrice\": 0.0,\n \"UnitPriceDiscount\": 0.0,\n \"UnitPrice\": 0.0\n },\n \"BandwidthPrice\": {\n \"DiscountPrice\": 0.0,\n \"Value\": 0,\n \"Discount\": 0.0,\n \"OriginalPrice\": 0.0,\n \"UnitPriceDiscount\": 0.0,\n \"UnitPrice\": 0.0\n }\n },\n \"Discount\": 0.0,\n \"OriginalPrice\": 0.0,\n \"TimeUnit\": \"xx\",\n \"UnitPriceDiscount\": 0.0,\n \"Currency\": \"xx\",\n \"UnitPrice\": 0.0\n },\n \"PublicNetworkBandwidthPrice\": {\n \"DiscountPrice\": 0.0,\n \"GoodsNum\": 0,\n \"TimeSpan\": 0,\n \"DetailPrices\": {},\n \"Value\": 0,\n \"Discount\": 0.0,\n \"OriginalPrice\": 0.0,\n \"TimeUnit\": \"xx\",\n \"UnitPriceDiscount\": 0.0,\n \"Currency\": \"xx\",\n \"UnitPrice\": 0.0\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
380
- "title": "Querying the price of a CKafka instance"
448
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquireCkafkaPrice\n<Common request parameters>\n\n{\n \"Partition\": 800,\n \"InstanceNum\": 1,\n \"InquiryDiskParam\": {\n \"DiskSize\": 500,\n \"DiskType\": \"SSD\"\n },\n \"ZoneIds\": [\n 100001\n ],\n \"Topic\": 30,\n \"Bandwidth\": 40,\n \"MessageRetention\": 4,\n \"PublicNetworkParam\": {\n \"PublicNetworkChargeType\": \"BANDWIDTH_PREPAID\",\n \"PublicNetworkMonthly\": 6\n },\n \"InstanceChargeParam\": {\n \"InstanceChargePeriod\": 1,\n \"InstanceChargeType\": \"PREPAID\"\n },\n \"InstanceType\": \"profession\",\n \"CategoryAction\": \"purchase\"\n}",
449
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"InstancePrice\": {\n \"DetailPrices\": {\n \"BandwidthPrice\": {\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0,\n \"OriginalPrice\": 0,\n \"DiscountPrice\": 0,\n \"Discount\": 100,\n \"GoodsNum\": null,\n \"Currency\": null,\n \"DiskType\": null,\n \"TimeSpan\": null,\n \"TimeUnit\": null,\n \"Value\": 0\n },\n \"DiskPrice\": {\n \"UnitPrice\": 175,\n \"UnitPriceDiscount\": 50.1,\n \"OriginalPrice\": 175,\n \"DiscountPrice\": 50.1,\n \"Discount\": 28.3,\n \"GoodsNum\": null,\n \"Currency\": null,\n \"DiskType\": \"CLOUD_BASIC\",\n \"TimeSpan\": null,\n \"TimeUnit\": null,\n \"Value\": 500\n },\n \"PartitionPrice\": {\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0,\n \"OriginalPrice\": 0,\n \"DiscountPrice\": 0,\n \"Discount\": 100,\n \"GoodsNum\": null,\n \"Currency\": null,\n \"DiskType\": null,\n \"TimeSpan\": null,\n \"TimeUnit\": null,\n \"Value\": 0\n },\n \"TopicPrice\": {\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0,\n \"OriginalPrice\": 0,\n \"DiscountPrice\": 0,\n \"Discount\": 100,\n \"GoodsNum\": null,\n \"Currency\": null,\n \"DiskType\": null,\n \"TimeSpan\": null,\n \"TimeUnit\": null,\n \"Value\": 0\n },\n \"InstanceTypePrice\": {\n \"UnitPrice\": 190,\n \"UnitPriceDiscount\": 57.56,\n \"OriginalPrice\": 190,\n \"DiscountPrice\": 7.56,\n \"Discount\": 30.3,\n \"GoodsNum\": null,\n \"Currency\": null,\n \"DiskType\": null,\n \"TimeSpan\": null,\n \"TimeUnit\": null,\n \"Value\": 1\n }\n },\n \"UnitPrice\": 265,\n \"UnitPriceDiscount\": 647.7,\n \"OriginalPrice\": 265,\n \"DiscountPrice\": 67.67,\n \"Discount\": 29.92,\n \"GoodsNum\": 1,\n \"Currency\": \"CNY\",\n \"DiskType\": null,\n \"TimeSpan\": 1,\n \"TimeUnit\": \"m\",\n \"Value\": null\n },\n \"PublicNetworkBandwidthPrice\": null\n },\n \"RequestId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n}",
450
+ "title": "Ckafka Pricing"
451
+ }
452
+ ],
453
+ "InstanceScalingDown": [
454
+ {
455
+ "document": "This example shows you how to perform instance downsizing.",
456
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InstanceScalingDown\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"DiskSize\": 900,\n \"BandWidth\": 40,\n \"Partition\": 1000,\n \"UpgradeStrategy\": 1\n}",
457
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"DealNames\": [\n \"20230703002035272950891\"\n ]\n },\n \"RequestId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n}",
458
+ "title": "Instance Downsizing"
381
459
  }
382
460
  ],
383
461
  "ModifyAclRule": [
384
462
  {
385
- "document": " ",
386
- "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyAclRule\n&InstanceId=xxx\n&RuleName=xxx\n&IsApplied=1\n&<Common request parameters>",
463
+ "document": "This example shows you how to modify ACL rules.",
464
+ "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyAclRule\n&InstanceId=ckafka-test\n&RuleName=deny-all\n&IsApplied=1\n&<Common request parameters>",
387
465
  "output": "{\n \"Response\": {\n \"Result\": 1,\n \"RequestId\": \"72b987c9-8842-47ac-9ad6-fa2bde3e936d\"\n }\n}",
388
- "title": "Modifying ACL rules"
466
+ "title": "Modifying ACL Rules Demo"
389
467
  }
390
468
  ],
391
469
  "ModifyDatahubTopic": [
392
470
  {
393
471
  "document": " ",
394
- "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyDatahubTopic\n&Name=xxx\n&Note=xxx\n&RetentionMs=3600000\n&<Common request parameters>",
395
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"xx\",\n \"ReturnCode\": \"xx\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
396
- "title": "Setting topic attributes"
472
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDatahubTopic\n<Common request parameters>\n\n{\n \"Note\": \"yournote\",\n \"Name\": \"yourname\",\n \"RetentionMs\": \"3600000\"\n}",
473
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
474
+ "title": "Setting Topic Properties"
397
475
  }
398
476
  ],
399
477
  "ModifyGroupOffsets": [
400
478
  {
401
479
  "document": " ",
402
- "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyGroupOffsets\n&InstanceId=10\n&Group=\"group\"\n&Strategy=0\n&<Common request parameters>",
403
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\"\n },\n \"RequestId\": \"ae362db8-81f6-4441-b0cc-1f6ffa31127e\"\n }\n}",
404
- "title": "Setting consumer group offsets"
480
+ "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyGroupOffsets\n&InstanceId=ckafka-test\n&Group=\"group\"\n&Topics.0=topic-test\n&Strategy=1\n&<Common request parameters>",
481
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"SUCCESS\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"36713f94-d07d-4b96-babf-42d139276f23\"\n }\n}",
482
+ "title": "Set the Consumer Group (Groups) offset"
405
483
  }
406
484
  ],
407
485
  "ModifyInstanceAttributes": [
408
486
  {
409
487
  "document": " ",
410
- "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyInstanceAttributes\r\n&InstanceId=10\r\n&<Common request parameters>",
411
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok[no param set]\"\n },\n \"RequestId\": \"dfc46e62-73d6-4b6b-9cd8-4512259888f5\"\n }\n}",
412
- "title": "Setting instance attributes"
488
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceAttributes\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\"\n}",
489
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
490
+ "title": "Setting Instance Attributes"
413
491
  }
414
492
  ],
415
493
  "ModifyInstancePre": [
416
494
  {
417
495
  "document": " ",
418
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstancePre\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-xxxx\",\n \"BandWidth\": \"40\",\n \"DiskSize\": \"600\"\n}",
419
- "output": "{\n \"Response\": {\n \"Result\": {\n \"DeleteRouteTimestamp\": \"xx\",\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"InstanceId\": \"ckafka-xxxx\",\n \"DealNames\": [\n \"1111111111\"\n ]\n }\n },\n \"RequestId\": \"1ba4ac83-1e9e-497b-b3e1-4c10872a4068\"\n }\n}",
420
- "title": "Changing the configurations of a monthly subscribed (prepaid) instance"
496
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstancePre\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"BandWidth\": 40,\n \"DiskSize\": 600\n}",
497
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"DealNames\": [\n \"name\"\n ],\n \"InstanceId\": \"ckafka-test\",\n \"DealNameInstanceIdMapping\": [\n {\n \"DealName\": \"name\",\n \"InstanceIdList\": [\n \"name\"\n ]\n }\n ]\n },\n \"DeleteRouteTimestamp\": \"2024-12-02 12:21:23\"\n },\n \"RequestId\": \"84770b4b-df34-4ccf-8e22-41d3b1d0fe0d\"\n }\n}",
498
+ "title": "Modifying an Instance (Prepaid Annual and Monthly)"
421
499
  }
422
500
  ],
423
501
  "ModifyPassword": [
424
502
  {
425
503
  "document": " ",
426
- "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyPassword\r\n&InstanceId=xxx\r\n&Name=xxx\r\n&Password=1\r\n&PasswordNew=2\r\n&<Common request parameters>",
427
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\"\n },\n \"RequestId\": \"21c3d702-ae87-4a2a-a51b-b3d4516f121a\"\n }\n}",
428
- "title": "Changing the password"
504
+ "input": "https://ckafka.tencentcloudapi.com/?Action=ModifyPassword\n&InstanceId=ckafka-test\n&Name=name\n&Password=1\n&PasswordNew=2\n&<Common request parameters>",
505
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": null\n },\n \"RequestId\": \"21c3d702-ae87-4a2a-a51b-b3d4516f121a\"\n }\n}",
506
+ "title": "Changing Password"
507
+ }
508
+ ],
509
+ "ModifyRoutineMaintenanceTask": [
510
+ {
511
+ "document": " ",
512
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyRoutineMaintenanceTask\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-9jnejnb9\",\n \"MaintenanceType\": \"RE_BALANCE\",\n \"MaintenanceSubtype\": \"INSTANCE_PARTITION_RE_BALANCE\",\n \"PlannedTime\": 79200,\n \"Status\": 1,\n \"Week\": \"1,2,3,4,5,6,7\"\n}",
513
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"success\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"fcfb7c89-3973-44f1-9a3e-a2811c67434e\"\n }\n}",
514
+ "title": "Setting Instance Attributes"
429
515
  }
430
516
  ],
431
517
  "ModifyTopicAttributes": [
432
518
  {
433
519
  "document": " ",
434
- "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopicAttributes\n<Common request parameters>\n\n{\n \"InstanceId\": \"xxx\",\n \"Note\": \"xxx\",\n \"TopicName\": \"xxx\"\n}",
435
- "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnMessage\": \"xx\",\n \"ReturnCode\": \"xx\",\n \"Data\": {\n \"FlowId\": 0\n }\n },\n \"RequestId\": \"xx\"\n }\n}",
436
- "title": "Setting topic attributes"
520
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyTopicAttributes\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"Note\": \"note\",\n \"TopicName\": \"topic-test\"\n}",
521
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"ok\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"fcfb7c89-3973-44f1-9a3e-a2811c67434e\"\n }\n}",
522
+ "title": "Setting Topic Properties"
437
523
  }
438
524
  ],
439
525
  "SendMessage": [
440
526
  {
441
- "document": "This example shows you how to send messages through the HTTP access layer in DataHub.",
442
- "input": "POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: SendMessage<Common request parameters>{ \"DataHubId\": \"datahub-meuh9nhn\", \"Message\": [ { \"Key\": \"\", \"Body\": \"vvvvsdgsgshhh\" }, { \"Key\": \"\", \"Body\": \"vvvhhhhhhvsdgsgshhh\" } ]}",
527
+ "document": "This example shows you how to access the HTTP protocol endpoint.",
528
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SendMessage\n<Common request parameters>\n\n{\n \"DataHubId\": \"datahub-meuh9nhn\",\n \"Message\": [\n {\n \"Key\": \"key1\",\n \"Body\": \"vvvvsdgsgshhh\"\n },\n {\n \"Key\": \"key2\",\n \"Body\": \"vvvhhhhhhvsdgsgshhh\"\n }\n ]\n}",
443
529
  "output": "{\n \"Response\": {\n \"RequestId\": \"20e995ed-75b9-43bb-84c0-35676567e1a8\",\n \"MessageId\": [\n \"646174616875622d6d657568396e686e3a6465736372696265436c6f75644170693a343a3236313838\",\n \"875622d6d657568396e686e3a6465736372696265436c6f75644170693a343a3236323337\"\n ]\n }\n}",
444
- "title": "Sending messages through the HTTP access layer in DataHub"
530
+ "title": "Sending Messages Via DataHub HTTP"
531
+ }
532
+ ],
533
+ "UpgradeBrokerVersion": [
534
+ {
535
+ "document": "This example shows you how to upgrade the broker version.",
536
+ "input": "POST / HTTP/1.1\nHost: ckafka.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeBrokerVersion\n<Common request parameters>\n\n{\n \"InstanceId\": \"ckafka-test\",\n \"Type\": 1,\n \"SourceVersion\": \"v2.8.1_r1.1.7\",\n \"TargetVersion\": \"v2.8.1_r1.1.8\",\n \"DelayTimeStamp\": \"\"\n}",
537
+ "output": "{\n \"Response\": {\n \"Result\": {\n \"ReturnCode\": \"0\",\n \"ReturnMessage\": \"success\",\n \"Data\": {\n \"FlowId\": 0,\n \"RouteDTO\": {\n \"RouteId\": 0\n }\n }\n },\n \"RequestId\": \"2412412412asfdsafasdsfd\"\n }\n}",
538
+ "title": "Upgrading the broker Version"
445
539
  }
446
540
  ]
447
541
  },