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
@@ -2,26 +2,26 @@
2
2
  "actions": {
3
3
  "ActivateInstance": [
4
4
  {
5
- "document": "This example shows you how to remove the isolation of an instance to make it accessible again.",
5
+ "document": "This example shows you how to restore instance access.",
6
6
  "input": "https://cynosdb.tencentcloudapi.com/?Action=ActivateInstance\n&ClusterId=cynosdbmysql-bzxxrmtq\n&InstanceIdList.0=cynosdbmysql-ins-7upukfpw\n&<Common request parameters>",
7
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": 123\n }\n}",
8
- "title": "Removing the isolation of an instance to make it accessible again"
7
+ "output": "{\n \"Response\": {\n \"RequestId\": \"fd5759b5-89e9-483c-b79c-d99b27c33192\",\n \"FlowId\": 147842\n }\n}",
8
+ "title": "Restore Instance Access"
9
9
  }
10
10
  ],
11
11
  "AddClusterSlaveZone": [
12
12
  {
13
- "document": " ",
14
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddClusterSlaveZone\n<Common request parameters>\n\n{\n \"ClusterId\": \"xx\",\n \"SlaveZone\": \"xx\"\n}",
15
- "output": "{\n \"Response\": {\n \"FlowId\": \"123\",\n \"RequestId\": \"128046\"\n }\n}",
16
- "title": "Adding the replica AZ"
13
+ "document": "This example shows you how to enable multi-AZ deployment.",
14
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddClusterSlaveZone\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-asd\",\n \"SlaveZone\": \"ap-guangzhou-4\"\n}",
15
+ "output": "{\n \"Response\": {\n \"FlowId\": 147184,\n \"RequestId\": \"fd5759b5-89e9-483c-b79c-d99b27c33192\"\n }\n}",
16
+ "title": "Enable Multi-AZ Deployment"
17
17
  }
18
18
  ],
19
19
  "AddInstances": [
20
20
  {
21
21
  "document": "This example shows you how to add a read-only instance.",
22
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddInstances\n<Common request parameters>\n\n{\n \"ReadOnlyCount\": \"1\",\n \"VpcId\": \"vpc-1ptuei0b\",\n \"ClusterId\": \"cynosdbmysql-6gtlgm5l\",\n \"Memory\": \"4\",\n \"SubnetId\": \"subnet-1tmw9t4o\",\n \"Cpu\": \"2\"\n}",
23
- "output": "{\n \"Response\": {\n \"TranId\": \"abc\",\n \"DealNames\": [\n \"abc\"\n ],\n \"ResourceIds\": [\n \"abc\"\n ],\n \"BigDealIds\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
24
- "title": "Adding an instance"
22
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddInstances\n<Common request parameters>\n\n{\n \"ReadOnlyCount\": 1,\n \"VpcId\": \"vpc-1ptuei0b\",\n \"ClusterId\": \"cynosdbmysql-6gtlgm5l\",\n \"Memory\": 4,\n \"SubnetId\": \"subnet-1tmw9t4o\",\n \"Cpu\": 2\n}",
23
+ "output": "{\n \"Response\": {\n \"TranId\": \"myTranId\",\n \"DealNames\": [\n \"182711111\"\n ],\n \"ResourceIds\": [\n \"cynosdbmysql-mwg712mm\"\n ],\n \"BigDealIds\": [\n \"137895\"\n ],\n \"RequestId\": \"48fa5cf5-77db-4e32-90ef-22c71ed95f51\"\n }\n}",
24
+ "title": "Add an Instance"
25
25
  }
26
26
  ],
27
27
  "BindClusterResourcePackages": [
@@ -43,17 +43,33 @@
43
43
  "CloseClusterPasswordComplexity": [
44
44
  {
45
45
  "document": " ",
46
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CloseClusterPasswordComplexity<common request parameters>{ \"ClusterIds\": [ \"cynosdbmysql-bzxxrmtq\" ]}",
47
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
48
- "title": "Disabling the password complexity for a cluster"
46
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseClusterPasswordComplexity\n<Common request parameters>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-bzxxrmtq\"\n ]\n}",
47
+ "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"1008300\"\n }\n}",
48
+ "title": "Shut Down the Cluster Password Complexity"
49
49
  }
50
50
  ],
51
51
  "CloseProxy": [
52
52
  {
53
53
  "document": "This example shows you how to disable the database proxy.",
54
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"abc\",\n \"ProxyGroupId\": \"abc\",\n \"OnlyCloseRW\": true\n}",
55
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"RequestId\": \"abc\"\n }\n}",
56
- "title": "Disabling the database proxy"
54
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg7212w\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-4378e0ky\",\n \"OnlyCloseRW\": true\n}",
55
+ "output": "{\n \"Response\": {\n \"FlowId\": 358874,\n \"TaskId\": 1063084,\n \"RequestId\": \"e4f4f48a-51b1-45be-a9e3-09f0d1412659\"\n }\n}",
56
+ "title": "Disable the Database Proxy"
57
+ }
58
+ ],
59
+ "CloseProxyEndPoint": [
60
+ {
61
+ "document": "",
62
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseProxyEndPoint\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-j9i41hdd\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-lti34611\"\n}",
63
+ "output": "{\n \"Response\": {\n \"FlowId\": 147186,\n \"TaskId\": 148273,\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}",
64
+ "title": "Close the Database Proxy Connection Address"
65
+ }
66
+ ],
67
+ "CloseSSL": [
68
+ {
69
+ "document": "This example shows you how to disable SSL encryption.",
70
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CloseSSL\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-jd510000\",\n \"InstanceId\": \"cynosdbmysql-ins-906n0000\"\n}",
71
+ "output": "{\n \"Response\": {\n \"FlowId\": 1,\n \"RequestId\": \"42d79173-6d36-4239-b7ad-5b993559a5c6\",\n \"TaskId\": 1\n }\n}",
72
+ "title": "Disable SSL Encryption"
57
73
  }
58
74
  ],
59
75
  "CloseWan": [
@@ -74,72 +90,88 @@
74
90
  ],
75
91
  "CreateAccounts": [
76
92
  {
77
- "document": " ",
78
- "input": "https://cynosdb.tencentcloudapi.com/?Action=CreateAccounts\n&ClusterId=xxx\n&Accounts.0.AccountName=xx\n&Accounts.0.AccountPassword=xxx\n&Accounts.0.Description=xxx\n&Accounts.0.Host=xxx\n&<Common request parameters>",
79
- "output": "{\n \"Response\": {\n \"RequestId\": \"176669\"\n }\n}",
80
- "title": "Creating account"
93
+ "document": "This example shows you how to create a user account.",
94
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAccounts\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-asd45qwe\",\n \"Accounts\": [\n {\n \"AccountName\": \"tom\",\n \"AccountPassword\": \"888888@Abcde\",\n \"Host\": \"1.1.1.1\",\n \"Description\": \"AccountDescription\",\n \"MaxUserConnections\": 10\n }\n ]\n}",
95
+ "output": "{\n \"Response\": {\n \"RequestId\": \"2f355036-ad6b-4b09-8d9b-793235f856c5\"\n }\n}",
96
+ "title": "Creating a User Account"
81
97
  }
82
98
  ],
83
99
  "CreateAuditRuleTemplate": [
84
100
  {
85
- "document": " ",
86
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<Common request parameters>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\",\n \"test\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"test\",\n \"Description\": \"Test rule template\"\n}",
101
+ "document": "This example shows you how to create an audit rule template.",
102
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAuditRuleTemplate\n<Common request parameters>\n\n{\n \"RuleFilters\": [\n {\n \"Type\": \"host\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"100.122.76.176\",\n \"10.0.0.9\"\n ]\n },\n {\n \"Type\": \"user\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"wy\",\n \"andy\"\n ]\n },\n {\n \"Type\": \"sqlType\",\n \"Compare\": \"EQS\",\n \"Value\": [\n \"Update\",\n \"Delete\"\n ]\n }\n ],\n \"RuleTemplateName\": \"andy\",\n \"Description\": \"andy template\"\n}",
87
103
  "output": "{\n \"Response\": {\n \"RuleTemplateId\": \"cynosdb-rt-ws23fwu8\",\n \"RequestId\": \"43-12121-812w1221213-62usf9093\"\n }\n}",
88
- "title": "Creating an audit rule template"
104
+ "title": "Creating an Audit Rule Template"
89
105
  }
90
106
  ],
91
107
  "CreateBackup": [
92
108
  {
93
- "document": " ",
109
+ "document": "This example shows you how to create a backup.",
94
110
  "input": "https://cynosdb.tencentcloudapi.com/?Action=CreateBackup\n&ClusterId=cynosdbpg-45knmnra\n&<Common request parameters>",
95
- "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"FlowId\": 12345\n }\n}",
96
- "title": "Creating a backup"
111
+ "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\",\n \"FlowId\": 147189\n }\n}",
112
+ "title": "Creating a Backup"
113
+ }
114
+ ],
115
+ "CreateCLSDelivery": [
116
+ {
117
+ "document": "",
118
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateCLSDelivery\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"CLSInfoList\": [\n {\n \"TopicId\": \"38b86342-7cb0-4776-9ebd-ff1830035da1\",\n \"TopicOperation\": \"reuse\",\n \"GroupId\": \"17de6e2a-efd0-4fc2-ba2e-8845bd4f9895\",\n \"Region\": \"ap-guangzhou\",\n \"GroupOperation\": \"reuse\"\n }\n ]\n}",
119
+ "output": "{\n \"Response\": {\n \"TaskId\": 148728,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}",
120
+ "title": "Create Log Delivery"
97
121
  }
98
122
  ],
99
123
  "CreateClusterDatabase": [
100
124
  {
101
- "document": " ",
102
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateClusterDatabase<common request parameters>{ \"UserHostPrivileges\": [ { \"DbUserName\": \"root\", \"DbHost\": \"%\", \"DbPrivilege\": \"xx\" } ], \"CollateRule\": \"utf8_general_ci\", \"DbName\": \"test\", \"Description\": \"test-beizhu\", \"CharacterSet\": \"utf8\", \"ClusterId\": \"cynosdbmysql-xxxxxx\"}",
125
+ "document": "This example shows you how to create a database.",
126
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateClusterDatabase\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg712en\",\n \"DbName\": \"tom\",\n \"CharacterSet\": \"utf8\",\n \"CollateRule\": \"utf8_general_ci\",\n \"UserHostPrivileges\": [\n {\n \"DbUserName\": \"root\",\n \"DbHost\": \"172.1.1.1\",\n \"DbPrivilege\": \"DDL\"\n }\n ],\n \"Description\": \"tomuse\"\n}",
103
127
  "output": "{\n \"Response\": {\n \"RequestId\": \"f569bea2-0a51-11ec-af61-525400542aa6\"\n }\n}",
104
- "title": "Creating a database"
128
+ "title": "Create a Database"
105
129
  }
106
130
  ],
107
131
  "CreateClusters": [
108
132
  {
109
- "document": "This example shows you how to create a cluster.",
110
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateClusters\n<Common request parameters>\n\n{\n \"Count\": 1,\n \"StoragePayMode\": \"0\",\n \"VpcId\": \"vpc-1ptuei0b\",\n \"Zone\": \"ap-guangzhou-3\",\n \"AdminPassword\": \"passwd@admin\",\n \"DbType\": \"MYSQL\",\n \"ProjectId\": \"0\",\n \"DbVersion\": \"10.0\",\n \"Storage\": 100,\n \"PayMode\": \"0\",\n \"ClusterName\": \"newInstance\",\n \"StorageLimit\": \"100\",\n \"RollbackStrategy\": \"noneRollback\",\n \"Memory\": \"4\",\n \"SubnetId\": \"subnet-1tmw9t4o\",\n \"Cpu\": 2,\n \"HaCount\": \"1\"\n}",
111
- "output": "{\n \"Response\": {\n \"ResourceIds\": [\n \"cynosdbmysql-ins-67rmucgk\"\n ],\n \"RequestId\": \"132075\",\n \"TranId\": \"20190522160000003106844584180998\",\n \"ClusterIds\": [\n \"cynosdbmysql-sls-9nts65r2\"\n ],\n \"BigDealIds\": [\n \"xxx\"\n ],\n \"DealNames\": [\n \"20190522112283\"\n ]\n }\n}",
112
- "title": "Creating a cluster"
133
+ "document": "This example shows you how to purchase a new cluster.",
134
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateClusters\n<Common request parameters>\n\n{\n \"Count\": \"1\",\n \"StoragePayMode\": \"0\",\n \"VpcId\": \"vpc-1ptuei0b\",\n \"Zone\": \"ap-guangzhou-3\",\n \"AdminPassword\": \"passwd@admin\",\n \"DbType\": \"MYSQL\",\n \"ProjectId\": \"0\",\n \"DbVersion\": \"10.0\",\n \"Storage\": \"100\",\n \"PayMode\": \"0\",\n \"ClusterName\": \"newInstance\",\n \"StorageLimit\": \"100\",\n \"RollbackStrategy\": \"noneRollback\",\n \"Memory\": \"4\",\n \"SubnetId\": \"subnet-1tmw9t4o\",\n \"Cpu\": \"2\",\n \"HaCount\": \"1\"\n}",
135
+ "output": "{\n \"Response\": {\n \"ResourceIds\": [\n \"cynosdbmysql-ins-67rmucgk\"\n ],\n \"RequestId\": \"132075\",\n \"TranId\": \"20190522160000003106844584180998\",\n \"ClusterIds\": [\n \"cynosdbmysql-sls-9nts65r2\"\n ],\n \"BigDealIds\": [\n \"142759\"\n ],\n \"DealNames\": [\n \"20190522112283\"\n ]\n }\n}",
136
+ "title": "Purchasing a New Cluster"
137
+ }
138
+ ],
139
+ "CreateIntegrateCluster": [
140
+ {
141
+ "document": "Create Integrate Cluster",
142
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateIntegrateCluster\n<Common request parameters>\n\n{\n \"DbVersion\": \"8.0\",\n \"InstanceInitInfos\": [\n {\n \"Cpu\": 1,\n \"DeviceType\": \"common\",\n \"InstanceCount\": 1,\n \"InstanceType\": \"rw\",\n \"Memory\": 2\n }\n ],\n \"IntegrateCreateClusterConfig\": {\n \"BackupSaveDays\": 7,\n \"BinlogSaveDays\": 8,\n \"SemiSyncTimeout\": 1000\n },\n \"SubnetId\": \"subnet-3du8lpau\",\n \"VpcId\": \"vpc-r2dqqiyv\",\n \"Zone\": \"ap-guangzhou-4\"\n}",
143
+ "output": "{\n \"Response\": {\n \"BigDealIds\": [],\n \"ClusterIds\": [],\n \"DealNames\": [\n \"20250909448021542853581\"\n ],\n \"RequestId\": \"081ec9cb-d476-4202-8943-966e1e552e3f\",\n \"ResourceIds\": [],\n \"TranId\": \"20250909448021542853591\"\n }\n}",
144
+ "title": "Creating an Integrated Cluster"
113
145
  }
114
146
  ],
115
147
  "CreateParamTemplate": [
116
148
  {
117
- "document": "This example shows you how to create a parameter template",
118
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateClusterDatabase<common request parameters>{ \"UserHostPrivileges\": [ { \"DbUserName\": \"common template\", \"EngineVersion\": \"5.7\", \"TemplateId\": \"93\", \"TemplateName\": \"v5.7 common parameter template\"}",
149
+ "document": "This example shows you how to create a parameter template.",
150
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateParamTemplate\n<Common request parameters>\n\n{\n\"TemplateDescription\": \"Common template\"\n \"EngineVersion\": \"5.7\",\n \"TemplateId\": 93,\n\"TemplateName\": \"Common Parameter Template for 5.7\"\n}",
119
151
  "output": "{\n \"Response\": {\n \"RequestId\": \"b7735dc6-5847-4c9b-a713-9745f9afda34\",\n \"TemplateId\": 95\n }\n}",
120
- "title": "Creating a parameter template"
152
+ "title": "Create a Parameter Template"
121
153
  },
122
154
  {
123
- "document": "This example shows you how to customize a parameter template.",
124
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateParamTemplate<common request parameters>{ \"TemplateDescription\": \"API test\", \"EngineVersion\": \"5.7\", \"TemplateId\": \"0\", \"DbMode\": \"NORMAL\", \"TemplateName\": \"API test",
155
+ "document": "Creating a custom parameter template",
156
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateParamTemplate\n<Common request parameters>\n\n{\n\"TemplateDescription\": \"API testing\"\n \"EngineVersion\": \"5.7\",\n \"TemplateId\": 100,\n \"DbMode\": \"NORMAL\",\n\"TemplateName\": \"API Testing\"\n}",
125
157
  "output": "{\n \"Response\": {\n \"RequestId\": \"edbd6b65-daf0-4ca8-b34f-cc3fd42790d8\",\n \"TemplateId\": 27\n }\n}",
126
- "title": "Customizing a parameter template"
158
+ "title": "Custom Parameter Template"
127
159
  }
128
160
  ],
129
161
  "CreateProxy": [
130
162
  {
131
163
  "document": "This example shows you how to create a database proxy.",
132
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"abc\",\n \"UniqueVpcId\": \"abc\",\n \"UniqueSubnetId\": \"abc\",\n \"ProxyCount\": 0,\n \"Cpu\": 0,\n \"Mem\": 0,\n \"ConnectionPoolType\": \"abc\",\n \"OpenConnectionPool\": \"abc\",\n \"ConnectionPoolTimeOut\": 0,\n \"SecurityGroupIds\": [\n \"abc\"\n ],\n \"Description\": \"abc\",\n \"ProxyZones\": [\n {\n \"ProxyNodeZone\": \"abc\",\n \"ProxyNodeCount\": 0\n }\n ]\n}",
133
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"RequestId\": \"abc\"\n }\n}",
134
- "title": "Creating a database proxy"
164
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg7212w\",\n \"UniqueVpcId\": \"vpc-4pbgo2lk\",\n \"UniqueSubnetId\": \"subnet-a2emqn1t\",\n \"ProxyCount\": 2,\n \"Cpu\": 2,\n \"Mem\": 4000,\n \"ConnectionPoolType\": \"SessionConnectionPool\",\n \"OpenConnectionPool\": \"yes\",\n \"ConnectionPoolTimeOut\": 0,\n \"SecurityGroupIds\": [\n \"sg-qwaszx\"\n ],\n \"Description\": \"Fill in the description\",\n \"ProxyZones\": [\n {\n \"ProxyNodeZone\": \"ap-beijing-6\",\n \"ProxyNodeCount\": 2\n }\n ]\n}",
165
+ "output": "{\n \"Response\": {\n \"FlowId\": 358874,\n \"TaskId\": 1063084,\n \"RequestId\": \"a88257ed-174e-499c-b390-dc535e664b94\"\n }\n}",
166
+ "title": "Database Proxy Creation"
135
167
  }
136
168
  ],
137
169
  "CreateProxyEndPoint": [
138
170
  {
139
- "document": "This example shows you how to create a database proxy connection.",
140
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxyEndPoint\n<Common request parameters>\n\n{\n \"ClusterId\": \"abc\",\n \"UniqueVpcId\": \"abc\",\n \"UniqueSubnetId\": \"abc\",\n \"ConnectionPoolType\": \"abc\",\n \"OpenConnectionPool\": \"abc\",\n \"ConnectionPoolTimeOut\": 0,\n \"SecurityGroupIds\": [\n \"abc\"\n ],\n \"Description\": \"abc\",\n \"Vip\": \"abc\",\n \"WeightMode\": \"abc\",\n \"AutoAddRo\": \"abc\",\n \"FailOver\": \"abc\",\n \"ConsistencyType\": \"abc\",\n \"RwType\": \"abc\",\n \"ConsistencyTimeOut\": 0,\n \"TransSplit\": true,\n \"AccessMode\": \"abc\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"abc\",\n \"Weight\": 0\n }\n ]\n}",
141
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"ProxyGroupId\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
142
- "title": "Creating a database proxy connection"
171
+ "document": "This example shows you how to create a database proxy connection point.",
172
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateProxyEndPoint\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-dnofdr2d\",\n \"UniqueVpcId\": \"vpc-azx\",\n \"UniqueSubnetId\": \"subnet-qwe\",\n \"ConnectionPoolType\": \"SessionConnectionPool\",\n \"OpenConnectionPool\": \"yes\",\n \"ConnectionPoolTimeOut\": 0,\n \"SecurityGroupIds\": [\n \"sg-dtwhs6\"\n ],\n \"Description\": \"tomnode1\",\n \"Vip\": \"1.1.1.1\",\n \"WeightMode\": \"system\",\n \"AutoAddRo\": \"yes\",\n \"FailOver\": \"\",\n \"ConsistencyType\": \"eventual\",\n \"RwType\": \"READWRITE\",\n \"ConsistencyTimeOut\": 0,\n \"TransSplit\": true,\n \"AccessMode\": \"nearby\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"cynosdbmysql-ins-c2twj0qf\",\n \"Weight\": 0\n }\n ]\n}",
173
+ "output": "{\n \"Response\": {\n \"FlowId\": 146737,\n \"TaskId\": 187463,\n \"ProxyGroupId\": \"cynosdbmysql-proxy-4378e0kd\",\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
174
+ "title": "Create a Database Proxy Connection Point"
143
175
  }
144
176
  ],
145
177
  "CreateResourcePackage": [
@@ -152,18 +184,18 @@
152
184
  ],
153
185
  "DeleteAccounts": [
154
186
  {
155
- "document": " ",
156
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DeleteAccounts&ClusterId=cynosdbmysql-ixgbd0di&Accounts.0.AccountName=admin&Accounts.0.Host=myHost&<common request parameters>",
187
+ "document": "",
188
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=DeleteAccounts\n&ClusterId=cynosdbmysql-ixgbd0di\n&Accounts.0.AccountName=admin\n&Accounts.0.Host=myHost\n&<common request parameters>",
157
189
  "output": "{\n \"Response\": {\n \"RequestId\": \"120440\"\n }\n}",
158
- "title": "Deleting an account"
190
+ "title": ""
159
191
  }
160
192
  ],
161
193
  "DeleteAuditRuleTemplates": [
162
194
  {
163
- "document": " ",
164
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAuditRuleTemplates\n<Common request parameters>\n\n{\n \"RuleTemplateIds\": [\n \"cynosdb-rt-ws23fwu8\"\n ]\n}",
195
+ "document": "",
196
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAuditRuleTemplates\n<common request parameters>\n\n{\n \"RuleTemplateIds\": [\n \"cynosdb-rt-ws23fwu8\"\n ]\n}",
165
197
  "output": "{\n \"Response\": {\n \"RequestId\": \"43-12121-812w1221213-62usf9093\"\n }\n}",
166
- "title": "Deleting an audit rule template"
198
+ "title": ""
167
199
  }
168
200
  ],
169
201
  "DeleteBackup": [
@@ -174,84 +206,124 @@
174
206
  "title": "Deleting a backup"
175
207
  }
176
208
  ],
209
+ "DeleteCLSDelivery": [
210
+ {
211
+ "document": "",
212
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteCLSDelivery\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"CLSTopicIds\": [\n \"83dc6703-f43a-4b95-92ec-267bdf9e48c3\",\n \"2a289122-0b01-490b-be75-763da79621fe\"\n ]\n}",
213
+ "output": "{\n \"Response\": {\n \"TaskId\": 176382,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}",
214
+ "title": "Delete Log Delivery"
215
+ }
216
+ ],
177
217
  "DeleteClusterDatabase": [
178
218
  {
179
219
  "document": " ",
180
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DeleteClusterDatabase<common request parameters>{ \"DbNames\": [ \"test\" ], \"ClusterId\": \"cynosdbmysql-xxxxxx\"}",
220
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteClusterDatabase\n<Common request parameters>\n\n{\n \"DbNames\": [\n \"db1\"\n ],\n \"ClusterId\": \"cynosdbmysql-j9i41hfv\"\n}",
181
221
  "output": "{\n \"Response\": {\n \"RequestId\": \"f569bea2-0a51-11ec-af61-525400542aa6\"\n }\n}",
182
- "title": "Creating a database"
222
+ "title": "Create a Database"
183
223
  }
184
224
  ],
185
225
  "DeleteParamTemplate": [
186
226
  {
187
- "document": "This example shows you how to delete a parameter template.",
188
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DeleteParamTemplate<common request parameters>{ \"TemplateId\": \"93\"}",
227
+ "document": "This API is used to delete a parameter template.",
228
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteParamTemplate\n<Common request parameters>\n\n{\n \"TemplateId\": 93\n}",
189
229
  "output": "{\n \"Response\": {\n \"RequestId\": \"855d70ae-2815-4311-a42e-75a41ee0af8b\"\n }\n}",
190
- "title": "Deleting a parameter template"
230
+ "title": "This API is used to delete a parameter template."
191
231
  }
192
232
  ],
193
233
  "DescribeAccountPrivileges": [
194
234
  {
195
- "document": " ",
196
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>",
235
+ "document": "This example shows you how to query the permissions of an account.",
236
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccountPrivileges\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxx\",\n \"AccountName\": \"andy\",\n \"Host\": \"1.1.1.1\",\n \"Db\": \"Db1\",\n \"Type\": \"table\",\n \"TableName\": \"Table1\"\n}",
197
237
  "output": "{\n \"Response\": {\n \"Privileges\": [\n \"select\",\n \"update\",\n \"delete\",\n \"create\",\n \"drop\",\n \"references\",\n \"index\",\n \"alter\",\n \"show_db\",\n \"create_tmp_table\",\n \"lock_tables\",\n \"execute\",\n \"create_view\",\n \"show_view\",\n \"create_routine\",\n \"alter_routine\",\n \"event\",\n \"trigger\"\n ],\n \"RequestId\": \"167350\"\n }\n}",
198
- "title": "Querying the existing permissions of an account"
238
+ "title": "Query the Permissions of an Account"
199
239
  }
200
240
  ],
201
241
  "DescribeAccounts": [
202
242
  {
203
- "document": "This example shows you how to query a database management account.",
243
+ "document": "This example shows you how to query the database account list.",
204
244
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAccounts\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbysql-on5xw0ni\"\n}",
205
- "output": "{\n \"Response\": {\n \"AccountSet\": [\n {\n \"AccountName\": \"abc\",\n \"Description\": \"abc\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"Host\": \"abc\",\n \"MaxUserConnections\": 0\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"abc\"\n }\n}",
206
- "title": "Querying a database management account"
245
+ "output": "{\n \"Response\": {\n \"AccountSet\": [\n {\n \"AccountName\": \"tom\",\n \"Description\": \"AccountDescription\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"Host\": \"%\",\n \"MaxUserConnections\": 0\n }\n ],\n \"TotalCount\": 0,\n \"RequestId\": \"e4f4f48a-51b1-45be-a9e3-09f0d1412659\"\n }\n}",
246
+ "title": "Query a Database Account List"
247
+ }
248
+ ],
249
+ "DescribeAuditInstanceList": [
250
+ {
251
+ "document": "This example shows you how to retrieve the audit instance list.",
252
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuditInstanceList\n<Common request parameters>\n\n{\n \"AuditMode\": 0,\n \"Limit\": 1,\n \"Filters\": [\n {\n \"Values\": [\n \"cynosdbmysql-ins-6990cckk\"\n ],\n \"Name\": \"InstanceId\",\n \"ExactMatch\": true\n }\n ],\n \"AuditSwitch\": 0,\n \"Offset\": 1\n}",
253
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"43-12121-812w1221213-62usf9093\",\n \"Items\": [\n {\n \"RealStorage\": 0,\n \"BillingAmount\": 0,\n \"LowRealStorage\": 0,\n \"InstanceId\": \"cynosdbmysql-ins-6990cckk\",\n \"CreateAt\": \"2022-03-02 10:09:08\",\n \"AuditStatus\": \"1\",\n \"LogExpireDay\": 1,\n \"AuditAll\": true,\n \"InstanceInfo\": {\n \"ProjectId\": 0,\n \"TagList\": [\n {\n \"TagKey\": \"name\",\n \"TagValue\": \"zhang\"\n }\n ]\n },\n \"HighRealStorage\": 0,\n \"HighLogExpireDay\": 30,\n \"LowLogExpireDay\": 7\n }\n ]\n }\n}",
254
+ "title": "Retrieve the Audit Instance List"
207
255
  }
208
256
  ],
209
257
  "DescribeAuditRuleTemplates": [
210
258
  {
211
- "document": " ",
259
+ "document": "This example shows you how to query audit rule template information.",
212
260
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuditRuleTemplates\n<Common request parameters>\n\n{\n \"RuleTemplateNames\": [\n \"template_test\"\n ],\n \"Limit\": 10,\n \"Offset\": 0\n}",
213
- "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"CreateAt\": \"2022-12-06 00:54:01\",\n \"Description\": \"all_template_des\",\n \"RuleFilters\": [\n {\n \"Compare\": \"INC\",\n \"Type\": \"sqlType\",\n \"Value\": [\n \"ALTER\"\n ]\n },\n {\n \"Compare\": \"EQS\",\n \"Type\": \"host\",\n \"Value\": [\n \"10.0.0.2\"\n ]\n },\n {\n \"Compare\": \"NEQ\",\n \"Type\": \"user\",\n \"Value\": [\n \"test\"\n ]\n },\n {\n \"Compare\": \"INC\",\n \"Type\": \"dbName\",\n \"Value\": [\n \"test\"\n ]\n }\n ],\n \"RuleTemplateId\": \"cynosdb-art-lcpm4as3\",\n \"RuleTemplateName\": \"template_test\"\n }\n ],\n \"RequestId\": \"a19ebcfb-8b35-40f4-85ee-383109c9134b\",\n \"TotalCount\": 1\n }\n}",
214
- "title": "Querying audit rule templates"
261
+ "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"CreateAt\": \"2022-12-06 00:54:01\",\n \"Description\": \"all_template_des\",\n \"RuleFilters\": [\n {\n \"Compare\": \"INC\",\n \"Type\": \"sqlType\",\n \"Value\": [\n \"ALTER\"\n ]\n },\n {\n \"Compare\": \"EQS\",\n \"Type\": \"host\",\n \"Value\": [\n \"10.0.0.2\"\n ]\n },\n {\n \"Compare\": \"NEQ\",\n \"Type\": \"user\",\n \"Value\": [\n \"andy\"\n ]\n },\n {\n \"Compare\": \"INC\",\n \"Type\": \"dbName\",\n \"Value\": [\n \"db1\"\n ]\n }\n ],\n \"RuleTemplateId\": \"cynosdb-art-lcpm4as3\",\n \"RuleTemplateName\": \"template_test\"\n }\n ],\n \"RequestId\": \"a19ebcfb-8b35-40f4-85ee-383109c9134b\",\n \"TotalCount\": 1\n }\n}",
262
+ "title": "Query Audit Rule Template Information"
215
263
  }
216
264
  ],
217
265
  "DescribeAuditRuleWithInstanceIds": [
218
266
  {
219
267
  "document": " ",
220
268
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuditRuleWithInstanceIds\n<Common request parameters>\n\n{\n \"InstanceIds\": [\n \"cynosdbmysql-ins-6990cckk\"\n ]\n}",
221
- "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"AuditRule\": true,\n \"AuditRuleFilters\": [\n {\n \"RuleFilters\": [\n {\n \"Compare\": \"INC\",\n \"Type\": \"sql\",\n \"Value\": [\n \"select\"\n ]\n },\n {\n \"Compare\": \"EQS\",\n \"Type\": \"dbName\",\n \"Value\": [\n \"testdb\"\n ]\n }\n ]\n }\n ],\n \"InstanceId\": \"cynosdbmysql-ins-6990cckk\"\n }\n ],\n \"RequestId\": \"a94950e4-7929-493d-97a6-4cd59dba466e\",\n \"TotalCount\": 1\n }\n}",
222
- "title": "Getting the audit rule templates of an instance"
269
+ "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"AuditRule\": true,\n \"AuditRuleFilters\": [\n {\n \"RuleFilters\": [\n {\n \"Compare\": \"INC\",\n \"Type\": \"sql\",\n \"Value\": [\n \"select\"\n ]\n },\n {\n \"Compare\": \"EQS\",\n \"Type\": \"dbName\",\n \"Value\": [\n \"db1\"\n ]\n }\n ]\n }\n ],\n \"InstanceId\": \"cynosdbmysql-ins-6990cckk\"\n }\n ],\n \"RequestId\": \"a94950e4-7929-493d-97a6-4cd59dba466e\",\n \"TotalCount\": 1\n }\n}",
270
+ "title": "Retrieve the Audit Rules of the Instance"
223
271
  }
224
272
  ],
225
273
  "DescribeBackupConfig": [
226
274
  {
227
- "document": " ",
228
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeBackupConfig\n&ClusterId=cynosdbmysql-45knmnra\n&<Common request parameters>",
229
- "output": "{\n \"Response\": {\n \"BackupFreq\": [\n \"full\",\n \"increment\",\n \"increment\",\n \"increment\",\n \"increment\",\n \"increment\",\n \"increment\"\n ],\n \"BackupType\": \"\",\n \"BackupTimeEnd\": 21600,\n \"BackupTimeBeg\": 7200,\n \"RequestId\": \"180877\",\n \"ReserveDuration\": 604800\n }\n}",
230
- "title": "Querying the backup configuration information"
275
+ "document": "Describe Backup Config",
276
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupConfig\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-aws1kpv6\"\n}",
277
+ "output": "{\n \"Response\": {\n \"BackupFreq\": [\n \"full\",\n \"full\",\n \"full\",\n \"full\",\n \"full\",\n \"full\",\n \"full\"\n ],\n \"BackupTimeBeg\": 7200,\n \"BackupTimeEnd\": 21600,\n \"BackupType\": \"snapshot\",\n \"LogicBackupConfig\": {\n \"LogicBackupEnable\": \"OFF\",\n \"LogicBackupTimeBeg\": 0,\n \"LogicBackupTimeEnd\": 0,\n \"LogicCrossRegions\": null,\n \"LogicCrossRegionsEnable\": \"\",\n \"LogicReserveDuration\": 0\n },\n \"LogicCrossRegionsConfigUpdateTime\": \"\",\n \"RequestId\": \"e0127059-bb40-4308-a67d-c3bcddba372e\",\n \"ReserveDuration\": 604800\n }\n}",
278
+ "title": ""
279
+ }
280
+ ],
281
+ "DescribeBackupDownloadRestriction": [
282
+ {
283
+ "document": "This example shows you how to query the backup download limit.",
284
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadRestriction\n<Common request parameters>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-2p3wjmzt\"\n ]\n}",
285
+ "output": "{\n \"Response\": {\n \"BackupLimitClusterRestrictions\": [\n {\n \"BackupLimitRestriction\": {\n \"IpComparisonSymbol\": \"In\",\n \"LimitIps\": [],\n \"LimitType\": \"Customize\",\n \"LimitVpcs\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"VpcList\": []\n }\n ],\n \"VpcComparisonSymbol\": \"In\"\n },\n \"ClusterId\": \"cynosdbmysql-2p3wjmzt\"\n }\n ],\n \"RequestId\": \"36eca298-c9b7-4e13-8f33-3c07926ee0d8\"\n }\n}",
286
+ "title": "Query Backup Download Limit"
231
287
  }
232
288
  ],
233
289
  "DescribeBackupDownloadUrl": [
234
290
  {
235
291
  "document": " ",
236
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadUrl\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"BackupId\": 1000\n}",
237
- "output": "{\n \"Response\": {\n \"DownloadUrl\": \"xxxx\",\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
238
- "title": "Querying the download address of a cluster backup file"
292
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadUrl\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-dnofdr2d\",\n \"BackupId\": 1879681\n}",
293
+ "output": "{\n \"Response\": {\n \"DownloadUrl\": \"https://ncdb-bj-pitr-1258***699.cos.ap-beijing.myqcloud.com/cynosdb/data/mysqldump/****9fd2-691a-11ef-b99a-b02628437590/2024-10-28/1879681/data_backup_1879681_20241028022147.xb?q-sign-algorithm=sha1&q-ak=************&q-sign-time=1730079993%3B1730123193&q-key-time=1730079993%3B1730123193&q-header-list=host&q-url-param-list=&q-signature=*****************\",\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
294
+ "title": "Query the Download Address of a Cluster Backup File"
295
+ }
296
+ ],
297
+ "DescribeBackupDownloadUserRestriction": [
298
+ {
299
+ "document": "Default backup download source restrictions for user-level settings in the current region",
300
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupDownloadUserRestriction\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Offset\": 0,\n \"OnlyUserRestriction\": false\n}",
301
+ "output": "{\n \"Response\": {\n \"BackupLimitClusterRestrictions\": [\n {\n \"BackupLimitRestriction\": {\n \"IpComparisonSymbol\": \"In\",\n \"LimitIps\": [],\n \"LimitType\": \"Customize\",\n \"LimitVpcs\": [\n {\n \"Region\": \"ap-guangzhou\",\n \"VpcList\": []\n }\n ],\n \"VpcComparisonSymbol\": \"In\"\n },\n \"ClusterId\": \"cynosdbmysql-2p3wjmzt\"\n }\n ],\n \"RequestId\": \"36eca298-c9b7-4e13-8f33-3c07926ee0d8\"\n }\n}",
302
+ "title": "Default Backup Download Source Limit for User-Level Settings in the Current Region"
239
303
  }
240
304
  ],
241
305
  "DescribeBackupList": [
242
306
  {
243
- "document": " ",
244
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupList\n<Common request parameters>\n\n{\n \"Limit\": 10,\n \"ClusterId\": \"cynosdbpg-ilgo90hu\",\n \"Offset\": \"0\"\n}",
245
- "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"BackupList\": [\n {\n \"SnapshotId\": 10000,\n \"SnapshotTime\": \"xx\",\n \"FileName\": \"snap\",\n \"FileSize\": 20190215,\n \"StartTime\": \"2019-01-20 01:10:12\",\n \"FinishTime\": \"2019-01-20 02:10:12\",\n \"BackupType\": \"snapshot\",\n \"BackupMethod\": \"auto\",\n \"BackupStatus\": \"success\",\n \"SnapShotType\": \"full\",\n \"BackupName\": \"desc123\",\n \"BackupId\": 100\n }\n ],\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
246
- "title": "Querying the backup file list"
307
+ "document": "Queries the backup file list",
308
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupList\n<Common request parameters>\n\n{\n \"Limit\": 2,\n \"ClusterId\": \"cynosdbmysql-ck8fmktd\",\n \"Offset\": 0\n}",
309
+ "output": "{\n \"Response\": {\n \"BackupList\": [\n {\n \"BackupId\": 1880312,\n \"BackupMethod\": \"auto\",\n \"BackupName\": \"\",\n \"BackupStatus\": \"success\",\n \"BackupType\": \"snapshot\",\n \"FileName\": \"jia_20241028040005\",\n \"FileSize\": 10426,\n \"FinishTime\": \"2024-10-28 04:02:34\",\n \"SnapShotType\": \"increment\",\n \"SnapshotId\": 1880312,\n \"SnapshotTime\": \"2024-10-28 04:00:04\",\n \"StartTime\": \"2024-10-28 04:02:14\"\n },\n {\n \"BackupId\": 1879681,\n \"BackupMethod\": \"auto\",\n \"BackupName\": \"\",\n \"BackupStatus\": \"success\",\n \"BackupType\": \"logic\",\n \"FileName\": \"jia_20241028022147\",\n \"FileSize\": 1684666,\n \"FinishTime\": \"2024-10-28 02:22:24\",\n \"SnapShotType\": \"full\",\n \"SnapshotId\": 1879681,\n \"SnapshotTime\": \"2024-10-28 02:21:47\",\n \"StartTime\": \"2024-10-28 02:21:47\"\n }\n ],\n \"RequestId\": \"1f2f4b1e-424d-4740-9b26-d947e957780e\",\n \"TotalCount\": 40\n }\n}",
310
+ "title": "Queries the backup file list"
311
+ }
312
+ ],
313
+ "DescribeBinlogConfig": [
314
+ {
315
+ "document": "Query binlog configuration information",
316
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBinlogConfig\n<Common request parameters>\n\n{\n \"ClusterId\": \"DescribeBinlogConffv\"\n}",
317
+ "output": "{\n \"Response\": {\n \"BinlogConfig\": {\n \"BinlogCrossRegions\": [\n \"ap-guangzhou\"\n ],\n \"BinlogCrossRegionsEnable\": \"ON\",\n \"BinlogSaveDays\": 7\n },\n \"BinlogCrossRegionsConfigUpdateTime\": \"2024-12-23 19:27:09\",\n \"RequestId\": \"e01e2fd6-10bc-45a0-b715-0d29a5fb317d\"\n }\n}",
318
+ "title": "Query binlog Configuration Message"
247
319
  }
248
320
  ],
249
321
  "DescribeBinlogDownloadUrl": [
250
322
  {
251
- "document": " ",
252
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBinlogDownloadUrl\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"BinlogId\": 1000\n}",
253
- "output": "{\n \"Response\": {\n \"DownloadUrl\": \"xxxx\",\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
254
- "title": "Querying the download address of a binlog"
323
+ "document": "",
324
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBinlogDownloadUrl\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-ck8fmktd\",\n \"BinlogId\": 3364561\n}",
325
+ "output": "{\n \"Response\": {\n \"DownloadUrl\": \"https://ncdb-cdc-bj-1258***699.cos.ap-beijing.myqcloud.com/cynosdb/cdc/BinlogCapture/71***d45-8cfd-11ef-b99a-b02628437590/29.18.12.168_20650_1/mysql-bin.001002/file?q-sign-algorithm=sha1&q-ak=**************&q-sign-time=17300***57%3B1730123657&q-key-time=17300***57%3B1730123657&q-header-list=host&q-url-param-list=&q-signature=**************\",\n \"RequestId\": \"e3159885-b774-40c5-bacb-5d99f2ad1c2c\"\n }\n}",
326
+ "title": "Query the Download Address of Binlog"
255
327
  }
256
328
  ],
257
329
  "DescribeBinlogSaveDays": [
@@ -263,75 +335,123 @@
263
335
  }
264
336
  ],
265
337
  "DescribeBinlogs": [
338
+ {
339
+ "document": "",
340
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBinlogs\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg7122d\",\n \"StartTime\": \"2024-10-18 11:03:02\",\n \"EndTime\": \"2024-10-25 17:24:50\",\n \"Limit\": 2,\n \"Offset\": 0\n}",
341
+ "output": "{\n \"Response\": {\n \"Binlogs\": [\n {\n \"BinlogId\": 3364561,\n \"FileName\": \"1_mysql-bin.00**02\",\n \"FileSize\": 815,\n \"FinishTime\": \"2024-10-25 17:24:50\",\n \"StartTime\": \"2024-10-18 11:03:02\"\n }\n ],\n \"RequestId\": \"9052ff42-8a95-4095-8457-9346eb09dc1a\",\n \"TotalCount\": 1\n }\n}",
342
+ "title": "Query the Binlog Log List of a Cluster"
343
+ }
344
+ ],
345
+ "DescribeChangedParamsAfterUpgrade": [
346
+ {
347
+ "document": "This example shows you how to query comparison results of running parameters during specification adjustment.",
348
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeChangedParamsAfterUpgrade\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-p8dst5v9\",\n \"DstCpu\": 1,\n \"DstMem\": 1\n}",
349
+ "output": "{\n \"Response\": {\n \"RequestId\": \"7613eed6-5eb5-4d17-ae69-dd93c44d7ad4\",\n \"TotalCount\": 1,\n \"Items\": [\n {\n \"ParamName\": \"demoString\",\n \"NewValue\": \"demoString\",\n \"OldValue\": \"demoString\",\n \"ValueFunction\": \"demoString\"\n }\n ]\n }\n}",
350
+ "title": "Querying Comparison Results of Running Parameters During Specification Adjustment"
351
+ }
352
+ ],
353
+ "DescribeClusterDatabaseTables": [
266
354
  {
267
355
  "document": " ",
268
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBinlogs\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxxx\",\n \"StartTime\": \"2022-01-01 00:00:00\",\n \"EndTime\": \"2022-01-01 23:59:59\",\n \"Limit\": 100,\n \"Offset\": 100\n}",
269
- "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"RequestId\": \"xx\",\n \"Binlogs\": [\n {\n \"BinlogId\": 10782259,\n \"FileName\": \"00000002_0010782259_mysql-bin.001002\",\n \"FileSize\": 479,\n \"FinishTime\": \"2022-06-16 18:36:14\",\n \"StartTime\": \"2022-06-15 17:19:19\"\n }\n ]\n }\n}",
270
- "title": "Querying the list of binlogs in a cluster"
356
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDatabaseTables\n<Common request parameters>\n\n{\n \"Db\": \"db1\",\n \"ClusterId\": \"cynosdbmysql-grhvkwfv\"\n}",
357
+ "output": "{\n \"Response\": {\n \"Tables\": [\n \"testtable\"\n ],\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"198189\",\n \"TotalCount\": 1\n }\n}",
358
+ "title": "Access the table List"
359
+ }
360
+ ],
361
+ "DescribeClusterDatabases": [
362
+ {
363
+ "document": "",
364
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDatabases\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-tsjwe7iu\"\n}",
365
+ "output": "{\n \"Response\": {\n \"TotalCount\": 3,\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"806fe1c8-5567-4aa8-a521-ea2414c793b4\",\n \"Databases\": [\n \"database_1\",\n \"database_2\"\n ]\n }\n}",
366
+ "title": "Retrieve a Cluster Database List"
271
367
  }
272
368
  ],
273
369
  "DescribeClusterDetail": [
274
370
  {
275
- "document": "This example shows you how to obtain the cluster information description.",
276
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDetail\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdbpg-5804k48e\"\n}",
277
- "output": "{\n \"Response\": {\n \"Detail\": {\n \"Ability\": {\n \"IsSupportRo\": \"yes\",\n \"IsSupportSlaveZone\": \"yes\",\n \"NonsupportRoReason\": \"aaabbbccc\",\n \"NonsupportSlaveZoneReason\": \"aaabbbccc\"\n },\n \"BusinessType\": \"\",\n \"Charset\": \"utf8mb4\",\n \"ClusterId\": \"cynosdbmysql-sgvwu2is\",\n \"ClusterName\": \"cynodbmysql-custom username\",\n \"CreateTime\": \"2020-02-20 20:20:20\",\n \"CynosVersion\": \"3.1.10\",\n \"DbMode\": \"normal\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"HasSlaveZone\": \"\",\n \"InstanceSet\": [\n {\n \"InstanceCpu\": 1,\n \"InstanceId\": \"cynosdbmysql-ins-xvs9osn2\",\n \"InstanceMemory\": 2,\n \"InstanceName\": \"cynosdbmysql-custom username\",\n \"InstanceRole\": \"master\",\n \"InstanceStatus\": \"running\",\n \"InstanceStatusDesc\": \"Running\",\n \"InstanceStorage\": 0,\n \"InstanceType\": \"rw\",\n \"MaintainDuration\": 0,\n \"MaintainStartTime\": 0,\n \"MaintainWeekDays\": [\n \"Mon\"\n ],\n \"ServerlessStatus\": \"pause\"\n }\n ],\n \"IsFreeze\": \"no\",\n \"IsOpenPasswordComplexity\": \"yes\",\n \"IsSkipTrade\": \"no\",\n \"LogBin\": \"ON\",\n \"MasterZone\": \"ap-guangzhou-5\",\n \"MaxStorageSize\": 1000,\n \"MinStorageSize\": 10,\n \"NetworkStatus\": \"whole_rdma\",\n \"NetworkType\": \"whole_rdma\",\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2030-01-01 10:01:01\",\n \"PhysicalZone\": \"ap-guangzhou-1\",\n \"PitrType\": \"redo_pitr\",\n \"ProjectID\": 0,\n \"ProxyStatus\": \"running\",\n \"Region\": \"ap-guangzhou\",\n \"RenewFlag\": 0,\n \"ResourcePackages\": [\n {\n \"PackageId\": \"package-xbhsw7wk\",\n \"PackageType\": \"CCU\"\n }\n ],\n \"ResourceTags\": [\n {\n \"TagKey\": \"tagKey-1\",\n \"TagValue\": \"tagValue-1\"\n }\n ],\n \"RoAddr\": [\n {\n \"IP\": \"1.2.3.5\",\n \"Port\": 3306\n }\n ],\n \"ServerlessStatus\": \"Running\",\n \"SlaveZoneAttr\": [\n {\n \"BinlogSyncWay\": \"async\",\n \"Zone\": \"ap-guangzhou-3\"\n }\n ],\n \"SlaveZones\": [\n \"ap-guangzhou-3\"\n ],\n \"Status\": \"running\",\n \"StatusDesc\": \"Running\",\n \"Storage\": 20,\n \"StorageId\": \"cynosdbmysql-sgvwu2is\",\n \"StorageLimit\": 20,\n \"StoragePayMode\": 0,\n \"SubnetId\": \"subnet-stbcji8s\",\n \"SubnetName\": \"subnet-stbcji8s\",\n \"Tasks\": [\n {\n \"ObjectId\": \"cynosdbmysql-sgvwu2is\",\n \"ObjectType\": \"taskObjTypeCluster\",\n \"TaskId\": 10,\n \"TaskStatus\": \"processing\",\n \"TaskType\": \"taskAutoBackup\"\n }\n ],\n \"UsedStorage\": 14,\n \"Vip\": \"1.2.3.4\",\n \"VpcId\": \"vpc-osjw7wbx\",\n \"VpcName\": \"vpc-osjw7wbx\",\n \"Vport\": 3306,\n \"Zone\": \"ap-guangzhou-1\"\n },\n \"RequestId\": \"6febb6f0-b0fc-11ee-93cb-73a07daf38c5\"\n }\n}",
371
+ "document": "This example shows you how to describe cluster information.",
372
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDetail\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbpg-5804k48e\"\n}",
373
+ "output": "{\n \"Response\": {\n \"Detail\": {\n \"ClusterId\": \"cynosdbmysql-sgvwu2is\",\n\"ClusterName\": \"cynodbmysql-custom user\"\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-1\",\n \"PhysicalZone\": \"ap-guangzhou-1\",\n \"Status\": \"running\",\n\"StatusDesc\": \"Running\"\n\"ServerlessStatus\": \"running\"\n \"StorageId\": \"cynosdbmysql-sgvwu2is\",\n \"Storage\": 20,\n \"MaxStorageSize\": 1000,\n \"MinStorageSize\": 10,\n \"StoragePayMode\": 0,\n \"VpcName\": \"vpc-osjw7wbx\",\n \"VpcId\": \"vpc-osjw7wbx\",\n \"SubnetName\": \"subnet-stbcji8s\",\n \"SubnetId\": \"subnet-stbcji8s\",\n \"Charset\": \"utf8mb4\",\n \"CreateTime\": \"2020-02-20 20:20:20\",\n \"DbType\": \"MYSQL\",\n \"DbMode\": \"normal\",\n \"DbVersion\": \"5.7\",\n \"StorageLimit\": 20,\n \"UsedStorage\": 14,\n \"Vip\": \"1.2.3.4\",\n \"Vport\": 3306,\n \"RoAddr\": [\n {\n \"IP\": \"1.2.3.5\",\n \"Port\": 3306\n }\n ],\n \"Ability\": {\n \"IsSupportSlaveZone\": \"yes\",\n \"NonsupportSlaveZoneReason\": \"aaabbbccc\",\n \"IsSupportRo\": \"yes\",\n \"NonsupportRoReason\": \"aaabbbccc\",\n \"IsSupportManualSnapshot\": \"yes\"\n },\n \"CynosVersion\": \"3.1.10\",\n \"BusinessType\": \"\",\n \"HasSlaveZone\": \"\",\n \"IsFreeze\": \"no\",\n \"Tasks\": [\n {\n \"TaskId\": 10,\n \"TaskType\": \"taskAutoBackup\",\n \"TaskStatus\": \"processing\",\n \"ObjectId\": \"cynosdbmysql-sgvwu2is\",\n \"ObjectType\": \"taskObjTypeCluster\"\n }\n ],\n \"MasterZone\": \"ap-guangzhou-5\",\n \"SlaveZones\": [\n \"ap-guangzhou-3\"\n ],\n \"InstanceSet\": [\n {\n \"InstanceId\": \"cynosdbmysql-ins-xvs9osn2\",\n\"InstanceName\": \"cynosdbmysql-user-defined name\"\n \"InstanceType\": \"rw\",\n \"InstanceStatus\": \"running\",\n\"InstanceStatusDesc\": \"Running\"\n \"InstanceCpu\": 1,\n \"InstanceMemory\": 2,\n \"InstanceStorage\": 0,\n \"InstanceRole\": \"master\",\n \"MaintainStartTime\": 0,\n \"MaintainDuration\": 0,\n \"MaintainWeekDays\": [\n \"Mon\"\n ],\n \"ServerlessStatus\": \"pause\"\n }\n ],\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2030-01-01 10:01:01\",\n \"ProjectID\": 0,\n \"ResourceTags\": [\n {\n \"TagKey\": \"tagKey-1\",\n \"TagValue\": \"tagValue-1\"\n }\n ],\n \"ProxyStatus\": \"running\",\n \"LogBin\": \"ON\",\n \"IsSkipTrade\": \"no\",\n \"PitrType\": \"redo_pitr\",\n \"IsOpenPasswordComplexity\": \"yes\",\n \"NetworkStatus\": \"whole_rdma\",\n \"ResourcePackages\": [\n {\n \"PackageId\": \"package-xbhsw7wk\",\n \"PackageType\": \"CCU\",\n \"DeductionPriority\": 1\n }\n ],\n \"RenewFlag\": 0,\n \"NetworkType\": \"whole_rdma\",\n \"SlaveZoneAttr\": [\n {\n \"Zone\": \"ap-guangzhou-3\",\n \"BinlogSyncWay\": \"async\"\n }\n ]\n },\n \"RequestId\": \"6febb6f0-b0fc-11ee-93cb-73a07daf38c5\"\n }\n}",
278
374
  "title": "Cluster Information Description"
279
375
  }
280
376
  ],
281
377
  "DescribeClusterDetailDatabases": [
282
378
  {
283
379
  "document": " ",
284
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>cynosdbpg-xxxxxxx\", \"Limit\": \"20\", \"DbName\": \"test\", \"Offset\": \"0\"}",
380
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterDetailDatabases\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbpg-xxxxxxx\",\n \"Limit\": 20,\n \"DbName\": \"db1\",\n \"Offset\": 0\n}",
285
381
  "output": "{\n \"Response\": {\n \"DbInfos\": [\n {\n \"Status\": \"running\",\n \"UserHostPrivileges\": [],\n \"UpdateTime\": \"0001-01-01T00:00:00Z\",\n \"Description\": \"\",\n \"DbId\": 0,\n \"CharacterSet\": \"\",\n \"ClusterId\": \"\",\n \"DbName\": \"mysql\",\n \"Uin\": \"\",\n \"AppId\": 0,\n \"CollateRule\": \"\",\n \"CreateTime\": \"0001-01-01T00:00:00Z\"\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"6e094b68-0a37-11ec-97e7-525400542aa6\"\n }\n}",
286
- "title": "Querying the database list"
382
+ "title": "Query a Database List"
287
383
  }
288
384
  ],
289
385
  "DescribeClusterInstanceGrps": [
290
386
  {
291
- "document": " ",
292
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterInstanceGrps\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-oib3wx0i\"\n}",
293
- "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"InstanceGrpInfoList\": [\n {\n \"Status\": \"xx\",\n \"UpdatedTime\": \"2020-09-22 00:00:00\",\n \"Tasks\": [\n {\n \"ObjectType\": \"xx\",\n \"TaskStatus\": \"xx\",\n \"ObjectId\": \"xx\",\n \"TaskId\": 0,\n \"TaskType\": \"xx\"\n }\n ],\n \"OldAddrInfo\": {\n \"Vip\": \"xx\",\n \"Vport\": 0,\n \"ReturnTime\": \"xx\"\n },\n \"UniqVpcId\": \"xx\",\n \"WanDomain\": \"xx\",\n \"InstanceSet\": [\n {\n \"ServerlessStatus\": \"xx\",\n \"WanStatus\": \"xx\",\n \"RenewFlag\": 0,\n \"Zone\": \"xx\",\n \"DbVersion\": \"xx\",\n \"Storage\": 0,\n \"StorageId\": \"xx\",\n \"Memory\": 0,\n \"ProcessingTask\": \"xx\",\n \"Status\": \"xx\",\n \"PhysicalZone\": \"xx\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"xx\",\n \"MinCpu\": 0.0,\n \"MaxCpu\": 0.0,\n \"InstanceId\": \"xx\",\n \"ClusterId\": \"xx\",\n \"NetType\": 0,\n \"IsFreeze\": \"xx\",\n \"SubnetId\": \"xx\",\n \"InstanceType\": \"xx\",\n \"DestroyTime\": \"xx\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"xx\",\n \"ProjectId\": 0,\n \"Region\": \"xx\",\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"CynosVersion\": \"xx\",\n \"StatusDesc\": \"xx\",\n \"InstanceName\": \"xx\",\n \"Cpu\": 0,\n \"StoragePayMode\": 0,\n \"BusinessType\": \"xx\",\n \"Tasks\": [\n {\n \"ObjectType\": \"xx\",\n \"TaskStatus\": \"xx\",\n \"ObjectId\": \"xx\",\n \"TaskId\": 0,\n \"TaskType\": \"xx\"\n }\n ],\n \"WanDomain\": \"xx\",\n \"ClusterName\": \"xx\",\n \"InstanceRole\": \"xx\",\n \"WanPort\": 0,\n \"Uin\": \"xx\",\n \"DbType\": \"xx\",\n \"Vip\": \"xx\",\n \"AppId\": 0,\n \"WanIP\": \"xx\",\n \"Vport\": 0,\n \"CreateTime\": \"2020-09-22 00:00:00\"\n }\n ],\n \"WanPort\": 0,\n \"ClusterId\": \"xx\",\n \"DeletedTime\": \"2020-09-22 00:00:00\",\n \"WanStatus\": \"xx\",\n \"CreatedTime\": \"2020-09-22 00:00:00\",\n \"Vip\": \"xx\",\n \"UniqSubnetId\": \"xx\",\n \"InstanceGrpId\": \"xx\",\n \"AppId\": 0,\n \"WanIP\": \"xx\",\n \"Vport\": 0,\n \"Type\": \"xx\",\n \"NetServiceId\": 0,\n \"ProcessingTasks\": [\n \"xx\"\n ]\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
294
- "title": "Querying instance groups"
387
+ "document": "Query instance group network information. This API is deprecated. Recommended for use: DescribeClusterInstanceGroups",
388
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterInstanceGrps\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-grhvkwd\"\n}",
389
+ "output": "{\n \"Response\": {\n \"InstanceGroupInfoList\": [\n {\n \"AppId\": 1312008346,\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"CreatedTime\": \"2024-12-03 14:03:58\",\n \"DeletedTime\": \"0001-01-01 00:00:00\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceSet\": [\n {\n \"AppId\": 1312008346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"\",\n \"DestroyTime\": \"\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceGroupType\": \"ha\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"master\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"rw\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"0001-01-01 00:00:00\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2025-01-03 14:04:40\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"running\",\n\"StatusDesc\": \"Running\"\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100021117054\",\n \"UpdateTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.12\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"NetServiceId\": 53990,\n \"OldAddrInfo\": {\n \"ReturnTime\": \"\",\n \"Vip\": \"\",\n \"Vport\": 0\n },\n \"ProcessingTasks\": [],\n \"Status\": \"running\",\n \"Tasks\": [],\n \"Type\": \"ha\",\n \"UniqSubnetId\": \"subnet-oiz56c8\",\n \"UniqVpcId\": \"vpc-gy34uq2\",\n \"UpdatedTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.12\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n },\n {\n \"AppId\": 1310008346,\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"CreatedTime\": \"2024-12-03 14:03:58\",\n \"DeletedTime\": \"0001-01-01 00:00:00\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vjh\",\n \"InstanceSet\": [\n {\n \"AppId\": 1310008346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"DestroyDeadlineText\": \"\",\n \"DestroyTime\": \"\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vj0\",\n \"InstanceGroupType\": \"singleRo\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"ro\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"ro\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"0001-01-01 00:00:00\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2025-01-03 14:04:40\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"running\",\n\"StatusDesc\": \"Running\"\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100021117054\",\n \"UpdateTime\": \"2024-12-09 15:18:23\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"NetServiceId\": 53991,\n \"OldAddrInfo\": {\n \"ReturnTime\": \"\",\n \"Vip\": \"\",\n \"Vport\": 0\n },\n \"ProcessingTasks\": [],\n \"Status\": \"running\",\n \"Tasks\": [],\n \"Type\": \"singleRo\",\n \"UniqSubnetId\": \"subnet-oiz56c8\",\n \"UniqVpcId\": \"vpc-gy34uq2\",\n \"UpdatedTime\": \"2024-12-03 14:04:40\",\n \"Vip\": \"172.0.0.7\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"RequestId\": \"c32019ab-0d57-4b3d-80ea-5f52c12b523f\",\n \"TotalCount\": 2\n }\n}",
390
+ "title": "Query Instance Group (Deprecated)"
295
391
  }
296
392
  ],
297
393
  "DescribeClusterParams": [
298
394
  {
299
- "document": " ",
395
+ "document": "This example shows you how to query cluster parameters.",
300
396
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterParams\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbpg-1xcycbu8\"\n}",
301
- "output": "{\n \"Response\": {\n \"Items\": [\n {\n \"MatchValue\": \"\",\n \"CurrentValue\": \"4096\",\n \"Min\": \"1024\",\n \"Default\": \"4096\",\n \"Description\": \"xx\",\n \"Max\": \"65536\",\n \"ParamType\": \"integer\",\n \"EnumValue\": null,\n \"ParamName\": \"work_mem\",\n \"MatchType\": \"\",\n \"NeedReboot\": 0\n },\n {\n \"MatchValue\": \"\",\n \"CurrentValue\": \"base64\",\n \"Min\": \"\",\n \"Default\": \"base64\",\n \"Description\": \"xx\",\n \"Max\": \"\",\n \"ParamType\": \"enum\",\n \"EnumValue\": [\n \"base64\",\n \"hex\"\n ],\n \"ParamName\": \"xmlbinary\",\n \"MatchType\": \"\",\n \"NeedReboot\": 0\n }\n ],\n \"RequestId\": \"117812\",\n \"TotalCount\": 2\n }\n}",
302
- "title": "Querying the cluster parameters"
397
+ "output": "{\n \"Response\": {\n \"TotalCount\": 226,\n \"Items\": [\n {\n \"CurrentValue\": \"1000\",\n \"Default\": \"60000\",\n \"EnumValue\": [\n \"OFF\",\n \"ON\"\n ],\n \"Max\": \"65535\",\n \"Min\": \"1\",\n \"ParamName\": \"auto_increment_increment\",\n \"NeedReboot\": 0,\n \"ParamType\": \"integer\",\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Description\": \"Determines the starting point for the AUTO_INCREMENT column value.\",\n \"IsGlobal\": 1,\n \"ModifiableInfo\": {\n \"IsModifiable\": 1\n },\n \"IsFunc\": true,\n \"Func\": \"{MIN(DBInitMemory/%d*%d,%d)},4000,32768,2097152\"\n }\n ],\n \"RequestId\": \"806fe1c8-5567-4aa8-a521-ea2414c793b4\"\n }\n}",
398
+ "title": "Query Cluster Parameters"
303
399
  }
304
400
  ],
305
401
  "DescribeClusterPasswordComplexity": [
306
402
  {
307
403
  "document": " ",
308
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>cynosdbmysql-bzxxrmtq\"}",
309
- "output": "{ \"Response\": { \"RequestId\": \"7613eed6-5eb5-4d17-ae69-dd93c44d7ad4\", \"ValidatePasswordDictionary\": { \"CurrentValue\": \"\", \"Default\": \"\", \"Description\": \"The dictionary words that validate_password uses for checking passwords.\", \"EnumValue\": [], \"IsGlobal\": 0, \"MatchType\": \"\", \"MatchValue\": \"\", \"Max\": \"0\", \"Min\": \"0\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_txsql_dictionary\", \"ParamType\": \"string\" }, \"ValidatePasswordLength\": { \"CurrentValue\": \"0\", \"Default\": \"8\", \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\", \"EnumValue\": [], \"IsGlobal\": 0, \"MatchType\": \"\", \"MatchValue\": \"\", \"Max\": \"256\", \"Min\": \"8\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_length\", \"ParamType\": \"integer\" }, \"ValidatePasswordMixedCaseCount\": { \"CurrentValue\": \"0\", \"Default\": \"1\", \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\", \"EnumValue\": [], \"IsGlobal\": 0, \"MatchType\": \"\", \"MatchValue\": \"\", \"Max\": \"50\", \"Min\": \"1\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_mixed_case_count\", \"ParamType\": \"integer\" }, \"ValidatePasswordNumberCount\": { \"CurrentValue\": \"0\", \"Default\": \"1\", \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \", \"EnumValue\": [], \"IsGlobal\": 0, \"MatchType\": \"\", \"MatchValue\": \"\", \"Max\": \"50\", \"Min\": \"1\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_number_count\", \"ParamType\": \"integer\" }, \"ValidatePasswordPolicy\": { \"CurrentValue\": \"LOW\", \"Default\": \"MEDIUM\", \"Description\": \"The password policy enforced by validate_password.\", \"EnumValue\": [ \"MEDIUM\", \"STRONG\" ], \"IsGlobal\": 0, \"MatchType\": \"\", \"MatchValue\": \"\", \"Max\": \"2\", \"Min\": \"0\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_policy\", \"ParamType\": \"enum\" }, \"ValidatePasswordSpecialCharCount\": { \"CurrentValue\": \"0\", \"Default\": \"1\", \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \"\", \"MatchValue\": \"\", \"Max\": \"50\", \"Min\": \"1\", \"ModifiableInfo\": {}, \"NeedReboot\": 0, \"ParamName\": \"validate_password_special_char_count\", \"ParamType\": \"integer\" } }}",
310
- "title": "Querying the details of password complexity for a cluster"
404
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterPasswordComplexity\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg7212w\"\n}",
405
+ "output": "{\n \"Response\": {\n \"RequestId\": \"7651f1c0-3429-11ef-81fc-6fec1c9e2c66\",\n \"ValidatePasswordDictionary\": {\n \"CurrentValue\": \"\",\n \"Default\": \"\",\n \"Description\": \"The dictionary words that validate_password uses for checking passwords.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"0\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_txsql_dictionary\",\n \"ParamType\": \"string\"\n },\n \"ValidatePasswordLength\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"8\",\n \"Description\": \"The minimum number of characters that validate_password requires passwords to have.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"256\",\n \"Min\": \"8\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_length\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordMixedCaseCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_mixed_case_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordNumberCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_number_count\",\n \"ParamType\": \"integer\"\n },\n \"ValidatePasswordPolicy\": {\n \"CurrentValue\": \"LOW\",\n \"Default\": \"MEDIUM\",\n \"Description\": \"The password policy enforced by validate_password.\",\n \"EnumValue\": [\n \"MEDIUM\",\n \"STRONG\"\n ],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"2\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_policy\",\n \"ParamType\": \"enum\"\n },\n \"ValidatePasswordSpecialCharCount\": {\n \"CurrentValue\": \"0\",\n \"Default\": \"1\",\n \"Description\": \"The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. \",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"FuncPattern\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"50\",\n \"Min\": \"1\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 0\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"validate_password_special_char_count\",\n \"ParamType\": \"integer\"\n }\n }\n}",
406
+ "title": "View Cluster Password Complexity Details"
407
+ }
408
+ ],
409
+ "DescribeClusterReadOnly": [
410
+ {
411
+ "document": "",
412
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterReadOnly\n<Common request parameters>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-jl17y89v\",\n \"cynosdbmysql-2d9pq38h\"\n ]\n}",
413
+ "output": "{\n \"Response\": {\n \"ClusterReadOnlyValues\": [\n {\n \"ClusterId\": \"cynosdbmysql-jl17y89v\",\n \"ReadOnlyValue\": \"ON\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-2d9pq38h\",\n \"ReadOnlyValue\": \"ON\"\n }\n ],\n \"RequestId\": \"48b7cd8a-f6dd-4e47-a78a-ssfff\"\n }\n}",
414
+ "title": "Query Cluster Read-Only Switch"
415
+ }
416
+ ],
417
+ "DescribeClusterTransparentEncryptInfo": [
418
+ {
419
+ "document": "",
420
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusterTransparentEncryptInfo\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-3pd4zrvn\"\n}",
421
+ "output": "{\n \"Response\": {\n \"KeyId\": \"9d112608-76f7-11ee-****-525400368ae8\",\n \"KeyRegion\": \"ap-guangzhou\",\n \"RequestId\": \"c66ada1a-0098-4787-8db8-42be0cee52cd\"\n }\n}",
422
+ "title": "Query Cluster Encrypted Information"
311
423
  }
312
424
  ],
313
425
  "DescribeClusters": [
314
426
  {
315
- "document": " ",
316
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusters\n<Common request parameters>\n\n{\n \"DbType\": \"MYSQL\",\n \"Limit\": \"20\",\n \"Filters\": [\n {\n \"Values\": [\n \"cynosdbpg-ins-bzkxxrmt\"\n ],\n \"Names\": [\n \"InstanceId\"\n ],\n \"ExactMatch\": \"true\"\n }\n ],\n \"Offset\": \"0\"\n}",
317
- "output": "{\n \"Response\": {\n \"TotalCount\": 597,\n \"ClusterSet\": [\n {\n \"ServerlessStatus\": \"xx\",\n \"RenewFlag\": 0,\n \"Zone\": \"xx\",\n \"InstanceNum\": 1,\n \"ClusterId\": \"xx\",\n \"DbVersion\": \"xx\",\n \"Storage\": 0,\n \"StorageId\": \"xx\",\n \"ProcessingTask\": \"xx\",\n \"Status\": \"xx\",\n \"PhysicalZone\": \"xx\",\n \"UpdateTime\": \"xx\",\n \"VpcId\": \"xx\",\n \"Ability\": [\n {\n \"NonsupportSlaveZoneReason\": \"xx\",\n \"IsSupportSlaveZone\": \"xx\",\n \"IsSupportRo\": \"xx\",\n \"NonsupportRoReason\": \"xx\"\n }\n ],\n \"StorageLimit\": 30000,\n \"SlaveZones\": [\n \"xx\"\n ],\n \"DbMode\": \"xx\",\n \"SubnetId\": \"xx\",\n \"MinStorageSize\": 10,\n \"MaxStorageSize\": 30000,\n \"IsFreeze\": \"xx\",\n \"Region\": \"xx\",\n \"MasterZone\": \"xx\",\n \"PayMode\": 1,\n \"PeriodEndTime\": \"xx\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"CynosVersion\": \"xx\",\n \"StatusDesc\": \"xx\",\n \"StoragePayMode\": 0,\n \"BusinessType\": \"xx\",\n \"Tasks\": [\n {\n \"ObjectType\": \"xx\",\n \"TaskStatus\": \"xx\",\n \"ObjectId\": \"xx\",\n \"TaskId\": 0,\n \"TaskType\": \"xx\"\n }\n ],\n \"HasSlaveZone\": \"xx\",\n \"ClusterName\": \"xx\",\n \"ProjectID\": 0,\n \"Uin\": \"xx\",\n \"DbType\": \"xx\",\n \"Vip\": \"xx\",\n \"AppId\": 251007582,\n \"OrderSource\": \"xx\",\n \"Vport\": 3306,\n \"CreateTime\": \"xx\",\n \"NetAddrs\": [\n {\n \"WanStatus\": \"xx\",\n \"Description\": \"xx\",\n \"UniqVpcId\": \"xx\",\n \"WanDomain\": \"xx\",\n \"WanPort\": 0,\n \"Vip\": \"xx\",\n \"UniqSubnetId\": \"xx\",\n \"NetType\": \"xx\",\n \"WanIP\": \"xx\",\n \"Vport\": 3306\n },\n {\n \"WanStatus\": \"xx\",\n \"Description\": \"xx\",\n \"UniqVpcId\": \"xx\",\n \"WanDomain\": \"xx\",\n \"WanPort\": 0,\n \"Vip\": \"xx\",\n \"UniqSubnetId\": \"xx\",\n \"NetType\": \"xx\",\n \"WanIP\": \"xx\",\n \"Vport\": 3306\n }\n ]\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
318
- "title": "Querying the list of clusters"
427
+ "document": "Query a Cluster List",
428
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeClusters\n<Common request parameters>\n\n{\n \"DbType\": \"MYSQL\",\n \"Limit\": 20,\n \"Filters\": [\n {\n \"Values\": [\n \"cynosdbpg-ins-bzkxxrmt\"\n ],\n \"Names\": [\n \"InstanceId\"\n ],\n \"ExactMatch\": \"true\"\n }\n ],\n \"Offset\": 0\n}",
429
+ "output": "{\n \"Response\": {\n \"ClusterSet\": [\n {\n \"Ability\": {\n \"IsSupportManualSnapshot\": \"no\",\n \"IsSupportRo\": \"yes\",\n \"IsSupportSlaveZone\": \"yes\",\n \"IsSupportTransparentDataEncryption\": \"no\",\n \"NoSupportTransparentDataEncryptionReason\": \"current cluster not support transparent data encryption\",\n \"NonsupportRoReason\": \"yes\",\n \"NonsupportSlaveZoneReason\": \"current cluster not support ro\"\n },\n \"AppId\": 2372636427,\n \"BusinessType\": \"bus_a\",\n \"ClusterId\": \"cynosdbmysql-cbsg6tsg\",\n \"ClusterName\": \"MyClusterName\",\n \"CreateTime\": \"2024-05-30 19:26:42\",\n \"CynosVersion\": \"2.1.12\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"HasSlaveZone\": \"yes\",\n \"InstanceNum\": 2,\n \"IsFreeze\": \"no\",\n \"MasterZone\": \"ap-singapore-3\",\n \"MaxStorageSize\": 30000,\n \"MinStorageSize\": 10,\n \"NetAddrs\": [\n {\n \"Description\": \"descirption\",\n \"InstanceGroupId\": \"cynosdbpg-grp-sbh6ywhs\",\n \"NetType\": \"singleRo\",\n \"UniqSubnetId\": \"subnet-cnhsb8iu\",\n \"UniqVpcId\": \"vpc-iskx6ygc\",\n \"Vip\": \"1.1.1.1\",\n \"Vport\": 3306,\n \"WanDomain\": \"cynosdbpg-bzbsxrmt.wan.domain.com\",\n \"WanIP\": \"3.45.1.9\",\n \"WanPort\": 3306,\n \"WanStatus\": \"init\"\n },\n {\n \"Description\": \"descirption\",\n \"InstanceGroupId\": \"cynosdbpg-grp-bc2b3us4\",\n \"NetType\": \"ha\",\n \"UniqSubnetId\": \"subnet-7shw8ijc\",\n \"UniqVpcId\": \"vpc-y7us28sn\",\n \"Vip\": \"1.1.1.1\",\n \"Vport\": 3306,\n \"WanDomain\": \"cynosdbpg-bzkxxrmt.wan.domain.com\",\n \"WanIP\": \"3.23.1.5\",\n \"WanPort\": 3306,\n \"WanStatus\": \"init\"\n }\n ],\n \"OrderSource\": \"lhdb\",\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-06-30 19:32:51\",\n \"PhysicalZone\": \"ap-singapore-3\",\n \"ProcessingTask\": \"taskUpgradeStorage\",\n \"ProjectID\": 23,\n \"Region\": \"ap-singapore\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": [\n {\n \"DeductionPriority\": 0,\n \"PackageId\": \"package-nxuyx1op\",\n \"PackageType\": \"CCU\"\n }\n ],\n \"ResourceTags\": [\n {\n\"TagKey\": \"Operating product\"\n\"TagValue\": \"Tencent Cloud billing product other_1649\"\n },\n {\n\"TagKey\": \"Operation Department\"\n\"TagValue\": \"billing product center_1013\"\n },\n {\n\"TagKey\": \"Level-1 Business\"\n\"TagValue\": \"[N][Tencent Cloud billing product other]_979685\"\n },\n {\n\"TagKey\": \"Level-2 business\"\n\"TagValue\": \"[license Management][license Data Engine]123\"\n }\n ],\n \"ServerlessStatus\": \"paused\",\n \"SlaveZones\": [\n \"ap-singapore-4\"\n ],\n \"Status\": \"running\",\n\"StatusDesc\": \"Running\"\n \"Storage\": 0,\n \"StorageId\": \"cynosdbpg-bcsu6tsg\",\n \"StorageLimit\": 30000,\n \"StoragePayMode\": 0,\n \"SubnetId\": \"subnet-ybs8jcnw\",\n \"Tasks\": [\n {\n \"ObjectId\": \"cynosdbmysql-k5sm8sh3\",\n \"ObjectType\": \"taskObjTypeCluster\",\n \"TaskId\": 1207003,\n \"TaskStatus\": \"processing\",\n \"TaskType\": \"taskDtsLockResource\"\n }\n ],\n \"Uin\": \"237462834\",\n \"UpdateTime\": \"2024-05-30 19:43:06\",\n \"Vip\": \"1.1.1.1\",\n \"VpcId\": \"vpc-ybs8ue2y\",\n \"Vport\": 3306,\n \"Zone\": \"ap-singapore-3\"\n }\n ],\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"TotalCount\": 31\n }\n}",
430
+ "title": "Query a Cluster List"
319
431
  }
320
432
  ],
321
433
  "DescribeDBSecurityGroups": [
322
434
  {
323
435
  "document": " ",
324
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBSecurityGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbpg-ins-jhi2gdi0\"\n}",
436
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDBSecurityGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-jhi2gdi0\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-b28sjso2\"\n}",
325
437
  "output": "{\n \"Response\": {\n \"Groups\": [\n {\n \"CreateTime\": \"2017-04-13 15:00:06\",\n \"Inbound\": [],\n \"Outbound\": [],\n \"ProjectId\": 0,\n \"SecurityGroupId\": \"sg-ajr1jzgj\",\n \"SecurityGroupName\": \"CynosDB\",\n \"SecurityGroupRemark\": \"\"\n }\n ],\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
326
- "title": "Querying the security group information of an instance"
438
+ "title": "Query Instance Security Group Information"
327
439
  }
328
440
  ],
329
441
  "DescribeFlow": [
330
442
  {
331
443
  "document": " ",
332
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeFlow\n&FlowId=123\n&<Common request parameters>",
333
- "output": "{\n \"Response\": {\n \"Status\": 0,\n \"RequestId\": \"186253\"\n }\n}",
334
- "title": "Querying task flow information"
444
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeFlow\n&FlowId=147186\n&<Common request parameters>",
445
+ "output": "{\n \"Response\": {\n \"Status\": 0,\n \"RequestId\": \"c32019ab-0d57-4b3d-80ea-5f52c12b523f\"\n }\n}",
446
+ "title": "Query Task Flow Information"
447
+ }
448
+ ],
449
+ "DescribeInstanceCLSLogDelivery": [
450
+ {
451
+ "document": "",
452
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceCLSLogDelivery\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\"\n}",
453
+ "output": "{\n \"Response\": {\n \"InstanceCLSDeliveryInfos\": [\n {\n \"GroupId\": \"a5532aba-506f-4ec4-a293-e0ac34b69a4e\",\n \"GroupName\": \"cloud_cynos_-test-003_logset\",\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"InstanceName\": \"cynosdbmysql-ins-o971o62r\",\n \"Region\": \"ap-qingyuan\",\n \"Status\": \"running\",\n \"TopicId\": \"2a289122-0b01-490b-be75-763da79621fe\",\n \"TopicName\": \"cloud_cynos_-test-003_topic\"\n },\n {\n \"GroupId\": \"2f484392-d3f1-491c-82a0-00ceaad9281a\",\n \"GroupName\": \"cloud_cynos_-test-002_logset\",\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"InstanceName\": \"cynosdbmysql-ins-o971o62r\",\n \"Region\": \"ap-qingyuan\",\n \"Status\": \"running\",\n \"TopicId\": \"83dc6703-f43a-4b95-92ec-267bdf9e48c3\",\n \"TopicName\": \"cloud_cynos_-test-002_topic\"\n }\n ],\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\",\n \"TotalCount\": 2\n }\n}",
454
+ "title": "Querying Instance Log Shipping Information"
335
455
  }
336
456
  ],
337
457
  "DescribeInstanceDetail": [
@@ -344,10 +464,10 @@
344
464
  ],
345
465
  "DescribeInstanceErrorLogs": [
346
466
  {
347
- "document": "This example shows you how to query the error logs.",
348
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeInstanceErrorLogs<common request parameters>{ \"InstanceId\": \"cynosdbmysql-ins-xxxxxxxx\", \"Limit\": 10, \"Offset\": 0, \"StartTime\": \"2019-07-04 16:45:32\", \"EndTime\": \"2019-07-04 16:55:32\", \"OrderBy\": \"Timestatmp\", \"OrderByType\": \"DESC\", \"LogLevels\": [ \"error\" ], \"KeyWords\": [ \"abc\" ]}",
349
- "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"ErrorLogs\": [\n {\n \"Timestamp\": 0,\n \"Level\": \"error\",\n \"Content\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
350
- "title": "Querying the error logs"
467
+ "document": "This API is used to query error logs.",
468
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceErrorLogs\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-m6f0hkkd\",\n \"Limit\": 1,\n \"Offset\": 0,\n \"StartTime\": \"2024-10-28 10:19:21\",\n \"EndTime\": \"2024-10-28 10:20:01\",\n \"OrderBy\": \"Timestamp\",\n \"OrderByType\": \"DESC\",\n \"LogLevels\": [\n \"note\"\n ],\n \"KeyWords\": [\n \"unconnected\"\n ]\n}",
469
+ "output": "{\n \"Response\": {\n \"ErrorLogs\": [\n {\n \"Content\": \"Aborted connection 562579 to db: 'unconnected' user: 'unauthenticated' host: '169.214.18.1' (Got an error reading communication packets)\",\n \"Level\": \"note\",\n \"Timestamp\": 1730182001\n }\n ],\n \"RequestId\": \"32f291cb-38c8-4a0c-8fd0-5a4c370ac6df\",\n \"TotalCount\": 3\n }\n}",
470
+ "title": "This API is used to query error logs."
351
471
  }
352
472
  ],
353
473
  "DescribeInstanceParams": [
@@ -360,26 +480,50 @@
360
480
  ],
361
481
  "DescribeInstanceSlowQueries": [
362
482
  {
363
- "document": " ",
483
+ "document": "",
364
484
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceSlowQueries\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-xxxxxxxx\",\n \"StartTime\": \"2022-06-22 00:00:00\",\n \"EndTime\": \"2022-06-24 23:59:59\"\n}",
365
- "output": "{\n \"Response\": {\n \"TotalCount\": 6,\n \"SlowQueries\": [\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.00011,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891555,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n },\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.000109,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891543,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n },\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.000107,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891531,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n },\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.000104,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891520,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n },\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.000108,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891508,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n },\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.000122,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891496,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n }\n ],\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
366
- "title": "Querying the slow query logs of an instance"
485
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"SlowQueries\": [\n {\n \"Database\": \"information_schema\",\n \"LockTime\": 0,\n \"QueryTime\": 11.00011,\n \"RowsExamined\": 0,\n \"RowsSent\": 0,\n \"SqlMd5\": \"267171214708E27C\",\n \"SqlTemplate\": \"select sleep(?) limit ? offset ?;\",\n \"SqlText\": \"SELECT sleep(11) LIMIT 11 offset 0\",\n \"Timestamp\": 1655891555,\n \"UserHost\": \"11.186.190.10\",\n \"UserName\": \"root\"\n }\n ],\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
486
+ "title": "Query Instance Slow Log Details"
367
487
  }
368
488
  ],
369
489
  "DescribeInstanceSpecs": [
370
490
  {
371
- "document": "This example shows you how to query the specification information of a purchasable instance.",
491
+ "document": "This API (DescribeInstanceSpecs) is used to query the instance specifications available for purchase on the query purchase page.",
372
492
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceSpecs\n<Common request parameters>\n\n{\n \"DbType\": \"MYSQL\"\n}",
373
- "output": "{\n \"Response\": {\n \"InstanceSpecSet\": [\n {\n \"MaxStorageSize\": 1,\n \"ZoneStockInfos\": [\n {\n \"HasStock\": true,\n \"StockCount\": 0,\n \"Zone\": \"ap-guangzhou-3\"\n }\n ],\n \"MachineType\": \"common\",\n \"StockCount\": 0,\n \"HasStock\": true,\n \"Memory\": 1,\n \"MinStorageSize\": 1,\n \"MaxIoBandWidth\": 0,\n \"Cpu\": 1,\n \"MaxIops\": 0\n },\n {\n \"MaxStorageSize\": 1,\n \"ZoneStockInfos\": [\n {\n \"HasStock\": true,\n \"StockCount\": 0,\n \"Zone\": \"ap-guangzhou-3\"\n }\n ],\n \"MachineType\": \"common\",\n \"StockCount\": 0,\n \"HasStock\": true,\n \"Memory\": 1,\n \"MinStorageSize\": 1,\n \"MaxIoBandWidth\": 0,\n \"Cpu\": 1,\n \"MaxIops\": 0\n }\n ],\n \"RequestId\": \"test-requestid\"\n }\n}",
374
- "title": "Querying the specification information of a purchasable instance."
493
+ "output": "{\n \"Response\": {\n \"InstanceSpecSet\": [\n {\n \"Cpu\": 1,\n \"Memory\": 1,\n \"MaxStorageSize\": 1,\n \"MinStorageSize\": 1,\n \"HasStock\": true,\n \"MachineType\": \"exclusive\",\n \"MaxIops\": 0,\n \"MaxIoBandWidth\": 0,\n \"ZoneStockInfos\": [\n {\n \"Zone\": \"ap-beijing-3\",\n \"HasStock\": true,\n \"StockCount\": 0\n }\n ],\n \"StockCount\": 0\n }\n ],\n \"RequestId\": \"1c7f08d0-e143-4305-9554-ea236d1a2981\"\n }\n}",
494
+ "title": "Query the Instance Specifications Available for Purchase on the Query Purchase Page"
375
495
  }
376
496
  ],
377
497
  "DescribeInstances": [
378
498
  {
379
- "document": "This example shows you how to query the list of instances.",
380
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<Common request parameters>\n\n{\n \"Limit\": 0,\n \"Offset\": 0,\n \"OrderBy\": \"abc\",\n \"OrderByType\": \"abc\",\n \"Filters\": [\n {\n \"Names\": [\n \"abc\"\n ],\n \"Values\": [\n \"abc\"\n ],\n \"ExactMatch\": true,\n \"Name\": \"abc\",\n \"Operator\": \"abc\"\n }\n ],\n \"DbType\": \"abc\",\n \"Status\": \"abc\",\n \"InstanceIds\": [\n \"abc\"\n ]\n}",
381
- "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceSet\": [\n {\n \"Uin\": \"abc\",\n \"AppId\": 0,\n \"ClusterId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"ProjectId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"Status\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"DbType\": \"abc\",\n \"DbVersion\": \"abc\",\n \"Cpu\": 0,\n \"Memory\": 0,\n \"Storage\": 0,\n \"InstanceType\": \"abc\",\n \"InstanceRole\": \"abc\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\n \"DestroyDeadlineText\": \"abc\",\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\",\n \"DestroyTime\": \"abc\",\n \"CynosVersion\": \"abc\",\n \"ProcessingTask\": \"abc\",\n \"RenewFlag\": 0,\n \"MinCpu\": 0,\n \"MaxCpu\": 0,\n \"ServerlessStatus\": \"abc\",\n \"StorageId\": \"abc\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"abc\",\n \"BusinessType\": \"abc\",\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ],\n \"IsFreeze\": \"abc\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"MasterZone\": \"abc\",\n \"SlaveZones\": [\n \"abc\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"abc\",\n \"InstanceGroupId\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"NetType\": 0,\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanPort\": 0,\n \"WanStatus\": \"abc\"\n }\n ]\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
382
- "title": "Querying the instance list"
499
+ "document": "Query Instance List",
500
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstances\n<Common request parameters>\n\n{\n \"Limit\": 20,\n \"Offset\": 0,\n \"OrderBy\": \"CREATETIME\",\n \"OrderByType\": \"ASC\",\n \"Filters\": [\n {\n \"Names\": [\n \"status\"\n ],\n \"Values\": [\n \"running\"\n ],\n \"ExactMatch\": true,\n \"Name\": \"\",\n \"Operator\": \"\"\n }\n ],\n \"DbType\": \"MYSQL\",\n \"Status\": \"running\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-1asd5qwe\"\n ]\n}",
501
+ "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceSet\": [\n {\n \"Uin\": \"238762734\",\n \"AppId\": 23762834,\n \"ClusterId\": \"cynosdbmysql-asd45qwe\",\n \"ClusterName\": \"MyClusterName\",\n \"InstanceId\": \"cynosdbmysql-ins-asd45qwe\",\n \"InstanceName\": \"MyInstanceName\",\n \"ProjectId\": 2342,\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-3\",\n \"Status\": \"running\",\n\"StatusDesc\": \"Running\"\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\n \"Cpu\": 1,\n \"Memory\": 1,\n \"Storage\": 10,\n \"InstanceType\": \"rw\",\n \"InstanceRole\": \"master\",\n \"UpdateTime\": \"2020-09-22 00:00:00\",\n \"CreateTime\": \"2020-09-22 00:00:00\",\n \"VpcId\": \"vpc-12as56\",\n \"SubnetId\": \"subnet-12kasd\",\n \"Vip\": \"192.0.2.1\",\n \"Vport\": 3306,\n \"PayMode\": 0,\n \"PeriodEndTime\": \"2020-09-22 00:00:00\",\nDestroyDeadlineText: \"<5 days\"\n \"IsolateTime\": \"2020-09-22 00:00:00\",\n \"NetType\": 1,\n \"WanDomain\": \"cynosdbpg-bzkxxrmt.wan.domain.com\",\n \"WanIP\": \"3.1.5.2\",\n \"WanPort\": 3306,\n \"WanStatus\": \"running\",\n \"DestroyTime\": \"2024-01-04 00:09:10\",\n \"CynosVersion\": \"2.0.10\",\n \"ProcessingTask\": \"taskUpgradeStorage\",\n \"RenewFlag\": 0,\n \"MinCpu\": 1,\n \"MaxCpu\": 8,\n \"ServerlessStatus\": \"paused\",\n \"StorageId\": \"cynosdbpg-bzkxxrmt\",\n \"StoragePayMode\": 0,\n \"PhysicalZone\": \"ap-guangzhou-3\",\n \"BusinessType\": \"bus_a\",\n \"Tasks\": [\n {\n \"TaskId\": 111110,\n \"TaskType\": \"taskCreateClusters\",\n \"TaskStatus\": \"running\",\n \"ObjectId\": \"cynosdbmysql-asd45qwe\",\n \"ObjectType\": \"cluster\"\n }\n ],\n \"IsFreeze\": \"no\",\n \"ResourceTags\": [\n {\n \"TagKey\": \"tag_key_1\",\n \"TagValue\": \"tag_value_1\"\n }\n ],\n \"MasterZone\": \"ap-guangzhou-3\",\n \"SlaveZones\": [\n \"ap-guangzhou-4\"\n ],\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupType\": \"ha\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-asd45qwe\",\n \"VpcId\": \"vpc-12as45\",\n \"SubnetId\": \"subnet-cbhs7ush\",\n \"NetType\": 1,\n \"Vip\": \"192.0.0.0\",\n \"Vport\": 3306,\n \"WanDomain\": \"cynosdbpg-bzkxxrmt.wan,domain,com\",\n \"WanIP\": \"23.15.5.1\",\n \"WanPort\": 3306,\n \"WanStatus\": \"running\"\n }\n ],\n \"ResourcePackages\": [\n {\n \"DeductionPriority\": 0,\n \"PackageId\": \"package-bhsy2snc\",\n \"PackageType\": \"CCU\"\n }\n ],\n \"InstanceIndexMode\": \"onlyRowIndex\"\n }\n ],\n \"RequestId\": \"fd5759b5-89e9-483c-b79c-d99b27c33192\"\n }\n}",
502
+ "title": "Query Instance List"
503
+ }
504
+ ],
505
+ "DescribeInstancesWithinSameCluster": [
506
+ {
507
+ "document": "This example shows you how to query the instance ID list within the unified cluster.",
508
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstancesWithinSameCluster\n<Common request parameters>\n\n{\n \"UniqVpcId\": \"vpc-gy34u12n\",\n \"Vip\": \"172.1.1.1\"\n}",
509
+ "output": "{\n \"Response\": {\n \"TotalCount\": 1,\n \"InstanceIds\": [\n \"cynosdbmysql-ins-pgbpxt11\"\n ],\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}",
510
+ "title": "Query the Instance ID List Within the Unified Cluster"
511
+ }
512
+ ],
513
+ "DescribeIntegrateTask": [
514
+ {
515
+ "document": "Describe Integrate Task",
516
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeIntegrateTask\n<Common request parameters>\n\n{\n \"DealNames\": [\n \"20250922456021575003931\"\n ]\n}",
517
+ "output": "{\n \"Response\": {\n \"CurrentProgress\": \"5/5\",\n \"CurrentStep\": \"FinishTask\",\n \"RequestId\": \"de351c1d-72fa-477b-997a-8ae045f90da2\",\n \"TaskStatus\": \"success\"\n }\n}",
518
+ "title": "Querying an Integration Task"
519
+ }
520
+ ],
521
+ "DescribeIsolatedInstances": [
522
+ {
523
+ "document": " ",
524
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeIsolatedInstances\n&Limit=20\n&Offset=0\n&Filters.0.Names.0=InstanceId\n&Filters.0.Values.0=cynosdbpg-ins-bzkxxrmt\n&DbType=MYSQL\n&<Common request parameters>",
525
+ "output": "{\n \"Response\": {\n \"InstanceSet\": [\n {\n \"AppId\": 1311111346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\nDestroyDeadlineText: \"<7 days\"\n \"DestroyTime\": \"2024-12-30 19:51:33\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-crl6j3l\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-r7hmdx4\",\n \"InstanceGroupType\": \"ha\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"master\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"rw\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"2024-12-23 19:51:33\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-12-23 19:51:24\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"isolated\",\n\"StatusDesc\": \"Isolated\"\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100011147054\",\n \"UpdateTime\": \"2024-12-23 19:51:33\",\n \"Vip\": \"172.0.0.2\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n },\n {\n \"AppId\": 1311111346,\n \"BusinessType\": \"\",\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"ClusterName\": \"cynosdbmysql-grhvkwd\",\n \"Cpu\": 2,\n \"CreateTime\": \"2024-12-03 14:03:58\",\n \"CynosVersion\": \"2.1.13.001\",\n \"DbMode\": \"NORMAL\",\n \"DbType\": \"MYSQL\",\n \"DbVersion\": \"5.7\",\nDestroyDeadlineText: \"<7 days\"\n \"DestroyTime\": \"2024-12-30 19:51:33\",\n \"DeviceType\": \"exclusive\",\n \"InstanceAbility\": {\n \"IsSupportForceRestart\": \"no\",\n \"NonsupportForceRestartReason\": \"NoForcedRestartAllowed\"\n },\n \"InstanceId\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceIndexMode\": \"onlyRowIndex\",\n \"InstanceName\": \"cynosdbmysql-ins-6t9ynb7\",\n \"InstanceNetInfo\": [\n {\n \"InstanceGroupId\": \"cynosdbmysql-grp-08o6vj0\",\n \"InstanceGroupType\": \"singleRo\",\n \"NetType\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\"\n }\n ],\n \"InstanceRole\": \"ro\",\n \"InstanceStorageType\": \"\",\n \"InstanceType\": \"ro\",\n \"IsFreeze\": \"no\",\n \"IsolateTime\": \"2024-12-23 19:51:33\",\n \"MasterZone\": \"ap-chongqing-1\",\n \"MaxCpu\": 0,\n \"Memory\": 4,\n \"MinCpu\": 0,\n \"NetType\": 1,\n \"PayMode\": 1,\n \"PeriodEndTime\": \"2024-12-23 19:51:24\",\n \"PhysicalZone\": \"ap-chongqing-1\",\n \"ProcessingTask\": \"\",\n \"ProjectId\": 0,\n \"Region\": \"ap-chongqing\",\n \"RenewFlag\": 1,\n \"ResourcePackages\": null,\n \"ResourceTags\": null,\n \"ServerlessStatus\": \"\",\n \"SlaveZones\": [],\n \"Status\": \"isolated\",\n\"StatusDesc\": \"Isolated\"\n \"Storage\": 10,\n \"StorageId\": \"cynosdbmysql-grhvkwd\",\n \"StoragePayMode\": 1,\n \"SubnetId\": \"subnet-oiz56c8\",\n \"Tasks\": [],\n \"Uin\": \"100011147054\",\n \"UpdateTime\": \"2024-12-23 19:51:33\",\n \"Vip\": \"172.0.0.7\",\n \"VpcId\": \"vpc-gy34uq2\",\n \"Vport\": 3306,\n \"WanDomain\": \"\",\n \"WanIP\": \"\",\n \"WanPort\": 0,\n \"WanStatus\": \"init\",\n \"Zone\": \"ap-chongqing-1\"\n }\n ],\n \"RequestId\": \"8f291dbc-3840-40f9-aa39-841437c247fb\",\n \"TotalCount\": 2\n }\n}",
526
+ "title": "Inquiry Recycle Bin Instance List"
383
527
  }
384
528
  ],
385
529
  "DescribeMaintainPeriod": [
@@ -392,34 +536,34 @@
392
536
  ],
393
537
  "DescribeParamTemplateDetail": [
394
538
  {
395
- "document": "This example shows you how to query the details of a parameter template.",
396
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeParamTemplateDetail<common request parameters>{ \"TemplateId\": \"4837003\"}",
397
- "output": "{\n \"Response\": {\n \"DbMode\": \"NORMAL\",\n \"EngineVersion\": \"5.7\",\n \"Items\": [\n {\n \"CurrentValue\": \"1000\",\n \"Default\": \"0\",\n \"Description\": \"The maximum permitted number of simultaneous client connections per user.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"10240\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {},\n \"NeedReboot\": 0,\n \"ParamName\": \"max_user_connections\",\n \"ParamType\": \"integer\",\n \"SupportFunc\": false\n }\n ],\n \"RequestId\": \"ca8481bf-ba79-42ba-b90b-bd47df104add\",\n \"TemplateDescription\": \"test template\",\n \"TemplateId\": 4837003,\n \"TemplateName\": \"test template\",\n \"TotalCount\": 1\n }\n}",
398
- "title": "Querying the details of a parameter template"
539
+ "document": "This API is used to query parameter template details.",
540
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplateDetail\n<Common request parameters>\n\n{\n \"TemplateId\": 4837003\n}",
541
+ "output": "{\n \"Response\": {\n \"DbMode\": \"NORMAL\",\n \"EngineVersion\": \"5.7\",\n \"Items\": [\n {\n \"CurrentValue\": \"1000\",\n \"Default\": \"0\",\n \"Description\": \"The maximum permitted number of simultaneous client connections per user.\",\n \"EnumValue\": [],\n \"Func\": \"\",\n \"IsFunc\": false,\n \"IsGlobal\": 0,\n \"MatchType\": \"\",\n \"MatchValue\": \"\",\n \"Max\": \"10240\",\n \"Min\": \"0\",\n \"ModifiableInfo\": {\n \"IsModifiable\": 1\n },\n \"NeedReboot\": 0,\n \"ParamName\": \"max_user_connections\",\n \"ParamType\": \"integer\",\n \"SupportFunc\": false,\n \"FuncPattern\": \"{MAX(DBInitCpu/%d,%d)},2,4\"\n }\n ],\n \"RequestId\": \"ca8481bf-ba79-42ba-b90b-bd47df104add\",\n\"TemplateDescription\": \"test template\"\n \"TemplateId\": 4837003,\n\"TemplateName\": \"Test Template\"\n \"TotalCount\": 1\n }\n}",
542
+ "title": "This API is used to query parameter template details."
399
543
  }
400
544
  ],
401
545
  "DescribeParamTemplates": [
402
546
  {
403
- "document": "This example shows you how to query the list of the parameter templates.",
547
+ "document": "List of parameter panels",
404
548
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplates\n<Common request parameters>\n\n{}",
405
- "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"fc791b35-d5e5-4e08-859d-1c095e783199\",\n \"Items\": [\n {\n \"TemplateDescription\": \"APITest\",\n \"TemplateName\": \"APITest\",\n \"Id\": 27,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"APITest\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"test\"\n ],\n \"ParamName\": \"param1\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n },\n {\n \"TemplateName\": \"APITest\",\n \"TemplateDescription\": \"APITest\",\n \"Id\": 28,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\n \"Description\": \"APITest\",\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"tste\",\n \"test2\"\n ],\n \"ParamName\": \"param2\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n }\n ]\n }\n}",
406
- "title": "This example shows you how to query the list of the parameter templates."
549
+ "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"RequestId\": \"fc791b35-d5e5-4e08-859d-1c095e783199\",\n \"Items\": [\n {\n\"TemplateDescription\": \"API testing\"\n\"TemplateName\": \"APITest\"\n \"Id\": 27,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\nAPI testing\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"ON\",\n \"OFF\"\n ],\n \"ParamName\": \"param1\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n },\n {\n\"TemplateName\": \"APITest\"\n\"TemplateDescription\": \"API testing\"\n \"Id\": 28,\n \"EngineVersion\": \"5.7\",\n \"ParamInfoSet\": [\n {\n \"CurrentValue\": \"12\",\nAPI testing\n \"Min\": \"10\",\n \"Default\": \"10\",\n \"Max\": \"10000\",\n \"ParamType\": \"integer\",\n \"EnumValue\": [\n \"21\",\n \"22\"\n ],\n \"ParamName\": \"param2\",\n \"NeedReboot\": 0\n }\n ],\n \"DbMode\": \"NORMAL\"\n }\n ]\n }\n}",
550
+ "title": "List of Parameter Panels"
407
551
  }
408
552
  ],
409
553
  "DescribeProjectSecurityGroups": [
410
554
  {
411
555
  "document": " ",
412
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectSecurityGroups\n<Common request parameters>\n\n{\n \"ProjectId\": \"11954\"\n}",
556
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProjectSecurityGroups\n<Common request parameters>\n\n{\n \"ProjectId\": 11954\n}",
413
557
  "output": "{\n \"Response\": {\n \"Total\": 1,\n \"Groups\": [\n {\n \"CreateTime\": \"2017-04-13 15:00:06\",\n \"Inbound\": [],\n \"Outbound\": [],\n \"ProjectId\": 0,\n \"SecurityGroupId\": \"sg-ajr1jzgj\",\n \"SecurityGroupName\": \"CynosDB\",\n \"SecurityGroupRemark\": \"\"\n }\n ],\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
414
- "title": "Querying the security group information of a project"
558
+ "title": "Query Project Security Group Information"
415
559
  }
416
560
  ],
417
561
  "DescribeProxies": [
418
562
  {
419
- "document": "This example shows you how to query the information of database proxy.",
420
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxies\n<Common request parameters>\n\n{\n \"OrderBy\": \"createTime\",\n \"ClusterId\": \"cynosdbmysql-xx\",\n \"Limit\": 0,\n \"Filters\": [\n {\n \"Values\": [\n \"proxyGroupId\"\n ],\n \"Names\": [\n \"cynosdbmysql-proxy-xx\"\n ],\n \"ExactMatch\": true\n }\n ],\n \"Offset\": 0,\n \"OrderByType\": \"desc\"\n}",
421
- "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"ProxyGroupInfos\": [\n {\n \"ProxyGroup\": {\n \"ProxyGroupId\": \"abc\",\n \"ProxyNodeCount\": 0,\n \"Status\": \"abc\",\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"CurrentProxyVersion\": \"abc\",\n \"ClusterId\": \"abc\",\n \"AppId\": 0,\n \"OpenRw\": \"abc\"\n },\n \"ProxyGroupRwInfo\": {\n \"ConsistencyType\": \"abc\",\n \"ConsistencyTimeOut\": 0,\n \"WeightMode\": \"abc\",\n \"FailOver\": \"abc\",\n \"AutoAddRo\": \"abc\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"abc\",\n \"Weight\": 0\n }\n ],\n \"OpenRw\": \"abc\"\n },\n \"ProxyNodes\": [\n {\n \"ProxyNodeId\": \"abc\",\n \"ProxyNodeConnections\": 0,\n \"Cpu\": 0,\n \"Mem\": 0,\n \"Status\": \"abc\",\n \"ProxyGroupId\": \"abc\",\n \"ClusterId\": \"abc\",\n \"AppId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\"\n }\n ],\n \"ConnectionPool\": {\n \"OpenConnectionPool\": \"abc\",\n \"ConnectionPoolType\": \"abc\",\n \"ConnectionPoolTimeOut\": 0\n },\n \"NetAddrInfos\": [\n {\n \"Vip\": \"abc\",\n \"Vport\": 0,\n \"WanDomain\": \"abc\",\n \"WanPort\": 0,\n \"NetType\": \"abc\",\n \"UniqSubnetId\": \"abc\",\n \"UniqVpcId\": \"abc\",\n \"Description\": \"abc\",\n \"WanIP\": \"abc\",\n \"WanStatus\": \"abc\"\n }\n ],\n \"Tasks\": [\n {\n \"TaskId\": 0,\n \"TaskType\": \"abc\",\n \"TaskStatus\": \"abc\",\n \"ObjectId\": \"abc\",\n \"ObjectType\": \"abc\"\n }\n ]\n }\n ],\n \"ProxyNodeInfos\": [\n {\n \"ProxyNodeId\": \"abc\",\n \"ProxyNodeConnections\": 0,\n \"Cpu\": 0,\n \"Mem\": 0,\n \"Status\": \"abc\",\n \"ProxyGroupId\": \"abc\",\n \"ClusterId\": \"abc\",\n \"AppId\": 0,\n \"Region\": \"abc\",\n \"Zone\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
422
- "title": "Querying the list of the database proxies"
563
+ "document": "This example shows you how to query a database proxy.",
564
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxies\n<Common request parameters>\n\n{\n \"OrderBy\": \"createTime\",\n \"ClusterId\": \"cynosdbmysql-xx\",\n \"Limit\": 0,\n \"Filters\": [\n {\n \"Values\": [\n \"proxyGroupId\"\n ],\n \"Names\": [\n \"cynosdbmysql-proxy-tshj6btw\"\n ],\n \"ExactMatch\": true\n }\n ],\n \"Offset\": 0,\n \"OrderByType\": \"desc\"\n}",
565
+ "output": "{\n \"Response\": {\n \"TotalCount\": 2,\n \"ProxyGroupInfos\": [\n {\n \"ConnectionPool\": {\n \"ConnectionPoolTimeOut\": 30,\n \"ConnectionPoolType\": \"SessionConnectionPool\",\n \"OpenConnectionPool\": \"yes\"\n },\n \"NetAddrInfos\": [\n {\n \"Description\": \"external-ro new\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-nsiuj4aj\",\n \"NetType\": \"\",\n \"UniqSubnetId\": \"subnet-pmqqss72\",\n \"UniqVpcId\": \"vpc-gvelzo5j\",\n \"Vip\": \"11.2.1.43\",\n \"Vport\": 3306,\n \"WanDomain\": \"test.wan.domain\",\n \"WanIP\": \"11.2.3.43\",\n \"WanPort\": 3306,\n \"WanStatus\": \"open\"\n }\n ],\n \"ProxyGroup\": {\n \"AppId\": 1772344699,\n \"ClusterId\": \"cynosdbmysql-i2weamox\",\n \"CurrentProxyVersion\": \"1.3.11\",\n \"OpenRw\": \"yes\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-mdhg55su\",\n \"ProxyNodeCount\": 4,\n \"Region\": \"ap-guangzhou\",\n \"Status\": \"running\",\n \"Zone\": \"ap-guangzhou-6\"\n },\n \"ProxyGroupRwInfo\": {\n \"AccessMode\": \"balance\",\n \"AutoAddRo\": \"no\",\n \"ConsistencyTimeOut\": 0,\n \"ConsistencyType\": \"eventual\",\n \"FailOver\": \"no\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"cynosdbmysql-ins-ka2i3m48\",\n \"Weight\": 1\n }\n ],\n \"OpenRw\": \"yes\",\n \"RwType\": \"READONLY\",\n \"TransSplit\": false,\n \"WeightMode\": \"system\"\n },\n \"ProxyNodes\": [\n {\n \"AppId\": 1772344699,\n \"ClusterId\": \"cynosdbmysql-i2weamox\",\n \"Cpu\": 2,\n \"Mem\": 4000,\n \"OssProxyNodeName\": \"cynosdbmysql-proxyNode-q52v1wp4\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-mdhg57su\",\n \"ProxyNodeConnections\": 157,\n \"ProxyNodeId\": \"cynosdbmysql-proxyNode-pv4hg4na\",\n \"Region\": \"ap-guangzhou\",\n \"Status\": \"running\",\n \"Zone\": \"ap-guangzhou-6\"\n }\n ],\n \"Tasks\": [\n {\n \"TaskId\": 123124,\n \"TaskType\": \"taskModifyProxyRwSplit\",\n \"TaskStatus\": \"processing\",\n \"ObjectId\": \"cynosdbmysql-proxy-mdhg57su\",\n \"ObjectType\": \"taskObjTypeCluster\"\n }\n ]\n }\n ],\n \"ProxyNodeInfos\": [\n {\n \"ProxyNodeId\": \"cynosdbmysql-proxyNode-pv4hg4na\",\n \"ProxyNodeConnections\": 157,\n \"Cpu\": 2,\n \"Mem\": 4000,\n \"Status\": \"running\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-mdhg57su\",\n \"ClusterId\": \"cynosdbmysql-i2weamox\",\n \"AppId\": 1772344699,\n \"Region\": \"ap-guangzhou\",\n \"Zone\": \"ap-guangzhou-6\",\n \"OssProxyNodeName\": \"cynosdbmysql-proxyNode-q52v1wp4\"\n }\n ],\n \"RequestId\": \"ed0bd4ca-b5c0-4230-a8b5-6d2dc5ec1eb0\"\n }\n}",
566
+ "title": "Query a List of Database Proxies"
423
567
  }
424
568
  ],
425
569
  "DescribeProxyNodes": [
@@ -434,94 +578,126 @@
434
578
  {
435
579
  "document": " ",
436
580
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxySpecs\n<Common request parameters>\n\n{}",
437
- "output": "{\n \"Response\": {\n \"ProxySpecs\": [\n {\n \"Mem\": 0,\n \"Cpu\": 0\n }\n ],\n \"RequestId\": \"request-756112\"\n }\n}",
438
- "title": "Querying the specifications of a database proxy"
581
+ "output": "{\n \"Response\": {\n \"ProxySpecs\": [\n {\n \"Cpu\": 2,\n \"Mem\": 4000\n },\n {\n \"Cpu\": 4,\n \"Mem\": 8000\n },\n {\n \"Cpu\": 8,\n \"Mem\": 16000\n }\n ],\n \"RequestId\": \"f4479b74-e428-40d9-a81f-e34cac00ae70\"\n }\n}",
582
+ "title": "Querying proxy specifications"
439
583
  },
440
584
  {
441
585
  "document": " ",
442
586
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProxySpecs\n<Common request parameters>\n\n{}",
443
- "output": "{\n \"Response\": {\n \"ProxySpecs\": [\n {\n \"Cpu\": 2,\n \"Mem\": 4000\n },\n {\n \"Cpu\": 4,\n \"Mem\": 8000\n },\n {\n \"Cpu\": 8,\n \"Mem\": 16000\n }\n ],\n \"RequestId\": \"f4479b74-e428-40d9-a81f-e34cac00ae70\"\n }\n}",
444
- "title": "Querying proxy specifications"
587
+ "output": "{\n \"Response\": {\n \"ProxySpecs\": [\n {\n \"Mem\": 0,\n \"Cpu\": 0\n }\n ],\n \"RequestId\": \"request-756112\"\n }\n}",
588
+ "title": "Querying the specifications of a database proxy"
445
589
  }
446
590
  ],
447
591
  "DescribeResourcePackageDetail": [
448
592
  {
449
- "document": "This example shows you how to query the usage details of a resource pack.\n",
450
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeResourcePackageDetail<common request parameters>{ \"PackageId\": \"abc\", \"ClusterIds\": [ \"abc\" ], \"StartTime\": \"abc\", \"EndTime\": \"abc\", \"Offset\": \"abc\", \"Limit\": \"abc\"}",
451
- "output": "{\n \"Response\": {\n \"Total\": 0,\n \"Detail\": [\n {\n \"AppId\": 0,\n \"PackageId\": \"abc\",\n \"InstanceId\": \"abc\",\n \"SuccessDeductSpec\": 0,\n \"PackageTotalUsedSpec\": 0,\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"ExtendInfo\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
452
- "title": "Querying the usage details of a resource pack"
593
+ "document": "This example shows you how to query the usage details of a resource package.\n",
594
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResourcePackageDetail\n<Common request parameters>\n\n{\n \"PackageId\": \"package-twox8tqx\",\n \"ClusterIds\": [\n \"cynosdbmysql-ou5cnw2x\"\n ],\n \"StartTime\": \"2024-09-28 10:11:23\",\n \"EndTime\": \"2024-10-28 10:11:23\",\n \"Offset\": \"0\",\n \"Limit\": \"20\"\n}",
595
+ "output": "{\n \"Response\": {\n \"Total\": 20,\n \"Detail\": [\n {\n \"AppId\": 251232125,\n \"PackageId\": \"package-abcr4312\",\n \"InstanceId\": \"cynosdbmysql-ins-anji1234\",\n \"SuccessDeductSpec\": 100,\n \"PackageTotalUsedSpec\": 200,\n \"StartTime\": \"2020-01-01 00:00:01\",\n \"EndTime\": \"2020-01-02 00:00:01\",\n \"ExtendInfo\": \"{\\\"ClusterId\\\":\\\"cynosdbmysql-i58mvikj\\\",\\\"RequestId\\\":\\\"1724306460000666497_c7bedc2d-3454-4fe9-9768-335a9901f10f\\\"}\"\n }\n ],\n \"RequestId\": \"3d56fe0b-f839-42c6-b84e-1d5fbc874cba\"\n }\n}",
596
+ "title": "Query Resource Pack Usage Details"
453
597
  }
454
598
  ],
455
599
  "DescribeResourcePackageList": [
456
600
  {
457
- "document": "This example shows you how to query the list of the resource packs.\n",
458
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeSourcePackageList<common request parameters>{ \"PackageId\": [ \"abc\" ], \"PackageName\": [ \"abc\" ], \"PackageType\": [ \"abc\" ], \"PackageRegion\": [ \"abc\" ], \"Status\": [ \"abc\" ], \"OrderBy\": [ \"abc\" ], \"OrderDirection\": \"abc\", \"Offset\": 0, \"Limit\": 0}",
459
- "output": "{\n \"Response\": {\n \"Total\": 0,\n \"Detail\": [\n {\n \"AppId\": 0,\n \"PackageId\": \"abc\",\n \"PackageName\": \"abc\",\n \"PackageType\": \"abc\",\n \"PackageRegion\": \"abc\",\n \"Status\": \"abc\",\n \"PackageTotalSpec\": 0,\n \"PackageUsedSpec\": 0,\n \"HasQuota\": true,\n \"BindInstanceInfos\": [\n {\n \"InstanceId\": \"abc\",\n \"InstanceRegion\": \"abc\",\n \"InstanceType\": \"abc\"\n }\n ],\n \"StartTime\": \"abc\",\n \"ExpireTime\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
460
- "title": "Querying the list of the resource packs"
601
+ "document": "This example shows you how to inquiry the resource package list.\n",
602
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSourcePackageList\n<Common request parameters>\n\n{\n \"PackageId\": [\n \"package-bst68sh3\"\n ],\n \"PackageName\": [\ncustom resource package name - 1\n ],\n \"PackageType\": [\n \"CCU\"\n ],\n \"PackageRegion\": [\n \"chineseMainland\"\n ],\n \"Status\": [\n \"using\"\n ],\n \"OrderBy\": [\n \"createTime\"\n ],\n \"OrderDirection\": \"desc\",\n \"Offset\": 0,\n \"Limit\": 20\n}",
603
+ "output": "{\n \"Response\": {\n \"Total\": 20,\n \"Detail\": [\n {\n \"AppId\": 12387234,\n \"PackageId\": \"package-cbhsyegx\",\n \"PackageName\": \"MyPackageName\",\n \"PackageType\": \"CCU\",\n \"PackageRegion\": \"chineseMainland\",\n \"Status\": \"using\",\n \"PackageTotalSpec\": 10000000,\n \"PackageUsedSpec\": 2394.3,\n \"HasQuota\": true,\n \"BindInstanceInfos\": [\n {\n \"InstanceId\": \"cynosdbpg-ins-bzkxxrmt\",\n \"InstanceRegion\": \"ap-guangzhou\",\n \"InstanceType\": \"cynosdb-serverless\"\n }\n ],\n \"StartTime\": \"2023-12-10 00:00:00\",\n \"ExpireTime\": \"2025-11-10 00:00:00\"\n }\n ],\n \"RequestId\": \"e0c28bb4-a0f2-4194-a646-b8bcf777b5ce\"\n }\n}",
604
+ "title": "Query Resource Package List"
461
605
  }
462
606
  ],
463
607
  "DescribeResourcePackageSaleSpec": [
464
608
  {
465
- "document": "This example shows you how to query the specifications of a resource pack.\n",
466
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeSourcePackageList<common request parameters>{ \"PackageId\": [ \"abc\" ], \"PackageName\": [ \"abc\" ], \"PackageType\": [ \"abc\" ], \"PackageRegion\": [ \"abc\" ], \"Status\": [ \"abc\" ], \"OrderBy\": [ \"abc\" ], \"OrderDirection\": \"abc\", \"PackageRegion\": \"abc\", \"PackageType\": \"abc\", \"Offset\": 0, \"Limit\": 0}",
467
- "output": "{\n \"Response\": {\n \"Total\": 0,\n \"Detail\": [\n {\n \"PackageRegion\": \"abc\",\n \"PackageType\": \"abc\",\n \"PackageVersion\": \"abc\",\n \"MinPackageSpec\": 0,\n \"MaxPackageSpec\": 0,\n \"ExpireDay\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
468
- "title": "Querying the specifications of a resource pack"
609
+ "document": "This example shows you how to inquire about resource pack specifications.\n",
610
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSourcePackageSaleSpec\n<Common request parameters>\n\n{\n \"InstanceType\": \"cynosdb-serverless\",\n \"PackageRegion\": \"china\",\n \"PackageType\": \"CCU\",\n \"Offset\": 0,\n \"Limit\": 1\n}",
611
+ "output": "{\n \"Response\": {\n \"Total\": 0,\n \"Detail\": [\n {\n \"PackageRegion\": \"china\",\n \"PackageType\": \"CCU\",\n \"PackageVersion\": \"common\",\n \"MinPackageSpec\": 50,\n \"MaxPackageSpec\": 100,\n \"ExpireDay\": 180\n }\n ],\n \"RequestId\": \"93c96481-e37c-49f7-aeb5-907ee97a198c\"\n }\n}",
612
+ "title": "Query Resource Pack Specifications"
469
613
  }
470
614
  ],
471
615
  "DescribeResourcesByDealName": [
472
616
  {
473
- "document": " ",
474
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResourcesByDealName\n<Common request parameters>\n\n{\n \"DealName\": \"xxx\"\n}",
475
- "output": "{\n \"Response\": {\n \"BillingResourceInfos\": [\n {\n \"ClusterId\": \"cynosdbmysql-r8ewihg4\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-pecl0drs\"\n ],\n \"DealName\": \"xxx\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-hjosrxhu\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-7f59pahg\"\n ],\n \"DealName\": \"xxx\"\n }\n ],\n \"RequestId\": \"005b862f-f408-4a95-a7e7-26f3e672e081\"\n }\n}",
476
- "title": "Querying the information of resource associated with order ID"
617
+ "document": "",
618
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeResourcesByDealName\n<Common request parameters>\n\n{\n \"DealName\": \"201302542054\"\n}",
619
+ "output": "{\n \"Response\": {\n \"BillingResourceInfos\": [\n {\n \"ClusterId\": \"cynosdbmysql-r8ewihg4\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-pecl0drs\"\n ],\n \"DealName\": \"201302542054\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-hjosrxhu\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-7f59pahg\"\n ],\n \"DealName\": \"201302542054\"\n }\n ],\n \"RequestId\": \"005b862f-f408-4a95-a7e7-26f3e672e081\"\n }\n}",
620
+ "title": "Query Order Associated Instance"
477
621
  }
478
622
  ],
479
623
  "DescribeRollbackTimeRange": [
624
+ {
625
+ "document": "",
626
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRollbackTimeRange\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-oib3wx0i\"\n}",
627
+ "output": "{\n \"Response\": {\n \"RollbackTimeRanges\": [\n {\n \"TimeRangeStart\": \"2019-01-13 02:12:05\",\n \"TimeRangeEnd\": \"2019-01-20 02:10:12\"\n }\n ],\n \"TimeRangeStart\": \"\",\n \"TimeRangeEnd\": \"\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
628
+ "title": ""
629
+ }
630
+ ],
631
+ "DescribeServerlessInstanceSpecs": [
480
632
  {
481
633
  "document": " ",
482
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRollbackTimeRange\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-oib3wx0i\"\n}",
483
- "output": "{\n \"Response\": {\n \"RollbackTimeRanges\": [\n {\n \"TimeRangeStart\": \"2019-01-13 02:12:05\",\n \"TimeRangeEnd\": \"2019-01-20 02:10:12\"\n }\n ],\n \"TimeRangeStart\": \"xx\",\n \"TimeRangeEnd\": \"xx\",\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
484
- "title": "Querying valid rollback time range"
634
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServerlessInstanceSpecs\n<Common request parameters>\n\n{}",
635
+ "output": "{\n \"Response\": {\n \"Specs\": [\n {\n \"MaxStorageSize\": 1000,\n \"MinCpu\": 0.25,\n \"StockCount\": 0,\n \"MaxCpu\": 0.5,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 1000,\n \"MinCpu\": 0.25,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 5000,\n \"MinCpu\": 0.25,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 10000,\n \"MinCpu\": 0.25,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 1000,\n \"MinCpu\": 0.5,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 5000,\n \"MinCpu\": 0.5,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 1\n },\n {\n \"MaxStorageSize\": 10000,\n \"MinCpu\": 0.5,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 5000,\n \"MinCpu\": 0.0,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 10000,\n \"MinCpu\": 0.0,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n },\n {\n \"MaxStorageSize\": 10000,\n \"MinCpu\": 0.0,\n \"StockCount\": 0,\n \"MaxCpu\": 0.0,\n \"HasStock\": true,\n \"IsDefault\": 0\n }\n ],\n \"RequestId\": \"52-a341-4269-bce2-221ec952ea16|m\"\n }\n}",
636
+ "title": "Query Available Specifications of Serverless Instance"
485
637
  }
486
638
  ],
487
- "DescribeRollbackTimeValidity": [
639
+ "DescribeServerlessStrategy": [
488
640
  {
489
641
  "document": " ",
490
- "input": "https://cynosdb.tencentcloudapi.com/?Action=DescribeRollbackTimeValidity\n&ClusterId=cynosdbpg-gn65y9nk\n&ExpectTime=2019-01-1302:12:05\n&ExpectTimeThresh=0\n&<Common request parameters>",
491
- "output": "{\n \"Response\": {\n \"PoolId\": 1050,\n \"QueryId\": 2008,\n \"Status\": \"pass\",\n \"SuggestTime\": \"\"\n }\n}",
492
- "title": "Querying whether rollback is possible based on specified time point"
642
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeServerlessStrategy\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxx\"\n}",
643
+ "output": "{\n \"Response\": {\n \"AutoPauseDelay\": 300,\n \"AutoScaleDownDelay\": 60,\n \"AutoPause\": \"yes\",\n \"RequestId\": \"8727691c-3536-11eb-81e7-525400b7dd5a\",\n \"AutoScaleUpDelay\": 30\n }\n}",
644
+ "title": "Query serverless Policy"
493
645
  }
494
646
  ],
495
- "DescribeSupportProxyVersion": [
647
+ "DescribeSlaveZones": [
496
648
  {
497
649
  "document": " ",
498
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSupportProxyVersion\n<Common request parameters>\n\n{\n \"ClusterId\": \"xx\"\n}",
499
- "output": "{\n \"Response\": {\n \"SupportProxyVersions\": [\n \"xx\"\n ],\n \"CurrentProxyVersion\": \"0.0\",\n \"RequestId\": \"xx\"\n }\n}",
500
- "title": "Querying the supported database proxy versions"
650
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSlaveZones\n<Common request parameters>\n\n{\n \"Zone\": \"ap-guangzhou-3\"\n}",
651
+ "output": "{\n \"Response\": {\n \"SlaveZones\": [\n \"ap-guangzhou-5\"\n ],\n \"RequestId\": \"128046\"\n }\n}",
652
+ "title": "DescribeSlaveZones"
653
+ }
654
+ ],
655
+ "DescribeSupportProxyVersion": [
656
+ {
657
+ "document": "This example shows you how to query the supported database proxy versions.",
658
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSupportProxyVersion\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-dnofdr2c\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-4378e0kd\"\n}",
659
+ "output": "{\n \"Response\": {\n \"SupportProxyVersions\": [\n \"3.1.4\"\n ],\n \"CurrentProxyVersion\": \"3.1.1\",\n \"SupportProxyVersionDetail\": [\n {\n \"ProxyVersion\": \"3.1.5\",\n \"ProxyVersionType\": \"BATE\"\n }\n ],\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
660
+ "title": "Query the Supported Database Proxy Versions"
661
+ }
662
+ ],
663
+ "DescribeTasks": [
664
+ {
665
+ "document": "This example shows you how to query the task list.",
666
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTasks\n<Common request parameters>\n\n{\n \"Limit\": 1,\n \"Offset\": 0\n}",
667
+ "output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"TaskList\": [\n {\n \"ID\": 1,\n \"AppId\": 23623651237,\n \"ClusterId\": \"cynoadbmysql-ydtwlxig\",\n \"CreateTime\": \"2024-10-01 23:22:54\",\n \"DelayTime\": \"2024-10-12 17:52:19\",\n \"ErrMsg\": \"\",\n \"FlowId\": 6521,\n{ \"Input\": \"{\\\"AppId\\\":251232125,\\\"uin\\\":\\\"700000433509\\\",\\\"operateUin\\\":\\\"700000433509\\\",\\\"region\\\":1,\\\"zoneId\\\":100007,\\\"dealName\\\":\\\"20240627509001289127581\\\",\\\"bigDealId\\\":\\\"20240627509001289141381\\\",\\\"tranId\\\":\\\"20240627509001289127591\\\",\\\"productCode\\\":\\\"p_cynosdb\\\",\\\"subProductCode\\\":\\\"sp_cynosdb_mysql\\\",\\\"payMode\\\":0,\\\"projectId\\\":0,\\\"goodsDetail\\\":{\\\"requestId\\\":\\\"3d56fe0b-f839-42c6-b84e-1d5fbc874cba\\\",\\\"Action\\\":\\\"CreateMultiSpecClusters\\\",\\\"pid\\\":1001166,\\\"extparam\\\":{\\\"token\\\":\\\"\\\"},\\\"timeSpan\\\":3600,\\\"timeUnit\\\":\\\"s\\\",\\\"productCode\\\":\\\"p_cynosdb\\\",\\\"subProductCode\\\":\\\"sp_cynosdb_mysql\\\",\\\"goodsNum\\\":1,\\\"sv_cynosdb_cpu_mysql\\\":1,\\\"sv_cynosdb_memory_mysql\\\":1,\\\"sv_cynosdb_cpu_smallcommoncpu\\\":0,\\\"sv_cynosdb_memory_smallcommonmem\\\":0,\\\"sv_cynosdb_cpu_largecommoncpu\\\":0,\\\"sv_cynosdb_memory_largecommonmem\\\":0,\\\"sv_cynosdb_storage_mysql\\\":0,\\\"sv_cynosdb_ccu_mysql\\\":0,\\\"resourceTags\\\":[{\\\"tagKey\\\":\\\"mockTagKey\\\",\\\"tagValue\\\":\\\"mockTagValue\\\"}],\\\"productInfo\\\":[{\\\"name\\\":\\\"Configuration\\\",\\\"value\\\":\\\"1 core, 1 GB Memory\\\"},{\\\"name\\\":\\\"Region\\\",\\\"value\\\":\\\"ap-guangzhou\\\"},{\\\"name\\\":\\\"Availability zone\\\",\\\"value\\\":\\\"ap-guangzhou-7\\\"}],\\\"zone\\\":\\\"ap-guangzhou-7\\\",\\\"source\\\":\\\"API\\\",\\\"slaveZone\\\":\\\"\\\",\\\"businessType\\\":\\\"\\\",\\\"vpcId\\\":\\\"vpc-rhfuibtt\\\",\\\"subnetId\\\":\\\"subnet-87qviva4\\\",\\\"dbType\\\":\\\"MYSQL\\\",\\\"dbVersion\\\":\\\"5.7\\\",\\\"cynosVersion\\\":\\\"\\\",\\\"clusterName\\\":\\\"Postpaid cluster\\\",\\\"adminPassword\\\":\\\"Abcde@123\\\",\\\"port\\\":3306,\\\"count\\\":1,\\\"haCount\\\":0,\\\"instanceCount\\\":1,\\\"storageTraceId\\\":\\\"\\\",\\\"storagePayMode\\\":0,\\\"rollbackStrategy\\\":\\\"noneRollback\\\",\\\"OrderSource\\\":\\\"go_test\\\",\\\"isLhdb\\\":\\\"no\\\",\\\"lhdbAppId\\\":0,\\\"isDisableConsole\\\":\\\"no\\\",\\\"sourcePlatform\\\":\\\"\\\",\\\"clusterParams\\\":[{\\\"ParamName\\\":\\\"character_set_server\\\",\\\"CurrentValue\\\":\\\"utf8\\\",\\\"OldValue\\\":\\\"\\\"},{\\\"ParamName\\\":\\\"collation_server\\\",\\\"CurrentValue\\\":\\\"utf8_general_ci\\\",\\\"OldValue\\\":\\\"\\\"}],\\\"ParamTemplateId\\\":0,\\\"instanceType\\\":\\\"rw\\\",\\\"clusterTraceId\\\":\\\"9642a74e-fa27-4f8f-b854-653b3083c4cb\\\",\\\"outside_invisible_is_skip_trade\\\":\\\"\\\",\\\"ClusterInstanceCount\\\":1}}\" }\n \"InstanceGrpId\": \"cynosdbmysql-grp-ywnxpisy\",\n \"InstanceGroupId\": \"cynosdbmysql-grp-ywnxpisy\",\n \"InstanceId\": \"cynosdbmysql-qjuxpows\",\n \"ObjectId\": \"cynosdbmysql-grwlskip\",\n \"ObjectType\": \"taskCreateCluster\",\n \"Operator\": \"700000433509\",\n \"Output\": \"{\\\"Storage\\\":3000}\",\n \"Status\": \"success\",\n \"TaskType\": \"taskCreateCluster\",\n \"TriggerTaskId\": 0,\n \"UpdateTime\": \"2024-06-27 16:18:12\",\n \"StartTime\": \"2024-06-27 16:18:07\",\n \"EndTime\": \"2024-06-27 16:18:12\",\n \"ClusterName\": \"MyClusterName\",\n \"InstanceName\": \"MyInstanceName\",\n \"Process\": 100,\n \"ModifyParamsData\": [\n {\n \"Name\": \"sql_auto_is_null\",\n \"OldValue\": \"OFF\",\n \"CurValue\": \"ON\"\n }\n ],\n \"CreateClustersData\": {\n \"Cpu\": 1,\n \"Memory\": 2,\n \"StorageLimit\": 200\n },\n \"RollbackData\": {\n \"Cpu\": 1,\n \"Memory\": 2,\n \"StorageLimit\": 200,\n \"OriginalClusterId\": \"cynosdbmysql-tiwgxyts\",\n \"OriginalClusterName\": \"MyOriginalClusterName\",\n \"RollbackStrategy\": \"timeRollback\",\n \"SnapshotTime\": \"2024-05-12 11:28:55\",\n \"MinCpu\": 2,\n \"MaxCpu\": 8,\n \"SnapShotId\": 5562,\n \"RollbackDatabases\": [\n {\n \"OldDatabase\": \"test_database\",\n \"NewDatabase\": \"new_test_database\"\n }\n ],\n \"RollbackTables\": [\n {\n \"Database\": \"test-database\",\n \"Tables\": [\n {\n \"OldTable\": \"test-table-1\",\n \"NewTable\": \"new-test-table-1\"\n }\n ]\n }\n ],\n \"BackupFileName\": \"cynosdbmysql-oaj6te97_20240610111357\"\n },\n \"ModifyInstanceData\": {\n \"Cpu\": 2,\n \"Memory\": 4,\n \"StorageLimit\": 400,\n \"OldCpu\": 1,\n \"OldMemory\": 2,\n \"OldStorageLimit\": 200,\n \"UpgradeType\": \"upgradeInMaintain\"\n },\n \"ManualBackupData\": {\n \"BackupType\": \"snapshot\",\n \"BackupMethod\": \"manual\",\n \"SnapshotTime\": \"2023-11-03 15:27:22\"\n },\n \"ModifyDbVersionData\": {\n \"OldVersion\": \"3.1.11\",\n \"NewVersion\": \"3.1.13\",\n \"UpgradeType\": \"upgradeInMaintain\"\n },\n \"ClusterSlaveData\": {\n \"OldMasterZone\": \"ap-guangzhou-4\",\n \"OldSlaveZone\": [\n \"ap-guangzhou-7\"\n ],\n \"NewMasterZone\": \"ap-guangzhou-7\",\n \"NewSlaveZone\": [\n \"ap-guangzhou-4\"\n ],\n \"NewSlaveZoneAttr\": [\n {\n \"Zone\": \"ap-guangzhou-4\",\n \"BinlogSyncWay\": \"sync\"\n }\n ],\n \"OldSlaveZoneAttr\": [\n {\n \"Zone\": \"ap-guangzhou-7\",\n \"BinlogSyncWay\": \"async\"\n }\n ]\n },\n \"SwitchClusterLogBin\": {\n \"Status\": \"OFF\"\n },\n \"ModifyInstanceParamsData\": {\n \"ClusterId\": \"cynosdbmysql-tiwgxyts\",\n \"ClusterParamList\": [\n {\n \"ParamName\": \"innodb_backquery_history_limit\",\n \"CurrentValue\": \"1100\",\n \"OldValue\": \"1000\"\n }\n ],\n \"ModifyInstanceParams\": [\n {\n \"InstanceId\": \"cynosdbmysql-ins-twpmnatl\",\n \"ModifyInstanceParamList\": [\n {\n \"ParamName\": \"innodb_secondary_evict_only_lru\",\n \"CurrentValue\": \"ON\",\n \"OldValue\": \"OFF\"\n }\n ]\n }\n ]\n },\n \"TaskMaintainInfo\": {\n \"MaintainStartTime\": 10800,\n \"MaintainDuration\": 3600,\n \"MaintainWeekDays\": [\n \"Mon\",\n \"Tue\",\n \"Wed\",\n \"Thu\",\n \"Fri\"\n ]\n }\n }\n ],\n \"RequestId\": \"3d56fe0b-f839-42c6-b84e-1d5fbc874cba\"\n }\n}",
668
+ "title": "Querying the Task List"
501
669
  }
502
670
  ],
503
671
  "DescribeZones": [
504
672
  {
505
- "document": "This example shows you how to only view AZs for which the user has permissions.",
673
+ "document": "This example shows you how to view only the availability zones that the user has the permission to access.",
506
674
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeZones\n<Common request parameters>\n\n{}",
507
- "output": "{\n \"Response\": {\n \"RegionSet\": [\n {\n \"DbType\": \"xx\",\n \"Region\": \"xx\",\n \"RegionId\": 1,\n \"Modules\": [\n {\n \"ModuleName\": \"xx\",\n \"IsDisable\": \"xx\"\n }\n ],\n \"RegionZh\": \"xx\",\n \"ZoneSet\": [\n {\n \"PhysicalZone\": \"xx\",\n \"Zone\": \"xx\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 100003,\n \"IsSupportNormal\": 0,\n \"ZoneZh\": \"xx\"\n },\n {\n \"PhysicalZone\": \"xx\",\n \"Zone\": \"xx\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 100003,\n \"IsSupportNormal\": 0,\n \"ZoneZh\": \"xx\"\n },\n {\n \"PhysicalZone\": \"xx\",\n \"Zone\": \"xx\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 100004,\n \"IsSupportNormal\": 0,\n \"ZoneZh\": \"xx\"\n }\n ]\n },\n {\n \"DbType\": \"xx\",\n \"Region\": \"xx\",\n \"RegionId\": 8,\n \"Modules\": [\n {\n \"ModuleName\": \"xx\",\n \"IsDisable\": \"xx\"\n }\n ],\n \"RegionZh\": \"xx\",\n \"ZoneSet\": [\n {\n \"PhysicalZone\": \"xx\",\n \"Zone\": \"xx\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 800001,\n \"IsSupportNormal\": 0,\n \"ZoneZh\": \"xx\"\n }\n ]\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
508
- "title": "Querying the AZ information in a purchasable region"
675
+ "output": "{\n \"Response\": {\n \"RegionSet\": [\n {\n \"DbType\": \"MYSQL\",\n \"Region\": \"ap-guangzhou\",\n \"RegionId\": 100001,\n \"Modules\": [\n {\n \"ModuleName\": \"is.disable.wan\",\n \"IsDisable\": \"yes\"\n }\n ],\n\"RegionZh\": \"Guangzhou\"\n \"ZoneSet\": [\n {\n \"PhysicalZone\": \"ap-guangzhou-3\",\n \"Zone\": \"ap-guangzhou-3\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 100003,\n \"IsSupportNormal\": 0,\n\"ZoneZh\": \"Guangzhou Zone 3\"\n \"HasPermission\": true,\n \"IsWholeRdmaZone\": \"tcp\",\n \"IsSupportCreateCluster\": 1\n },\n {\n \"PhysicalZone\": \"ao-guangzhou-5\",\n \"Zone\": \"ap-guangzhou-5\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 100004,\n \"IsSupportNormal\": 0,\n\"ZoneZh\": \"Guangzhou Zone 5\"\n \"HasPermission\": true,\n \"IsWholeRdmaZone\": \"whole_rdma\",\n \"IsSupportCreateCluster\": 0\n }\n ]\n },\n {\n \"DbType\": \"MYSQL\",\n \"Region\": \"ap-beijing\",\n \"RegionId\": 8,\n \"Modules\": [\n {\n \"ModuleName\": \"is.disable.wan\",\n \"IsDisable\": \"no\"\n }\n ],\n\"RegionZh\": \"Beijing\"\n \"ZoneSet\": [\n {\n \"PhysicalZone\": \"ap-beijing-5\",\n \"Zone\": \"ap-beijing-5\",\n \"IsSupportServerless\": 0,\n \"ZoneId\": 800001,\n \"IsSupportNormal\": 0,\n\"ZoneZh\": \"Beijing Zone 5\"\n \"HasPermission\": true,\n \"IsWholeRdmaZone\": \"whole_rdma\",\n \"IsSupportCreateCluster\": 1\n }\n ]\n }\n ],\n \"RequestId\": \"8fa5cf5-77db-4e32-90ef-22c71ed95f51\"\n }\n}",
676
+ "title": "Query Marketable Regional Availability Zone Information"
509
677
  }
510
678
  ],
511
679
  "ExportInstanceErrorLogs": [
512
680
  {
513
- "document": "This example shows you how to export the error logs.",
514
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ExportInstanceErrorLogs<common request parameters>{ \"InstanceId\": \"cynosdbmysql-ins-xxxxxxxx\", \"StartTime\": \"2019-07-04 16:45:32\", \"EndTime\": \"2019-07-04 16:55:32\", \"Limit\": 10, \"Offset\": 0, \"LogLevels\": [ \"error\" ], \"KeyWords\": [ \"abc\" ], \"FileType\": \"csv\", \"OrderBy\": \"Timestamp\", \"OrderByType\": \"ASC\"}",
515
- "output": "{\n \"Response\": {\n \"ErrorLogItems\": [\n {\n \"Timestamp\": \"2019-07-04 16:45:32\",\n \"Level\": \"error\",\n \"Content\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
516
- "title": "Exporting the error logs"
681
+ "document": "This example shows you how to export error logs.",
682
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportInstanceErrorLogs\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-xxxxxxxx\",\n \"StartTime\": \"2019-07-04 16:45:32\",\n \"EndTime\": \"2019-07-04 16:55:32\",\n \"Limit\": 10,\n \"Offset\": 0,\n \"LogLevels\": [\n \"error\"\n ],\n \"KeyWords\": [\n \"test_keyword\"\n ],\n \"FileType\": \"csv\",\n \"OrderBy\": \"Timestamp\",\n \"OrderByType\": \"ASC\"\n}",
683
+ "output": "{\n \"Response\": {\n \"ErrorLogItems\": [\n {\n \"Timestamp\": \"2019-07-04 16:45:32\",\n \"Level\": \"error\",\n \"Content\": \"Got an error reading communication packets\"\n }\n ],\n \"RequestId\": \"93b9d0b7-3921-4464-a70b-a8337f40cb39\"\n }\n}",
684
+ "title": "Export Error Log"
517
685
  }
518
686
  ],
519
687
  "ExportInstanceSlowQueries": [
520
688
  {
521
689
  "document": " ",
522
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportInstanceSlowQueries\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-xxxxxxxx\",\n \"StartTime\": \"2022-01-01 00:00:00\",\n \"EndTime\": \"2022-01-01 23:59:59\",\n \"Offset\": 0,\n \"Limit\": 100,\n \"Username\": \"root\",\n \"Database\": \"db\",\n \"FileType\": \"csv\"\n}",
523
- "output": "{\n \"Response\": {\n \"FileContent\": \"xxxx\",\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
524
- "title": "Exporting the slow logs of an instance"
690
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportInstanceSlowQueries\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-93sj6l7d\",\n \"StartTime\": \"2024-10-11 16:36:18\",\n \"EndTime\": \"2024-10-12 16:36:18\",\n \"Offset\": 0,\n \"Limit\": 1,\n \"Username\": \"root\",\n \"Database\": \"db\",\n \"FileType\": \"csv\"\n}",
691
+ "output": "{\n \"Response\": {\n\"FileContent\": \"execution time,SQL statement,client IP address,userName,database name,execution duration (seconds),lock duration (seconds),number of parsed rows,number of rows returned,remote reading count,number of remote read bytes,time spent on remote reads (micros),remote write count,number of remote written bytes,time spent on remote writes (micros),transaction submission delay (micros) 2024-10-11 16:36:18,\\\"INSERT IGNORE INTO sbtest14(id, k, c, pad) VALUES(NULL, 779102\\\",1.1.1.1,root,db,1.227114,0.000003,0,0,0,0,0,0,0,0,0\"\n \"RequestId\": \"9e56617c-c7cc-44e1-a967-6beb418ad5e7\"\n }\n}",
692
+ "title": "Export the Slow Logs of an Instance"
693
+ }
694
+ ],
695
+ "ExportResourcePackageDeductDetails": [
696
+ {
697
+ "document": "This example shows you how to export resource package usage details.",
698
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportResourcePackageDeductDetails\n<Common request parameters>\n\n{\n \"PackageId\": \"package-abcd1234\",\n \"ClusterIds\": [\n \"cynosdbmysql-bcdz3214\"\n ],\n \"OrderBy\": \"createTime\",\n \"OrderByType\": \"desc\",\n \"StartTime\": \"2022-01-01 01:01:01\",\n \"EndTime\": \"2024-01-01 01:01:01\",\n \"Limit\": \"100\",\n \"Offset\": \"0\"\n}",
699
+ "output": "{\n \"Response\": {\n \"FileContent\": \"2022-01-01 01:01:01,package-abcd1234,200.00,1298.98,cynosdbmysql-cdba4312\\n2022-01-01 01:02:01,package-abcd1234,200.00,1498.98,cynosdbmysql-cdba4354\",\n \"RequestId\": \"abc\"\n }\n}",
700
+ "title": "ExportResourcePackageDeductDetails"
525
701
  }
526
702
  ],
527
703
  "InquirePriceCreate": [
@@ -532,28 +708,44 @@
532
708
  "title": "Querying the purchasable price of a cluster"
533
709
  }
534
710
  ],
711
+ "InquirePriceModify": [
712
+ {
713
+ "document": "Use this API to perform price inquiries for adjusting prepaid resources. For price inquiries on adjusting the specification of postpaid resources, directly use the InquirePriceCreate API.",
714
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceModify\n<Common request parameters>\n\n{\n \"Cpu\": 0,\n \"Memory\": 0,\n \"StorageLimit\": 0,\n \"ClusterId\": \"cynosdbmysql-j9i41hdd\",\n \"InstanceId\": \"cynosdbmysql-ins-4vdtei11\"\n}",
715
+ "output": "{\n \"Response\": {\n \"InstancePrice\": {\n \"TotalPrice\": 0,\n \"Discount\": 0,\n \"TotalPriceDiscount\": 0,\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0,\n \"ChargeUnit\": \"\"\n },\n \"StoragePrice\": {\n \"TotalPrice\": 0,\n \"Discount\": 0,\n \"TotalPriceDiscount\": 0,\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0,\n \"ChargeUnit\": \"GB*h\"\n },\n \"RequestId\": \"8f291dbc-3840-40f9-aa39-841437c247fb\"\n }\n}",
716
+ "title": "Query the Price for Resizing Prepaid Resources"
717
+ }
718
+ ],
719
+ "InquirePriceMultiSpec": [
720
+ {
721
+ "document": "",
722
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceMultiSpec\n<Common request parameters>\n\n{\n \"Zone\": \"ap-guangzhou-4\",\n \"InstancePayMode\": \"PREPAID\",\n \"StoragePayMode\": \"POSTPAID\",\n \"GoodsSpecs\": [\n {\n \"GoodsNum\": 1,\n \"Cpu\": 1,\n \"Memory\": 1,\n \"TimeSpan\": 1,\n \"TimeUnit\": \"m\"\n }\n ]\n}",
723
+ "output": "{\n \"Response\": {\n \"GoodsPrice\": [\n {\n \"GoodsSpec\": {\n \"Ccu\": 0,\n \"Cpu\": 1,\n \"DeviceType\": \"\",\n \"GoodsNum\": 1,\n \"Memory\": 1,\n \"StorageLimit\": 0,\n \"TimeSpan\": 1,\n \"TimeUnit\": \"m\"\n },\n \"InstancePrice\": {\n \"ChargeUnit\": \"m\",\n \"Discount\": 100,\n \"TotalPrice\": 6000,\n \"TotalPriceDiscount\": 6000,\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0\n },\n \"StoragePrice\": {\n \"ChargeUnit\": \"\",\n \"Discount\": 0,\n \"TotalPrice\": 0,\n \"TotalPriceDiscount\": 0,\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0\n }\n }\n ],\n \"RequestId\": \"b30bbeef-370b-4176c085\"\n }\n}",
724
+ "title": "Querying Multi-Specification Pricing"
725
+ }
726
+ ],
535
727
  "InquirePriceRenew": [
536
728
  {
537
729
  "document": " ",
538
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceRenew\n<Common request parameters>\n\n{\n \"ClusterId\": \"xxx\",\n \"TimeSpan\": 1,\n \"TimeUnit\": \"m\"\n}",
539
- "output": "{\n \"Response\": {\n \"Prices\": [\n {\n \"TotalPrice\": 0,\n \"TotalPriceDiscount\": 0,\n \"UnitPrice\": 0,\n \"Discount\": 0.0,\n \"UnitPriceDiscount\": 0,\n \"ChargeUnit\": \"xx\"\n }\n ],\n \"ClusterId\": \"xx\",\n \"RequestId\": \"xx\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-m3hy\"\n ],\n \"InstanceRealTotalPrice\": 0,\n \"StorageRealTotalPrice\": 0\n }\n}",
540
- "title": "Querying the renewal price of a cluster"
730
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: InquirePriceRenew\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-prao75jd\",\n \"TimeSpan\": 1,\n \"TimeUnit\": \"m\"\n}",
731
+ "output": "{\n \"Response\": {\n \"ClusterId\": \"cynosdbmysql-prao75jd\",\n \"InstanceIds\": [\n \"cynosdbmysql-ins-1rh1dodd\"\n ],\n \"InstanceRealTotalPrice\": 15686,\n \"Prices\": [\n {\n \"ChargeUnit\": \"m\",\n \"Discount\": 48.058876,\n \"TotalPrice\": 32640,\n \"TotalPriceDiscount\": 15686,\n \"UnitPrice\": 0,\n \"UnitPriceDiscount\": 0\n }\n ],\n \"RequestId\": \"bbcbe6f9-f8fc-40e6-ba0b-00301b48c8ff\",\n \"StorageRealTotalPrice\": 0\n }\n}",
732
+ "title": "Renew a Cluster and Request a Quotation"
541
733
  }
542
734
  ],
543
735
  "IsolateCluster": [
544
736
  {
545
- "document": " ",
737
+ "document": "This example shows you how to isolate a cluster.",
546
738
  "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: IsolateCluster\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-bzxxrmtq\"\n}",
547
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\",\n \"DealNames\": [\n \"123\"\n ]\n }\n}",
548
- "title": "Isolating a cluster"
739
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": 147284,\n \"DealNames\": [\n \"20241226054077125855171\"\n ]\n }\n}",
740
+ "title": "Isolated Cluster"
549
741
  }
550
742
  ],
551
743
  "IsolateInstance": [
552
744
  {
553
- "document": " ",
554
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: IsolateInstance\n<Common request parameters>\n\n{\n \"InstanceIdList\": [\n \"cynosdbmysql-ixgbd0di\"\n ],\n \"ClusterId\": \"cynosdbmysql-ins-bzkxxrmt\"\n}",
555
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"DealNames\": [\n \"23456\"\n ],\n \"FlowId\": \"123\"\n }\n}",
556
- "title": "Isolating an instance"
745
+ "document": "",
746
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: IsolateInstance\n<common request parameters>\n\n{\n \"InstanceIdList\": [\n \"cynosdbmysql-ixgbd0di\"\n ],\n \"ClusterId\": \"cynosdbmysql-ins-bzkxxrmt\"\n}",
747
+ "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"DealNames\": [\n \"23456\"\n ],\n \"FlowId\": 123\n }\n}",
748
+ "title": ""
557
749
  }
558
750
  ],
559
751
  "ModifyAccountDescription": [
@@ -566,26 +758,26 @@
566
758
  ],
567
759
  "ModifyAccountHost": [
568
760
  {
569
- "document": " ",
570
- "input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyAccountHost&ClusterId=cynosdbpg-on5xw0ni&Account.AccountName=admin&Account.Host=myHost&NewHost=xx&<common request parameters>",
571
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\"\n }\n}",
572
- "title": "Modifying the account host"
761
+ "document": "Modify account host",
762
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountHost\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-on5xw0ni\",\n \"NewHost\": \"192.168.12.15\",\n \"Account\": {\n \"AccountName\": \"tomo1\",\n \"Host\": \"%\"\n }\n}",
763
+ "output": "{\n \"Response\": {\n \"RequestId\": \"3558f586-4f83-4f3b-aabc-49d20126f657\"\n }\n}",
764
+ "title": "Modify Account Host"
573
765
  }
574
766
  ],
575
767
  "ModifyAccountPrivileges": [
576
768
  {
577
- "document": " ",
578
- "input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyAccountPrivileges&ClusterId=xxx&Account.AccountName=xxx&Account.Host=xx&GlobalPrivileges.0=xxx&<common request parameters>",
579
- "output": "{\n \"Response\": {\n \"RequestId\": \"147706\"\n }\n}",
580
- "title": "Modifying the account permissions"
769
+ "document": "Modify account database/table permissions",
770
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAccountPrivileges\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-xxxxxxx\",\n \"Account\": {\n \"AccountName\": \"andy\",\n \"Host\": \"1.1.1.1\"\n },\n \"GlobalPrivileges\": [\n \"CREATE\"\n ],\n \"DatabasePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"Privileges\": [\n \"DELETE\"\n ]\n }\n ],\n \"TablePrivileges\": [\n {\n \"Db\": \"testDb\",\n \"TableName\": \"testTable\",\n \"Privileges\": [\n \"DROP\"\n ]\n }\n ]\n}",
771
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}",
772
+ "title": "Modify Account Database and Table Permissions"
581
773
  }
582
774
  ],
583
775
  "ModifyAuditRuleTemplates": [
584
776
  {
585
- "document": " ",
586
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAuditRuleTemplates\n<Common request parameters>\n\n{\n \"RuleTemplateIds\": [\n \"cynosdb-rt-ws23fwu8\"\n ],\n \"RuleTemplateName\": \"wy\"\n}",
777
+ "document": "",
778
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyAuditRuleTemplates\n<common request parameters>\n\n{\n \"RuleTemplateIds\": [\n \"cynosdb-rt-ws23fwu8\"\n ],\n \"RuleTemplateName\": \"wy\"\n}",
587
779
  "output": "{\n \"Response\": {\n \"RequestId\": \"43-12121-812w1221213-62usf9093\"\n }\n}",
588
- "title": "Modifying an audit rule template"
780
+ "title": ""
589
781
  }
590
782
  ],
591
783
  "ModifyAuditService": [
@@ -598,10 +790,26 @@
598
790
  ],
599
791
  "ModifyBackupConfig": [
600
792
  {
601
- "document": "This example shows you how to modify the backup configuration.",
602
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupConfig\n<Common request parameters>\n\n{\n \"BackupTimeBeg\": \"7200\",\n \"ReserveDuration\": \"604800\",\n \"ClusterId\": \"cynosdbmysql-45knmnra\",\n &BackupTimeEnd=21600\n}",
793
+ "document": "This example shows you how to modify backup configuration.",
794
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupConfig\n<Common request parameters>\n\n{\n \"BackupTimeBeg\": 7200,\n \"ReserveDuration\": 604800,\n \"ClusterId\": \"cynosdbmysql-45knmnra\",\n \"BackupTimeEnd\": 21600\n}",
603
795
  "output": "{\n \"Response\": {\n \"RequestId\": \"6EF60BEC-0242-43AF-BB20-270359FB54A7\"\n }\n}",
604
- "title": "Modifying the backup configuration of a cluster"
796
+ "title": "Modify Cluster Backup Configuration"
797
+ }
798
+ ],
799
+ "ModifyBackupDownloadRestriction": [
800
+ {
801
+ "document": "",
802
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupDownloadRestriction\n<Common request parameters>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-2p3wjmzt\"\n ],\n \"LimitType\": \"NoLimit\",\n \"VpcComparisonSymbol\": \"\",\n \"IpComparisonSymbol\": \"\",\n \"LimitVpcs\": [],\n \"LimitIps\": []\n}",
803
+ "output": "{\n \"Response\": {\n \"RequestId\": \"1530aee8-5130-45ce-9f4e-dfb50a55e4d4\"\n }\n}",
804
+ "title": "Modify Cluster Download Limit"
805
+ }
806
+ ],
807
+ "ModifyBackupDownloadUserRestriction": [
808
+ {
809
+ "document": "",
810
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBackupDownloadUserRestriction\n<Common request parameters>\n\n{\n \"LimitType\": \"NoLimit\",\n \"VpcComparisonSymbol\": \"\",\n \"IpComparisonSymbol\": \"\",\n \"LimitVpcs\": [],\n \"LimitIps\": []\n}",
811
+ "output": "{\n \"Response\": {\n \"RequestId\": \"1530aee8-5130-45ce-9f4e-dfb50a55e4d4\"\n }\n}",
812
+ "title": "Modify the Backup File Limit in the User'S Current Region"
605
813
  }
606
814
  ],
607
815
  "ModifyBackupName": [
@@ -612,6 +820,14 @@
612
820
  "title": "Renaming a backup file"
613
821
  }
614
822
  ],
823
+ "ModifyBinlogConfig": [
824
+ {
825
+ "document": "This example shows you how to modify the binlog configuration message.",
826
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyBinlogConfig\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-grhvkwff\",\n \"BinlogConfig\": {\n \"BinlogSaveDays\": 0,\n \"BinlogCrossRegionsEnable\": \"yes\",\n \"BinlogCrossRegions\": [\n \"ap-guangzhou\"\n ]\n }\n}",
827
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}",
828
+ "title": "Modify binlog Configuration Information"
829
+ }
830
+ ],
615
831
  "ModifyBinlogSaveDays": [
616
832
  {
617
833
  "document": " ",
@@ -623,9 +839,9 @@
623
839
  "ModifyClusterDatabase": [
624
840
  {
625
841
  "document": " ",
626
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyClusterDatabase<common request parameters>{ \"OldUserHostPrivileges\": [ { \"DbUserName\": \"xx\", \"DbHost\": \"xx\", \"DbPrivilege\": \"xx\" } ], \"NewUserHostPrivileges\": [ { \"DbUserName\": \"xx\", \"DbHost\": \"xx\", \"DbPrivilege\": \"xx\" } ], \"ClusterId\": \"xx\", \"DbName\": \"xx\", \"Description\": \"xx\"}",
842
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterDatabase\n<Common request parameters>\n\n{\n \"OldUserHostPrivileges\": [\n {\n \"DbUserName\": \"dbandy\",\n \"DbHost\": \"1.1.1.1\",\n \"DbPrivilege\": \"create\"\n }\n ],\n \"NewUserHostPrivileges\": [\n {\n \"DbUserName\": \"dbandy\",\n \"DbHost\": \"1.1.11.1\",\n \"DbPrivilege\": \"delete\"\n }\n ],\n \"ClusterId\": \"cynosdbmysql-asd\",\n \"DbName\": \"Db1\",\n \"Description\": \"this is a dbtable\"\n}",
627
843
  "output": "{\n \"Response\": {\n \"RequestId\": \"f569bea2-0a51-11ec-af61-525400542aa6\"\n }\n}",
628
- "title": "Creating a database"
844
+ "title": "Create a Database"
629
845
  }
630
846
  ],
631
847
  "ModifyClusterName": [
@@ -647,25 +863,33 @@
647
863
  "ModifyClusterPasswordComplexity": [
648
864
  {
649
865
  "document": " ",
650
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyClusterPasswordComplexity<common request parameters>{ \"ValidatePasswordLength\": 0, \"ValidatePasswordMixedCaseCount\": 0, \"ValidatePasswordDictionary\": [ \"admin\" ], \"ClusterId\": \"cynosdbmysql-abcdxxxx\", \"ValidatePasswordNumberCount\": 0, \"ValidatePasswordSpecialCharCount\": 0, \"ValidatePasswordPolicy\": \"MEDIUM\"}",
651
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
652
- "title": "Modifying or enabling the password complexity for a cluster"
866
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterPasswordComplexity\n<Common request parameters>\n\n{\n \"ValidatePasswordLength\": 0,\n \"ValidatePasswordMixedCaseCount\": 0,\n \"ValidatePasswordDictionary\": [\n \"admin\"\n ],\n \"ClusterId\": \"cynosdbmysql-abcdxxxx\",\n \"ValidatePasswordNumberCount\": 0,\n \"ValidatePasswordSpecialCharCount\": 0,\n \"ValidatePasswordPolicy\": \"MEDIUM\"\n}",
867
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": \"147283\"\n }\n}",
868
+ "title": "Used to Modify/Enable the Cluster Password Complexity"
869
+ }
870
+ ],
871
+ "ModifyClusterReadOnly": [
872
+ {
873
+ "document": "",
874
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterReadOnly\n<Common request parameters>\n\n{\n \"ClusterIds\": [\n \"cynosdbmysql-jl17y89v\",\n \"cynosdbmysql-2d9pq38h\"\n ],\n \"ReadOnlyOperation\": \"ON\",\n \"IsInMaintainPeriod\": \"no\"\n}",
875
+ "output": "{\n \"Response\": {\n \"ClusterTaskIds\": [\n {\n \"ClusterId\": \"cynosdbmysql-jl17y89v\",\n \"TaskId\": \"176551\"\n },\n {\n \"ClusterId\": \"cynosdbmysql-2d9pq38h\",\n \"TaskId\": \"176552\"\n }\n ],\n \"RequestId\": \"48b7cd8a-f6dd-4e47-a78a-ssfff\"\n }\n}",
876
+ "title": "Modify the Cluster Read-Only Switch"
653
877
  }
654
878
  ],
655
879
  "ModifyClusterSlaveZone": [
656
880
  {
657
- "document": " ",
658
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterSlaveZone\n<Common request parameters>\n\n{\n \"ClusterId\": \"xx\",\n \"OldSlaveZone\": \"xx\",\n \"NewSlaveZone\": \"xxx\"\n}",
659
- "output": "{\n \"Response\": {\n \"FlowId\": \"123\",\n \"RequestId\": \"128046\"\n }\n}",
660
- "title": "Modifying the replica AZ"
881
+ "document": "",
882
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyClusterSlaveZone\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-asd\",\n \"OldSlaveZone\": \"ap-guangzhou-4\",\n \"NewSlaveZone\": \"ap-guangzhou-3\",\n \"BinlogSyncWay\": \"async\",\n \"SemiSyncTimeout\": 10000\n}",
883
+ "output": "{\n \"Response\": {\n \"FlowId\": 123,\n \"RequestId\": \"128046\"\n }\n}",
884
+ "title": "Modifies the replica AZ"
661
885
  }
662
886
  ],
663
887
  "ModifyDBInstanceSecurityGroups": [
664
888
  {
665
- "document": "This example shows you how to modify a security group.",
666
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDBInstanceSecurityGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"abc\",\n \"SecurityGroupIds\": [\n \"abc\"\n ],\n \"Zone\": \"abc\"\n}",
667
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
668
- "title": "Modifying security groups bound to instance"
889
+ "document": "This example shows you how to modify the security group that an instance is bound to.",
890
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDBInstanceSecurityGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-j8ynfcpgj\",\n \"SecurityGroupIds\": [\n \"sg-mnbv\"\n ],\n \"Zone\": \"ap-guangzhou-3\"\n}",
891
+ "output": "{\n \"Response\": {\n \"RequestId\": \"48fa5cf5-77db-4e32-90ef-22c71ed95f51\"\n }\n}",
892
+ "title": "Modify the Security Groups Bound to an Instance"
669
893
  }
670
894
  ],
671
895
  "ModifyInstanceName": [
@@ -684,6 +908,14 @@
684
908
  "title": "Modifying the instance parameters"
685
909
  }
686
910
  ],
911
+ "ModifyInstanceUpgradeLimitDays": [
912
+ {
913
+ "document": "",
914
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceUpgradeLimitDays\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-mwg7212w\",\n \"InstanceId\": \"cynosdbmysql-ins-m6f0hjkx\",\n \"UpgradeLimitDays\": 30\n}",
915
+ "output": "{\n \"Response\": {\n \"RequestId\": \"588fbc90-61a4-4125-bc70-65a3f8d1327e\"\n }\n}",
916
+ "title": "Modify the Time Limit for Minor Version Upgrade of an Instance"
917
+ }
918
+ ],
687
919
  "ModifyMaintainPeriodConfig": [
688
920
  {
689
921
  "document": " ",
@@ -694,10 +926,10 @@
694
926
  ],
695
927
  "ModifyParamTemplate": [
696
928
  {
697
- "document": "This example shows you how to modify a parameter template.",
698
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyParamTemplate<common request parameters>{ \"TemplateDescription\": \"Do not delete\", \"TemplateId\": \"94\", \"ParamList\": [ { \"CurrentValue\": \"1024\", \"ParamName\": \"query_cache_size\" } ], \"TemplateName\": \"v5.7 common parameter template-do not delete\"}",
929
+ "document": "This API is used to modify a parameter template.",
930
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyParamTemplate\n<Common request parameters>\n\n{\n\"TemplateDescription\": \"Do not delete\"\n \"TemplateId\": 94,\n \"ParamList\": [\n {\n \"CurrentValue\": \"1024\",\n \"ParamName\": \"query_cache_size\"\n }\n ],\n\"TemplateName\": \"Common Parameter Template for 5.7 - Do Not Delete\"\n}",
699
931
  "output": "{\n \"Response\": {\n \"RequestId\": \"916e8185-4749-45af-899f-e57043164675\"\n }\n}",
700
- "title": "Modifying a parameter template"
932
+ "title": "This API is used to modify a parameter template."
701
933
  }
702
934
  ],
703
935
  "ModifyProxyDesc": [
@@ -710,50 +942,72 @@
710
942
  ],
711
943
  "ModifyProxyRwSplit": [
712
944
  {
713
- "document": "This API is used to configure the read/write separation of a database proxy.",
714
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxyRwSplit\n<Common request parameters>\n\n{\n \"ClusterId\": \"abc\",\n \"ProxyGroupId\": \"abc\",\n \"ConsistencyType\": \"abc\",\n \"ConsistencyTimeOut\": \"abc\",\n \"WeightMode\": \"abc\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"abc\",\n \"Weight\": 0\n }\n ],\n \"FailOver\": \"abc\",\n \"AutoAddRo\": \"abc\",\n \"OpenRw\": \"abc\",\n \"RwType\": \"abc\",\n \"TransSplit\": true,\n \"AccessMode\": \"abc\",\n \"OpenConnectionPool\": \"abc\",\n \"ConnectionPoolType\": \"abc\",\n \"ConnectionPoolTimeOut\": 0\n}",
715
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"RequestId\": \"abc\"\n }\n}",
716
- "title": "This API is used to configure the read/write separation of a database proxy."
945
+ "document": "This example shows you how to configure read-write separation for the database proxy.",
946
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyProxyRwSplit\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-dnofdr2d\",\n \"ProxyGroupId\": \"cynosdbmysql-proxy-4378e0kd\",\n \"ConsistencyType\": \"eventual\",\n \"ConsistencyTimeOut\": \"10\",\n \"WeightMode\": \"system\",\n \"InstanceWeights\": [\n {\n \"InstanceId\": \"cynosdbmysql-ins-c2twj0qf\",\n \"Weight\": 0\n }\n ],\n \"FailOver\": \"\",\n \"AutoAddRo\": \"yes\",\n \"OpenRw\": \"yes\",\n \"RwType\": \"READONLY\",\n \"TransSplit\": true,\n \"AccessMode\": \"nearby\",\n \"OpenConnectionPool\": \"yes\",\n \"ConnectionPoolType\": \"SessionConnectionPool\",\n \"ConnectionPoolTimeOut\": 0\n}",
947
+ "output": "{\n \"Response\": {\n \"FlowId\": 134762,\n \"TaskId\": 146783,\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
948
+ "title": "Configure Read-Write Separation for Database Proxy"
717
949
  }
718
950
  ],
719
951
  "ModifyResourcePackageClusters": [
720
952
  {
721
- "document": "This example shows you how to bind a resource pack to a cluster.",
722
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyResourcePackageClusters<common request parameters>{ \"PackageId\": \"abc\", \"BindClusterIds\": [ \"abc\" ], \"UnbindClusterIds\": [ \"abc\" ]}",
723
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
724
- "title": "Binding a resource pack to a cluster"
953
+ "document": "This example shows you how to bind a cluster to a resource package.",
954
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResourcePackageClusters\n<Common request parameters>\n\n{\n \"PackageId\": \"package-3crr5ldh\",\n \"BindClusterIds\": [\n \"cynosdbmysql-mwg7121t\"\n ],\n \"UnbindClusterIds\": [\n \"cynosdbmysql-kueh122w\"\n ]\n}",
955
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
956
+ "title": "Bind a Cluster to a Resource Package"
725
957
  }
726
958
  ],
727
959
  "ModifyResourcePackageName": [
728
960
  {
729
- "document": "This example shows you how to modify the name of a resource pack.",
730
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifySourcePackageName<common request parameters>{ \"PackageId\": \"abc\", \"PackageName\": \"abc\"}",
961
+ "document": "This example shows you how to modify resource package name.",
962
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifySourcePackageName\n<Common request parameters>\n\n{\n \"PackageId\": \"package-aqmi9bfd\",\n \"PackageName\": \"custom resource package name-1\"\n}",
963
+ "output": "{\n \"Response\": {\n \"RequestId\": \"93c96481-e37c-49f7-aeb5-907ee97a198c\"\n }\n}",
964
+ "title": "Modify Resource Package Name"
965
+ }
966
+ ],
967
+ "ModifyResourcePackagesDeductionPriority": [
968
+ {
969
+ "document": "Modification of the priority of resource package deduction for already bound resources",
970
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResourcePackagesDeductionPriority\n<Common request parameters>\n\n{\n \"PackageType\": \"CCU\",\n \"ClusterId\": \"cynosdbmysql-abcd1234\",\n \"DeductionPriorities\": [\n {\n \"PackageId\": \"package-abcd1234\",\n \"DeductionPriority\": 1\n }\n ]\n}",
731
971
  "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
732
- "title": "Modifying the name of a resource pack"
972
+ "title": "ModifyResourcePackagesDeductionPriority"
973
+ }
974
+ ],
975
+ "ModifyServerlessStrategy": [
976
+ {
977
+ "document": "Modification of serverless policy",
978
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyServerlessStrategy\n<Common request parameters>\n\n{\n \"AutoPause\": \"no\",\n \"AutoScaleUpDelay\": 200,\n \"AutoPauseDelay\": 100,\n \"MinCpu\": 0.25,\n \"MaxCpu\": 2,\n \"ClusterId\": \"cynosdbmysql-8vcxoq75\",\n \"AutoScaleDownDelay\": 300\n}",
979
+ "output": "{\n \"Response\": {\n \"FlowId\": 1008300,\n \"RequestId\": \"c3da7958-23e8-11eb-8e52-525400b7dd5a\"\n }\n}",
980
+ "title": "Modification of serverless Policy"
981
+ },
982
+ {
983
+ "document": "This example shows you how to adjust the primary node.",
984
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyServerlessStrategy\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-92oecwyv\",\n \"MinCpu\": 2,\n \"MaxCpu\": 2\n}",
985
+ "output": "{\n \"Response\": {\n \"FlowId\": 917319,\n \"RequestId\": \"a7ef1e81-e306-45fd-ab3d-37a6ae7ecf96\"\n }\n}",
986
+ "title": "Update the serverless Policy"
733
987
  }
734
988
  ],
735
989
  "ModifyVipVport": [
736
990
  {
737
991
  "document": " ",
738
- "input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyVipVport\n&ClusterId=xxx\n&InstanceGrpId=xxx\n&Vip=xx.xx.xx.xx\n&<Common request parameters>",
739
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
740
- "title": "Modifying an IP port"
992
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=ModifyVipVport\n&ClusterId=cynosdbmysql-mwg7121e\n&InstanceGrpId=cynosdbmysql-grp-o48ssqs5\n&Vip=172.1.1.1\n&<Common request parameters>",
993
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\",\n \"FlowId\": 134983\n }\n}",
994
+ "title": "Modify ip Port"
741
995
  }
742
996
  ],
743
997
  "OfflineCluster": [
744
998
  {
745
- "document": " ",
999
+ "document": "This example shows you how to terminate clusters.",
746
1000
  "input": "https://cynosdb.tencentcloudapi.com/?Action=OfflineCluster\n&ClusterId=cynosdbmysql-bzxxrmtq\n&<Common request parameters>",
747
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
748
- "title": "Deactivating a cluster"
1001
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": \"147286\"\n }\n}",
1002
+ "title": "Terminating Clusters"
749
1003
  }
750
1004
  ],
751
1005
  "OfflineInstance": [
752
1006
  {
753
- "document": " ",
1007
+ "document": "This example shows you how to terminate an instance.",
754
1008
  "input": "https://cynosdb.tencentcloudapi.com/?Action=OfflineInstance\n&ClusterId=cynosdbmysql-bzxxrmtq\n&InstanceIdList.0=cynosdbmysql-ins-7upukfpw\n&<Common request parameters>",
755
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
756
- "title": "Isolating an instance"
1009
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": \"147286\"\n }\n}",
1010
+ "title": "Terminating an Instance"
757
1011
  }
758
1012
  ],
759
1013
  "OpenAuditService": [
@@ -766,25 +1020,33 @@
766
1020
  ],
767
1021
  "OpenClusterPasswordComplexity": [
768
1022
  {
769
- "document": " ",
770
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: OpenClusterPasswordComplexity<common request parameters>{ \"ValidatePasswordLength\": 0, \"ValidatePasswordMixedCaseCount\": 0, \"ValidatePasswordDictionary\": [ \"admin\" ], \"ClusterId\": \"cynosdbmysql-abcdxxxx\", \"ValidatePasswordNumberCount\": 0, \"ValidatePasswordSpecialCharCount\": 0, \"ValidatePasswordPolicy\": \"MEDIUM\"}",
771
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
772
- "title": "Enabling the password complexity for a cluster"
1023
+ "document": "",
1024
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterPasswordComplexity\n<Common request parameters>\n\n{\n \"ValidatePasswordLength\": 0,\n \"ValidatePasswordMixedCaseCount\": 0,\n \"ValidatePasswordDictionary\": [\n \"admin\"\n ],\n \"ClusterId\": \"cynosdbmysql-abcdxxxx\",\n \"ValidatePasswordNumberCount\": 0,\n \"ValidatePasswordSpecialCharCount\": 0,\n \"ValidatePasswordPolicy\": \"MEDIUM\"\n}",
1025
+ "output": "{\n \"Response\": {\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\",\n \"FlowId\": \"147285\"\n }\n}",
1026
+ "title": "Enable the Custom Password Complexity Feature"
773
1027
  }
774
1028
  ],
775
1029
  "OpenClusterReadOnlyInstanceGroupAccess": [
776
1030
  {
777
- "document": "This example shows you how to enable the dedicated access for a read-only instance group in any scenario.",
778
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterReadOnlyInstanceGroupAccess\n<Common request parameters>\n\n{}",
779
- "output": "{\n \"Response\": {\n \"RequestId\": \"qwertyuiop\"\n }\n}",
1031
+ "document": "any scenario",
1032
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterReadOnlyInstanceGroupAccess\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-abcd1234\",\n \"Port\": \"3306\",\n \"SecurityGroupIds\": [\n \"SecurityGroupIds1\",\n \"SecurityGroupIds2\"\n ]\n}",
1033
+ "output": "{\n \"Response\": {\n \"FlowId\": \"147287\",\n \"RequestId\": \"51169b54-61d4-4604-a07e-e519a5527923\"\n }\n}",
780
1034
  "title": "ex:"
781
1035
  }
782
1036
  ],
1037
+ "OpenClusterTransparentEncrypt": [
1038
+ {
1039
+ "document": "",
1040
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenClusterTransparentEncrypt\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-3pd4zrvn\",\n \"KeyType\": \"cloud\"\n}",
1041
+ "output": "{\n \"Response\": {\n \"RequestId\": \"c66ada1a-0098-4787-8db8-42be0cee52cd\",\n \"TaskId\": 283\n }\n}",
1042
+ "title": "Use Cloud Products to Enable Transparent Data Encryption"
1043
+ }
1044
+ ],
783
1045
  "OpenReadOnlyInstanceExclusiveAccess": [
784
1046
  {
785
- "document": "This example shows you how to enable the dedicated access for a read-only instance in any scenario.",
786
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: OpenClusterPasswordComplexity<common request parameters>{ \"ValidatePasswordLength\": 0, \"ValidatePasswordMixedCaseCount\": 0, \"ValidatePasswordDictionary\": [ \"admin\" ], \"ClusterId\": \"cynosdbmysql-qwertyui\", \"InstanceId\": \"cynosdbmysql-ins-asdfghjk\", \"VpcId\": \"vpc-asdfghjk\", \"SubnetId\": \"subnet-qwertyui\", \"Port\": 3306, \"SecurityGroupIds\": [ \"SecurityGroupIds1\", \"SecurityGroupIds2\" ]}",
787
- "output": "{\n \"Response\": {\n \"FlowId\": \"12345\",\n \"RequestId\": \"123123123123123\"\n }\n}",
1047
+ "document": "Any scenario",
1048
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: OpenReadOnlyInstanceExclusiveAccess\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-qwertyui\",\n \"InstanceId\": \"cynosdbmysql-ins-asdfghjk\",\n \"VpcId\": \"vpc-asdfghjk\",\n \"SubnetId\": \"subnet-qwertyui\",\n \"Port\": 3306,\n \"SecurityGroupIds\": [\n \"SecurityGroupIds1\",\n \"SecurityGroupIds2\"\n ]\n}",
1049
+ "output": "{\n \"Response\": {\n \"FlowId\": 12345,\n \"RequestId\": \"123123123123123\"\n }\n}",
788
1050
  "title": "ex:"
789
1051
  }
790
1052
  ],
@@ -806,10 +1068,10 @@
806
1068
  ],
807
1069
  "RefundResourcePackage": [
808
1070
  {
809
- "document": "This example shows you how to refund a resource pack.\n",
810
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: RefundSourcePackage<common request parameters>{ \"PackageId\": \"abc\"}",
811
- "output": "{\n \"Response\": {\n \"DealNames\": [\n \"abc\"\n ],\n \"RequestId\": \"abc\"\n }\n}",
812
- "title": "Refund a resource pack"
1071
+ "document": "Refund a resource package\n",
1072
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RefundSourcePackage\n<Common request parameters>\n\n{\n \"PackageId\": \"package-jxdncifn\"\n}",
1073
+ "output": "{\n \"Response\": {\n \"DealNames\": [\n \"3164723785123674\"\n ],\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
1074
+ "title": "Refund Resource Package"
813
1075
  }
814
1076
  ],
815
1077
  "ReloadBalanceProxyNode": [
@@ -822,26 +1084,42 @@
822
1084
  ],
823
1085
  "RemoveClusterSlaveZone": [
824
1086
  {
825
- "document": " ",
826
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RemoveClusterSlaveZone\n<Common request parameters>\n\n{\n \"ClusterId\": \"xx\",\n \"SlaveZone\": \"xx\"\n}",
827
- "output": "{\n \"Response\": {\n \"FlowId\": \"123\",\n \"RequestId\": \"128046\"\n }\n}",
828
- "title": "Deleting the replica AZ"
1087
+ "document": "",
1088
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RemoveClusterSlaveZone\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdmysql-asd\",\n \"SlaveZone\": \"ap-guangzhou-4\"\n}",
1089
+ "output": "{\n \"Response\": {\n \"FlowId\": 123,\n \"RequestId\": \"128046\"\n }\n}",
1090
+ "title": ""
1091
+ }
1092
+ ],
1093
+ "RenewClusters": [
1094
+ {
1095
+ "document": "This example shows you how to renew a cluster.",
1096
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RenewClusters\n<Common request parameters>\n\n{\n \"TimeUnit\": \"m\",\n \"DealMode\": 0,\n \"ClusterId\": \"cynosdbmysql-grhvkwd\",\n \"TimeSpan\": 1\n}",
1097
+ "output": "{\n \"Response\": {\n \"BigDealIds\": [\n \"20241223054076837313781\",\n \"20241223054076837313781\"\n ],\n \"ClusterIds\": [\n \"cynosdbmysql-b6sy2i0oi\"\n ],\n \"DealNames\": [\n \"20241223054076837520111\",\n \"20241223054076837520121\"\n ],\n \"RequestId\": \"623f7cc5-ce5f-4f11-ad96-97bd07dad332\",\n \"ResourceIds\": [\n \"cynosdbmysql-ins-bx72i9ws\",\n \"cynosdbmysql-ins-i8g3n8xq\"\n ],\n \"TranId\": \"\"\n }\n}",
1098
+ "title": "Renew a Cluster"
1099
+ }
1100
+ ],
1101
+ "ReplayInstanceAuditLog": [
1102
+ {
1103
+ "document": "This example shows you how to replay an instance audit log.",
1104
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTasks\n<Common request parameters>\n\n{\n \"StartTime\": \"2025-06-26 14:00:00\",\n \"EndTime\": \"2025-06-26 16:00:00\",\n \"SourceClusterId\": \"cynosdbmysql-8j1jtwkv\",\n \"SourceInstanceId\": \"cynosdbmysql-ins-2fbftt98\",\n \"TargetClusterId\": \"cynosdbmysql-kwoft68f\",\n \"TargetInstanceId\": \"cynosdbmysql-ins-431w3zh0\",\n \"TargetUserName\": \"root\",\n \"TargetPassword\": \"Calebzhao123.\"\n}",
1105
+ "output": "{\n \"Response\": {\n \"RequestId\": \"y7rtl807j00d80oid44s34c100ros3iy\",\n \"TaskId\": 678\n }\n}",
1106
+ "title": "Replaying Instance Audit Logs"
829
1107
  }
830
1108
  ],
831
1109
  "ResetAccountPassword": [
832
1110
  {
833
- "document": " ",
834
- "input": "https://cynosdb.tencentcloudapi.com/?Action=ResetAccountPassword\n&ClusterId=cynosdbpg-on5xw0ni\n&AccountName=root\n&AccountPassword=abc@2018\n&<Common request parameters>",
1111
+ "document": "",
1112
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=ResetAccountPassword\n&ClusterId=cynosdbpg-on5xw0ni\n&AccountName=root\n&AccountPassword=abc@2018\n&<common request parameters>",
835
1113
  "output": "{\n \"Response\": {\n \"RequestId\": \"148561\"\n }\n}",
836
- "title": "Resetting the password of a TencentDB account."
1114
+ "title": ""
837
1115
  }
838
1116
  ],
839
1117
  "RestartInstance": [
840
1118
  {
841
- "document": " ",
842
- "input": "https://cynosdb.tencentcloudapi.com/?Action=RestartInstance\n&InstanceId=xxx\n&<Common request parameters>",
843
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
844
- "title": "Restarting an instance"
1119
+ "document": "Restarting Instances",
1120
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=RestartInstance\n&InstanceId=\"cynosdbmysql-ins-qwerasd\"\n&<Common request parameters>",
1121
+ "output": "{\n \"Response\": {\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\",\n \"FlowId\": \"147262\"\n }\n}",
1122
+ "title": "Restarting Instances"
845
1123
  }
846
1124
  ],
847
1125
  "ResumeServerless": [
@@ -852,12 +1130,28 @@
852
1130
  "title": "Resuming a serverless cluster"
853
1131
  }
854
1132
  ],
1133
+ "RollBackCluster": [
1134
+ {
1135
+ "document": "This example shows you how to perform a cluster rollback.",
1136
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollBackCluster\n<Common request parameters>\n\n{\n \"RollbackId\": 1,\n \"ClusterId\": \"cynosdbmysql-j9i41hff\",\n \"ExpectTimeThresh\": 1,\n \"RollbackStrategy\": \"snapRollback\",\n \"RollbackTables\": [\n {\n \"Tables\": [\n {\n \"OldTable\": \"old_table\",\n \"NewTable\": \"new_table\"\n }\n ],\n \"Database\": \"old_db1\"\n }\n ],\n \"ExpectTime\": \"2022-01-20 00:00:00\",\n \"RollbackDatabases\": [\n {\n \"NewDatabase\": \"new_db2\",\n \"OldDatabase\": \"old_db2\"\n }\n ]\n}",
1137
+ "output": "{\n \"Response\": {\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\",\n \"FlowId\": \"147283\"\n }\n}",
1138
+ "title": "Cluster Rollback"
1139
+ }
1140
+ ],
1141
+ "RollbackToNewCluster": [
1142
+ {
1143
+ "document": "This example shows you how to roll back to the new cluster.",
1144
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RollbackToNewCluster\n<Common request parameters>\n\n{\n \"Zone\": \"ap-guangzhou-3\",\n \"ClusterName\": \"\",\n \"ProjectId\": 0,\n \"PayMode\": 0,\n \"OriginalClusterId\": \"cynosdbmysql-0fs2nhc7\",\n \"RollbackId\": 64142,\n \"InstanceInitInfos\": [\n {\n \"Cpu\": 1,\n \"Memory\": 1,\n \"InstanceType\": \"rw\",\n \"InstanceCount\": 1\n }\n ],\n \"UniqVpcId\": \"vpc-ns1jr6ff\",\n \"UniqSubnetId\": \"subnet-gncsqeuq\"\n}",
1145
+ "output": "{\n \"Response\": {\n \"BigDealIds\": [],\n \"ClusterIds\": [],\n \"DealNames\": [\n \"20250928456021591536011\"\n ],\n \"RequestId\": \"0c646e65-3597-44d7-b68b-d43391eedb33\",\n \"ResourceIds\": [],\n \"TranId\": \"20250928456021591536021\"\n }\n}",
1146
+ "title": "Rollback to a New Cluster"
1147
+ }
1148
+ ],
855
1149
  "SearchClusterDatabases": [
856
1150
  {
857
- "document": " ",
858
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SearchClusterDatabases\n<Common request parameters>\n\n{\n \"ClusterId\": \"xxx\",\n \"Database\": \"xxx\"\n}",
859
- "output": "{\n \"Response\": {\n \"RequestId\": \"176466\",\n \"Databases\": []\n }\n}",
860
- "title": "Searching the list of cluster databases"
1151
+ "document": "",
1152
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SearchClusterDatabases\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-qwer\",\n \"Database\": \"testDb\"\n}",
1153
+ "output": "{\n \"Response\": {\n \"RequestId\": \"176466\",\n \"Databases\": [\n \"Db1\"\n ]\n }\n}",
1154
+ "title": "Search Cluster Database List"
861
1155
  }
862
1156
  ],
863
1157
  "SearchClusterTables": [
@@ -876,6 +1170,22 @@
876
1170
  "title": "Setting the auto-renewal flag"
877
1171
  }
878
1172
  ],
1173
+ "StartCLSDelivery": [
1174
+ {
1175
+ "document": "",
1176
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StartCLSDelivery\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"CLSTopicIds\": [\n \"83dc6703-f43a-4b95-92ec-267bdf9e48c3\",\n \"2a289122-0b01-490b-be75-763da79621fe\"\n ]\n}",
1177
+ "output": "{\n \"Response\": {\n \"TaskId\": 123456,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}",
1178
+ "title": "Enabling Log Shipping"
1179
+ }
1180
+ ],
1181
+ "StopCLSDelivery": [
1182
+ {
1183
+ "document": "",
1184
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: StopCLSDelivery\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-o971o62r\",\n \"CLSTopicIds\": [\n \"83dc6703-f43a-4b95-92ec-267bdf9e48c3\",\n \"2a289122-0b01-490b-be75-763da79621fe\"\n ]\n}",
1185
+ "output": "{\n \"Response\": {\n \"TaskId\": 123456,\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\"\n }\n}",
1186
+ "title": "Disabling Log Shipping"
1187
+ }
1188
+ ],
879
1189
  "SwitchClusterVpc": [
880
1190
  {
881
1191
  "document": "This example shows you how to switch network.",
@@ -886,10 +1196,10 @@
886
1196
  ],
887
1197
  "SwitchClusterZone": [
888
1198
  {
889
- "document": " ",
890
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SwitchClusterZone\n<Common request parameters>\n\n{\n \"ClusterId\": \"xx\",\n \"OldZone\": \"xx\",\n \"NewZone\": \"xx\",\n \"IsInMaintainPeriod\": \"yes\"\n}",
891
- "output": "{\n \"Response\": {\n \"FlowId\": \"123\",\n \"RequestId\": \"128046\"\n }\n}",
892
- "title": "Switching to the replica AZ"
1199
+ "document": "",
1200
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SwitchClusterZone\n<common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-asd\",\n \"OldZone\": \"ap-guangzhou-4\",\n \"NewZone\": \"ap-guangzhou-3\",\n \"IsInMaintainPeriod\": \"yes\"\n}",
1201
+ "output": "{\n \"Response\": {\n \"FlowId\": 123,\n \"RequestId\": \"128046\"\n }\n}",
1202
+ "title": "Switches to the replica AZ"
893
1203
  }
894
1204
  ],
895
1205
  "SwitchProxyVpc": [
@@ -902,34 +1212,34 @@
902
1212
  ],
903
1213
  "UnbindClusterResourcePackages": [
904
1214
  {
905
- "document": "This example shows you how to unbind a TDSQL-C for MySQL resource pack.",
906
- "input": "POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: UnbindSourcePackageCynos<common request parameters>{ \"ClusterId\": \"abc\", \"PackageIds\": [ \"abc\" ]}",
907
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
908
- "title": "Unbinding a TDSQL-C for MySQL resource pack"
1215
+ "document": "This example shows you how to unbind a resource package from cynos.",
1216
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UnbindSourcePackageCynos\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-0n6ib9tr\",\n \"PackageIds\": [\n \"package-3crr5lka\"\n ]\n}",
1217
+ "output": "{\n \"Response\": {\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
1218
+ "title": "Unbind a Resource Package From cynos"
909
1219
  }
910
1220
  ],
911
1221
  "UpgradeClusterVersion": [
912
1222
  {
913
- "document": " ",
914
- "input": "https://cynosdb.tencentcloudapi.com/?Action=UpgradeClusterVersion&ClusterId=xxx&CynosVersion=2.0.0&UpgradeType=upgradeImmediate&<common request parameters>",
915
- "output": "{\n \"Response\": {\n \"RequestId\": \"128046\",\n \"FlowId\": \"123\"\n }\n}",
916
- "title": "Upgrading TDSQL-C for MySQL kernel version"
1223
+ "document": "",
1224
+ "input": "https://cynosdb.tencentcloudapi.com/?Action=UpgradeClusterVersion\n&ClusterId=cynosdbmysql-qwerasd\n&CynosVersion=2.0.0\n&UpgradeType=upgradeImmediate\n&<Common request parameters>",
1225
+ "output": "{\n \"Response\": {\n \"RequestId\": \"347698da-03e4-4078-8d96-9a8b219c01a5\",\n \"FlowId\": \"1472831\"\n }\n}",
1226
+ "title": "Update the Kernel Minor Version"
917
1227
  }
918
1228
  ],
919
1229
  "UpgradeInstance": [
920
1230
  {
921
- "document": " ",
922
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-n7ocdslw\",\n \"UpgradeType\": \"upgradeImmediate\",\n \"Cpu\": \"2\",\n \"Memory\": \"4\"\n}",
923
- "output": "{\n \"Response\": {\n \"BigDealIds\": [\n \"xx\"\n ],\n \"RequestId\": \"165202\",\n \"TranId\": \"xx\",\n \"DealNames\": [\n \"xx\"\n ]\n }\n}",
924
- "title": "Upgrading an instance"
1231
+ "document": "",
1232
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeInstance\n<Common request parameters>\n\n{\n \"InstanceId\": \"cynosdbmysql-ins-n7ocdslw\",\n \"UpgradeType\": \"upgradeImmediate\",\n \"Cpu\": 2,\n \"Memory\": 4\n}",
1233
+ "output": "{\n \"Response\": {\n \"BigDealIds\": [],\n \"DealNames\": [\n \"20241025054071351304161\"\n ],\n \"RequestId\": \"588fbc90-61a4-4125-bc70-65a3f8d1327e\",\n \"TranId\": \"20241025054071351304171\"\n }\n}",
1234
+ "title": "Instance Configuration Adjustment"
925
1235
  }
926
1236
  ],
927
1237
  "UpgradeProxy": [
928
1238
  {
929
- "document": "This example shows you how to upgrade the configuration of database proxy.",
930
- "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"abc\",\n \"ProxyCount\": 0,\n \"Cpu\": 0,\n \"Mem\": 0,\n \"ProxyGroupId\": \"abc\",\n \"ReloadBalance\": \"abc\",\n \"IsInMaintainPeriod\": \"abc\",\n \"ProxyZones\": [\n {\n \"ProxyNodeZone\": \"abc\",\n \"ProxyNodeCount\": 0\n }\n ]\n}",
931
- "output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"TaskId\": 0,\n \"RequestId\": \"abc\"\n }\n}",
932
- "title": "This example shows you how to upgrade the configuration of database proxy."
1239
+ "document": "This example shows you how to upgrade the database proxy configuration.",
1240
+ "input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeProxy\n<Common request parameters>\n\n{\n \"ClusterId\": \"cynosdbmysql-dnofdr2d\",\n \"ProxyCount\": 2,\n \"Cpu\": 2,\n \"Mem\": 4,\n \"ProxyGroupId\": \"cynosdbmysql-proxy-4378e0kb\",\n \"ReloadBalance\": \"auto\",\n \"IsInMaintainPeriod\": \"no\",\n \"ProxyZones\": [\n {\n \"ProxyNodeZone\": \"ap-guangzhou-3\",\n \"ProxyNodeCount\": 2\n }\n ]\n}",
1241
+ "output": "{\n \"Response\": {\n \"FlowId\": 127635,\n \"TaskId\": 174673,\n \"RequestId\": \"a5706353-296a-4992-ad07-ac4a48eeba43\"\n }\n}",
1242
+ "title": "Upgrading Database Proxy Configuration"
933
1243
  }
934
1244
  ],
935
1245
  "UpgradeProxyVersion": [