tccli-intl-en 3.0.1188.1__py2.py3-none-any.whl → 3.1.28.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 (292) 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 +46 -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 +444 -272
  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 +1007 -139
  29. tccli/services/billing/v20180709/api.json +1707 -429
  30. tccli/services/billing/v20180709/examples.json +161 -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 +463 -208
  42. tccli/services/cdb/v20170320/examples.json +8 -8
  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/cdn/v20180606/api.json +22 -22
  48. tccli/services/cdn/v20180606/examples.json +1 -1
  49. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  50. tccli/services/cdwpg/cdwpg_client.py +120 -48
  51. tccli/services/cdz/__init__.py +4 -0
  52. tccli/services/cdz/cdz_client.py +210 -0
  53. tccli/services/cdz/v20221123/api.json +233 -0
  54. tccli/services/cdz/v20221123/examples.json +12 -0
  55. tccli/services/cfg/cfg_client.py +80 -32
  56. tccli/services/cfg/v20210820/api.json +30 -10
  57. tccli/services/cfg/v20210820/examples.json +1 -1
  58. tccli/services/cfs/cfs_client.py +195 -78
  59. tccli/services/cfw/cfw_client.py +330 -132
  60. tccli/services/chdfs/chdfs_client.py +145 -58
  61. tccli/services/ciam/ciam_client.py +80 -32
  62. tccli/services/ckafka/ckafka_client.py +1149 -259
  63. tccli/services/ckafka/v20190819/api.json +3738 -1696
  64. tccli/services/ckafka/v20190819/examples.json +266 -162
  65. tccli/services/clb/clb_client.py +1054 -469
  66. tccli/services/clb/v20180317/api.json +2273 -1020
  67. tccli/services/clb/v20180317/examples.json +184 -124
  68. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  69. tccli/services/cls/cls_client.py +434 -173
  70. tccli/services/cmq/cmq_client.py +14 -803
  71. tccli/services/cmq/v20190304/api.json +173 -1367
  72. tccli/services/cmq/v20190304/examples.json +0 -120
  73. tccli/services/config/config_client.py +30 -12
  74. tccli/services/controlcenter/controlcenter_client.py +229 -2
  75. tccli/services/controlcenter/v20230110/api.json +528 -5
  76. tccli/services/controlcenter/v20230110/examples.json +32 -0
  77. tccli/services/csip/csip_client.py +339 -78
  78. tccli/services/csip/v20221121/api.json +1011 -38
  79. tccli/services/csip/v20221121/examples.json +24 -0
  80. tccli/services/ctsdb/__init__.py +4 -0
  81. tccli/services/ctsdb/ctsdb_client.py +266 -0
  82. tccli/services/ctsdb/v20230202/api.json +677 -0
  83. tccli/services/ctsdb/v20230202/examples.json +20 -0
  84. tccli/services/cvm/cvm_client.py +706 -189
  85. tccli/services/cvm/v20170312/api.json +1003 -453
  86. tccli/services/cvm/v20170312/examples.json +176 -130
  87. tccli/services/cwp/cwp_client.py +2325 -930
  88. tccli/services/cynosdb/cynosdb_client.py +2272 -591
  89. tccli/services/cynosdb/v20190107/api.json +12480 -7740
  90. tccli/services/cynosdb/v20190107/examples.json +193 -9
  91. tccli/services/dataintegration/dataintegration_client.py +5 -2
  92. tccli/services/dayu/dayu_client.py +515 -206
  93. tccli/services/dbbrain/dbbrain_client.py +210 -84
  94. tccli/services/dc/dc_client.py +90 -36
  95. tccli/services/dcdb/dcdb_client.py +310 -124
  96. tccli/services/dlc/dlc_client.py +859 -214
  97. tccli/services/dlc/v20210125/api.json +637 -13
  98. tccli/services/dlc/v20210125/examples.json +48 -0
  99. tccli/services/dms/dms_client.py +10 -4
  100. tccli/services/dnspod/dnspod_client.py +390 -111
  101. tccli/services/dnspod/v20210323/api.json +196 -0
  102. tccli/services/dnspod/v20210323/examples.json +24 -0
  103. tccli/services/domain/domain_client.py +120 -48
  104. tccli/services/dts/dts_client.py +415 -166
  105. tccli/services/eb/eb_client.py +130 -52
  106. tccli/services/ecdn/ecdn_client.py +75 -30
  107. tccli/services/ecm/ecm_client.py +620 -248
  108. tccli/services/eiam/eiam_client.py +200 -80
  109. tccli/services/emr/emr_client.py +3104 -117
  110. tccli/services/emr/v20190103/api.json +15311 -4361
  111. tccli/services/emr/v20190103/examples.json +452 -42
  112. tccli/services/es/es_client.py +105 -42
  113. tccli/services/facefusion/facefusion_client.py +15 -6
  114. tccli/services/faceid/faceid_client.py +95 -38
  115. tccli/services/faceid/v20180301/api.json +172 -45
  116. tccli/services/faceid/v20180301/examples.json +3 -3
  117. tccli/services/gaap/gaap_client.py +440 -176
  118. tccli/services/gme/gme_client.py +50 -20
  119. tccli/services/gpm/gpm_client.py +90 -36
  120. tccli/services/gse/gse_client.py +110 -44
  121. tccli/services/gwlb/gwlb_client.py +90 -36
  122. tccli/services/hunyuan/__init__.py +4 -0
  123. tccli/services/hunyuan/hunyuan_client.py +490 -0
  124. tccli/services/hunyuan/v20230901/api.json +566 -0
  125. tccli/services/hunyuan/v20230901/examples.json +52 -0
  126. tccli/services/iai/iai_client.py +145 -58
  127. tccli/services/iai/v20200303/api.json +187 -51
  128. tccli/services/iai/v20200303/examples.json +30 -12
  129. tccli/services/iap/iap_client.py +30 -12
  130. tccli/services/ims/ims_client.py +5 -2
  131. tccli/services/ims/v20201229/api.json +133 -141
  132. tccli/services/ims/v20201229/examples.json +3 -3
  133. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +363 -78
  134. tccli/services/intlpartnersmgt/v20220928/api.json +513 -22
  135. tccli/services/intlpartnersmgt/v20220928/examples.json +24 -0
  136. tccli/services/iotcloud/iotcloud_client.py +100 -40
  137. tccli/services/iotcloud/v20210408/api.json +216 -107
  138. tccli/services/iotcloud/v20210408/examples.json +9 -9
  139. tccli/services/ip/ip_client.py +30 -12
  140. tccli/services/kms/kms_client.py +1226 -227
  141. tccli/services/kms/v20190118/api.json +1465 -123
  142. tccli/services/kms/v20190118/examples.json +129 -3
  143. tccli/services/lcic/lcic_client.py +265 -106
  144. tccli/services/lighthouse/lighthouse_client.py +730 -172
  145. tccli/services/lighthouse/v20200324/api.json +502 -14
  146. tccli/services/lighthouse/v20200324/examples.json +59 -5
  147. tccli/services/live/live_client.py +804 -232
  148. tccli/services/live/v20180801/api.json +272 -0
  149. tccli/services/live/v20180801/examples.json +32 -0
  150. tccli/services/lke/__init__.py +4 -0
  151. tccli/services/lke/lke_client.py +5194 -0
  152. tccli/services/lke/v20231130/api.json +14803 -0
  153. tccli/services/lke/v20231130/examples.json +736 -0
  154. tccli/services/lkeap/__init__.py +4 -0
  155. tccli/services/lkeap/lkeap_client.py +602 -0
  156. tccli/services/lkeap/v20240522/api.json +989 -0
  157. tccli/services/lkeap/v20240522/examples.json +92 -0
  158. tccli/services/mariadb/mariadb_client.py +250 -100
  159. tccli/services/mdc/mdc_client.py +90 -36
  160. tccli/services/mdl/mdl_client.py +402 -82
  161. tccli/services/mdl/v20200326/api.json +1437 -100
  162. tccli/services/mdl/v20200326/examples.json +48 -16
  163. tccli/services/mdp/mdp_client.py +785 -122
  164. tccli/services/mdp/v20200527/api.json +1336 -49
  165. tccli/services/mdp/v20200527/examples.json +151 -79
  166. tccli/services/message/__init__.py +4 -0
  167. tccli/services/message/message_client.py +210 -0
  168. tccli/services/message/v20181225/api.json +72 -0
  169. tccli/services/message/v20181225/examples.json +13 -0
  170. tccli/services/mongodb/mongodb_client.py +1452 -136
  171. tccli/services/mongodb/v20190725/api.json +4393 -1462
  172. tccli/services/mongodb/v20190725/examples.json +265 -71
  173. tccli/services/monitor/monitor_client.py +1008 -296
  174. tccli/services/monitor/v20180724/api.json +664 -15
  175. tccli/services/monitor/v20180724/examples.json +152 -4
  176. tccli/services/mps/mps_client.py +1878 -379
  177. tccli/services/mps/v20190612/api.json +7473 -1626
  178. tccli/services/mps/v20190612/examples.json +276 -82
  179. tccli/services/mqtt/__init__.py +4 -0
  180. tccli/services/mqtt/mqtt_client.py +1610 -0
  181. tccli/services/mqtt/v20240516/api.json +3057 -0
  182. tccli/services/mqtt/v20240516/examples.json +213 -0
  183. tccli/services/msp/msp_client.py +35 -14
  184. tccli/services/ocr/ocr_client.py +515 -74
  185. tccli/services/ocr/v20181119/api.json +1991 -168
  186. tccli/services/ocr/v20181119/examples.json +58 -4
  187. tccli/services/omics/omics_client.py +100 -40
  188. tccli/services/organization/organization_client.py +580 -232
  189. tccli/services/postgres/postgres_client.py +455 -182
  190. tccli/services/postgres/v20170312/api.json +134 -109
  191. tccli/services/postgres/v20170312/examples.json +14 -14
  192. tccli/services/privatedns/privatedns_client.py +206 -60
  193. tccli/services/privatedns/v20201028/api.json +179 -0
  194. tccli/services/privatedns/v20201028/examples.json +8 -0
  195. tccli/services/pts/pts_client.py +240 -96
  196. tccli/services/quota/__init__.py +4 -0
  197. tccli/services/quota/quota_client.py +434 -0
  198. tccli/services/quota/v20241204/api.json +548 -0
  199. tccli/services/quota/v20241204/examples.json +51 -0
  200. tccli/services/rce/rce_client.py +5 -2
  201. tccli/services/redis/redis_client.py +698 -212
  202. tccli/services/redis/v20180412/api.json +968 -563
  203. tccli/services/redis/v20180412/examples.json +98 -56
  204. tccli/services/region/__init__.py +4 -0
  205. tccli/services/region/region_client.py +322 -0
  206. tccli/services/region/v20220627/api.json +399 -0
  207. tccli/services/region/v20220627/examples.json +29 -0
  208. tccli/services/rum/rum_client.py +300 -120
  209. tccli/services/scf/scf_client.py +210 -84
  210. tccli/services/ses/ses_client.py +368 -69
  211. tccli/services/ses/v20201002/api.json +240 -0
  212. tccli/services/ses/v20201002/examples.json +32 -0
  213. tccli/services/smh/__init__.py +4 -0
  214. tccli/services/smh/smh_client.py +714 -0
  215. tccli/services/smh/v20210712/api.json +1287 -0
  216. tccli/services/smh/v20210712/examples.json +85 -0
  217. tccli/services/sms/sms_client.py +90 -36
  218. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  219. tccli/services/sqlserver/v20180328/api.json +9757 -3347
  220. tccli/services/sqlserver/v20180328/examples.json +480 -20
  221. tccli/services/ssl/ssl_client.py +504 -72
  222. tccli/services/ssl/v20191205/api.json +789 -21
  223. tccli/services/ssl/v20191205/examples.json +54 -0
  224. tccli/services/ssm/ssm_client.py +120 -48
  225. tccli/services/sts/sts_client.py +25 -10
  226. tccli/services/tag/tag_client.py +150 -60
  227. tccli/services/tat/tat_client.py +95 -38
  228. tccli/services/tbaas/tbaas_client.py +20 -8
  229. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  230. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  231. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  232. tccli/services/tchd/tchd_client.py +5 -2
  233. tccli/services/tcmpp/tcmpp_client.py +520 -208
  234. tccli/services/tcr/tcr_client.py +380 -152
  235. tccli/services/tcsas/tcsas_client.py +295 -118
  236. tccli/services/tcsas/v20250106/api.json +1084 -980
  237. tccli/services/tcsas/v20250106/examples.json +15 -15
  238. tccli/services/tcss/tcss_client.py +1650 -660
  239. tccli/services/tdid/tdid_client.py +240 -96
  240. tccli/services/tdmq/tdmq_client.py +2876 -466
  241. tccli/services/tdmq/v20200217/api.json +11607 -3958
  242. tccli/services/tdmq/v20200217/examples.json +562 -264
  243. tccli/services/tem/tem_client.py +280 -112
  244. tccli/services/teo/teo_client.py +4507 -966
  245. tccli/services/teo/v20220901/api.json +7341 -1405
  246. tccli/services/teo/v20220901/examples.json +679 -99
  247. tccli/services/tione/__init__.py +4 -0
  248. tccli/services/tione/tione_client.py +210 -0
  249. tccli/services/tione/v20211111/api.json +3074 -0
  250. tccli/services/tione/v20211111/examples.json +12 -0
  251. tccli/services/tiw/tiw_client.py +255 -102
  252. tccli/services/tke/tke_client.py +858 -276
  253. tccli/services/tke/v20180525/api.json +227 -0
  254. tccli/services/tke/v20180525/examples.json +24 -0
  255. tccli/services/tms/tms_client.py +5 -2
  256. tccli/services/tms/v20201229/api.json +91 -100
  257. tccli/services/tmt/tmt_client.py +5 -2
  258. tccli/services/trabbit/trabbit_client.py +145 -58
  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 +531 -54
  273. tccli/services/vod/v20180717/examples.json +25 -7
  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 +1428 -350
  277. tccli/services/vpc/v20170312/api.json +1031 -133
  278. tccli/services/vpc/v20170312/examples.json +119 -23
  279. tccli/services/vpc/vpc_client.py +2159 -644
  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/v20250806/api.json +13644 -0
  284. tccli/services/wedata/v20250806/examples.json +621 -0
  285. tccli/services/wedata/wedata_client.py +6067 -1263
  286. tccli/services/yunjing/yunjing_client.py +355 -142
  287. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/METADATA +4 -7
  288. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/RECORD +292 -232
  289. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/WHEEL +1 -1
  290. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/entry_points.txt +0 -1
  291. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/LICENSE +0 -0
  292. {tccli_intl_en-3.0.1188.1.dist-info → tccli_intl_en-3.1.28.1.dist-info}/top_level.txt +0 -0
@@ -365,7 +365,7 @@
365
365
  "status": "online"
366
366
  },
367
367
  "DescribeDBInstances": {
368
- "document": "This API (DescribeDBInstances) is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, access address, and instance status.",
368
+ "document": "This API is used to query the list of TencentDB for MySQL instances. It supports filtering instances by conditions such as project ID, instance ID, access address, and instance status. It also supports querying the list of information about primary instances, disaster recovery instances, and read-only instances.\nThis API is used to return the availability zone (AZ) status during purchase, which does not change along with the proactive HA switch. If you want to know the AZ status in real time, query through the [DescribeDBInstanceConfig](https://www.tencentcloud.comom/document/product/236/17491?from_cn_redirect=1) API.",
369
369
  "input": "DescribeDBInstancesRequest",
370
370
  "name": "Queries the list of instances",
371
371
  "output": "DescribeDBInstancesResponse",
@@ -1219,7 +1219,7 @@
1219
1219
  {
1220
1220
  "disabled": false,
1221
1221
  "document": "Address ID of the proxy group",
1222
- "example": "proxy-il2nlsdn",
1222
+ "example": "proxyadd-il2nlsdn",
1223
1223
  "member": "string",
1224
1224
  "name": "ProxyAddressId",
1225
1225
  "required": true,
@@ -1251,6 +1251,24 @@
1251
1251
  "name": "ProxyAllocation",
1252
1252
  "required": false,
1253
1253
  "type": "list"
1254
+ },
1255
+ {
1256
+ "disabled": false,
1257
+ "document": "",
1258
+ "example": "false",
1259
+ "member": "bool",
1260
+ "name": "AutoLoadBalance",
1261
+ "required": false,
1262
+ "type": "bool"
1263
+ },
1264
+ {
1265
+ "disabled": false,
1266
+ "document": "",
1267
+ "example": "balance",
1268
+ "member": "string",
1269
+ "name": "AccessMode",
1270
+ "required": false,
1271
+ "type": "string"
1254
1272
  }
1255
1273
  ],
1256
1274
  "type": "object"
@@ -1266,7 +1284,7 @@
1266
1284
  "name": "AsyncRequestId",
1267
1285
  "output_required": true,
1268
1286
  "type": "string",
1269
- "value_allowed_null": true
1287
+ "value_allowed_null": false
1270
1288
  },
1271
1289
  {
1272
1290
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -1386,6 +1404,92 @@
1386
1404
  ],
1387
1405
  "usage": "in"
1388
1406
  },
1407
+ "AnalysisNodeInfo": {
1408
+ "document": "Analysis engine node information.",
1409
+ "members": [
1410
+ {
1411
+ "disabled": false,
1412
+ "document": "Node ID.",
1413
+ "example": "libradbn-0",
1414
+ "member": "string",
1415
+ "name": "NodeId",
1416
+ "output_required": true,
1417
+ "type": "string",
1418
+ "value_allowed_null": false
1419
+ },
1420
+ {
1421
+ "disabled": false,
1422
+ "document": "Node status.",
1423
+ "example": "例如:\"applying\"、\"normal\"、\"deleting\"",
1424
+ "member": "string",
1425
+ "name": "Status",
1426
+ "output_required": false,
1427
+ "type": "string",
1428
+ "value_allowed_null": false
1429
+ },
1430
+ {
1431
+ "disabled": false,
1432
+ "document": "Data loading status.",
1433
+ "example": "例如:\"Created\"、\"Running\"、\"Paused\"、\"Stopped\"、\"Removed\"、\"Error\"",
1434
+ "member": "string",
1435
+ "name": "DataStatus",
1436
+ "output_required": false,
1437
+ "type": "string",
1438
+ "value_allowed_null": false
1439
+ },
1440
+ {
1441
+ "disabled": false,
1442
+ "document": "Number of CPU cores, in cores.",
1443
+ "example": "4",
1444
+ "member": "uint64",
1445
+ "name": "Cpu",
1446
+ "output_required": false,
1447
+ "type": "int",
1448
+ "value_allowed_null": false
1449
+ },
1450
+ {
1451
+ "disabled": false,
1452
+ "document": "Memory size, in MB.",
1453
+ "example": "16",
1454
+ "member": "uint64",
1455
+ "name": "Memory",
1456
+ "output_required": false,
1457
+ "type": "int",
1458
+ "value_allowed_null": false
1459
+ },
1460
+ {
1461
+ "disabled": false,
1462
+ "document": "Disk size, in GB.",
1463
+ "example": "100",
1464
+ "member": "uint64",
1465
+ "name": "Storage",
1466
+ "output_required": false,
1467
+ "type": "int",
1468
+ "value_allowed_null": false
1469
+ },
1470
+ {
1471
+ "disabled": false,
1472
+ "document": "Node AZ.",
1473
+ "example": "ap-guangzhou-7",
1474
+ "member": "string",
1475
+ "name": "Zone",
1476
+ "output_required": false,
1477
+ "type": "string",
1478
+ "value_allowed_null": false
1479
+ },
1480
+ {
1481
+ "disabled": false,
1482
+ "document": "Data synchronization error message.",
1483
+ "example": "Paused by Command",
1484
+ "member": "string",
1485
+ "name": "Message",
1486
+ "output_required": false,
1487
+ "type": "string",
1488
+ "value_allowed_null": false
1489
+ }
1490
+ ],
1491
+ "usage": "out"
1492
+ },
1389
1493
  "AnalyzeAuditLogsRequest": {
1390
1494
  "document": "AnalyzeAuditLogs request structure.",
1391
1495
  "members": [
@@ -2223,40 +2327,40 @@
2223
2327
  {
2224
2328
  "disabled": false,
2225
2329
  "document": "Replication mode of secondary database 2. Value range: async, semi-sync",
2226
- "example": "",
2330
+ "example": "async",
2227
2331
  "member": "string",
2228
2332
  "name": "ReplicationMode",
2229
- "required": true,
2333
+ "output_required": true,
2230
2334
  "type": "string",
2231
2335
  "value_allowed_null": false
2232
2336
  },
2233
2337
  {
2234
2338
  "disabled": false,
2235
- "document": "Name of the AZ of secondary database 2, such as ap-shanghai-1",
2236
- "example": "",
2339
+ "document": "Name of the AZ of secondary database 2, such as ap-shanghai-2",
2340
+ "example": "ap-shanghai-2",
2237
2341
  "member": "string",
2238
2342
  "name": "Zone",
2239
- "required": true,
2343
+ "output_required": true,
2240
2344
  "type": "string",
2241
2345
  "value_allowed_null": false
2242
2346
  },
2243
2347
  {
2244
2348
  "disabled": false,
2245
2349
  "document": "Private IP address of secondary database 2",
2246
- "example": "",
2350
+ "example": "172.1.1.1",
2247
2351
  "member": "string",
2248
2352
  "name": "Vip",
2249
- "required": true,
2353
+ "output_required": true,
2250
2354
  "type": "string",
2251
2355
  "value_allowed_null": false
2252
2356
  },
2253
2357
  {
2254
2358
  "disabled": false,
2255
2359
  "document": "Access port of secondary database 2",
2256
- "example": "",
2360
+ "example": "3306",
2257
2361
  "member": "uint64",
2258
2362
  "name": "Vport",
2259
- "required": true,
2363
+ "output_required": true,
2260
2364
  "type": "int",
2261
2365
  "value_allowed_null": false
2262
2366
  }
@@ -2881,7 +2985,7 @@
2881
2985
  "example": "1000",
2882
2986
  "member": "int64",
2883
2987
  "name": "Memory",
2884
- "required": true,
2988
+ "output_required": true,
2885
2989
  "type": "int",
2886
2990
  "value_allowed_null": false
2887
2991
  },
@@ -2891,7 +2995,7 @@
2891
2995
  "example": "1",
2892
2996
  "member": "int64",
2893
2997
  "name": "Cpu",
2894
- "required": true,
2998
+ "output_required": true,
2895
2999
  "type": "int",
2896
3000
  "value_allowed_null": false
2897
3001
  },
@@ -2901,7 +3005,7 @@
2901
3005
  "example": "50",
2902
3006
  "member": "int64",
2903
3007
  "name": "VolumeMin",
2904
- "required": true,
3008
+ "output_required": true,
2905
3009
  "type": "int",
2906
3010
  "value_allowed_null": false
2907
3011
  },
@@ -2911,7 +3015,7 @@
2911
3015
  "example": "3000",
2912
3016
  "member": "int64",
2913
3017
  "name": "VolumeMax",
2914
- "required": true,
3018
+ "output_required": true,
2915
3019
  "type": "int",
2916
3020
  "value_allowed_null": false
2917
3021
  },
@@ -2921,7 +3025,7 @@
2921
3025
  "example": "5",
2922
3026
  "member": "int64",
2923
3027
  "name": "VolumeStep",
2924
- "required": true,
3028
+ "output_required": true,
2925
3029
  "type": "int",
2926
3030
  "value_allowed_null": false
2927
3031
  },
@@ -2931,7 +3035,7 @@
2931
3035
  "example": "6000",
2932
3036
  "member": "int64",
2933
3037
  "name": "Iops",
2934
- "required": true,
3038
+ "output_required": true,
2935
3039
  "type": "int",
2936
3040
  "value_allowed_null": false
2937
3041
  },
@@ -2941,7 +3045,7 @@
2941
3045
  "example": "***",
2942
3046
  "member": "string",
2943
3047
  "name": "Info",
2944
- "required": true,
3048
+ "output_required": true,
2945
3049
  "type": "string",
2946
3050
  "value_allowed_null": false
2947
3051
  },
@@ -2951,7 +3055,7 @@
2951
3055
  "example": "0",
2952
3056
  "member": "int64",
2953
3057
  "name": "Status",
2954
- "required": true,
3058
+ "output_required": true,
2955
3059
  "type": "int",
2956
3060
  "value_allowed_null": false
2957
3061
  },
@@ -2961,9 +3065,9 @@
2961
3065
  "example": "UNIVERSAL",
2962
3066
  "member": "string",
2963
3067
  "name": "DeviceType",
2964
- "required": true,
3068
+ "output_required": true,
2965
3069
  "type": "string",
2966
- "value_allowed_null": true
3070
+ "value_allowed_null": false
2967
3071
  },
2968
3072
  {
2969
3073
  "disabled": false,
@@ -2971,7 +3075,7 @@
2971
3075
  "example": "InnoDB",
2972
3076
  "member": "string",
2973
3077
  "name": "EngineType",
2974
- "required": true,
3078
+ "output_required": true,
2975
3079
  "type": "string",
2976
3080
  "value_allowed_null": false
2977
3081
  },
@@ -2981,7 +3085,7 @@
2981
3085
  "example": "1",
2982
3086
  "member": "int64",
2983
3087
  "name": "Id",
2984
- "required": true,
3088
+ "output_required": true,
2985
3089
  "type": "int",
2986
3090
  "value_allowed_null": false
2987
3091
  }
@@ -2997,7 +3101,7 @@
2997
3101
  "example": "Z3",
2998
3102
  "member": "string",
2999
3103
  "name": "TypeName",
3000
- "required": true,
3104
+ "output_required": true,
3001
3105
  "type": "string",
3002
3106
  "value_allowed_null": false
3003
3107
  },
@@ -3007,7 +3111,7 @@
3007
3111
  "example": "[\"5.6\",\"5.7\"]",
3008
3112
  "member": "string",
3009
3113
  "name": "EngineVersion",
3010
- "required": true,
3114
+ "output_required": true,
3011
3115
  "type": "list",
3012
3116
  "value_allowed_null": false
3013
3117
  },
@@ -3017,7 +3121,7 @@
3017
3121
  "example": "[1,2,3]",
3018
3122
  "member": "int64",
3019
3123
  "name": "ConfigIds",
3020
- "required": true,
3124
+ "output_required": true,
3021
3125
  "type": "list",
3022
3126
  "value_allowed_null": false
3023
3127
  }
@@ -3066,7 +3170,7 @@
3066
3170
  {
3067
3171
  "disabled": false,
3068
3172
  "document": "AZ name",
3069
- "example": "广州二区",
3173
+ "example": "广州三区",
3070
3174
  "member": "string",
3071
3175
  "name": "ZoneName",
3072
3176
  "output_required": true,
@@ -3156,7 +3260,7 @@
3156
3260
  {
3157
3261
  "disabled": false,
3158
3262
  "document": "AZ name",
3159
- "example": "ap-guangzhou-2",
3263
+ "example": "ap-guangzhou-3",
3160
3264
  "member": "string",
3161
3265
  "name": "Zone",
3162
3266
  "output_required": true,
@@ -3166,7 +3270,7 @@
3166
3270
  {
3167
3271
  "disabled": false,
3168
3272
  "document": "Multi-AZ information",
3169
- "example": "{}",
3273
+ "example": "",
3170
3274
  "member": "ZoneConf",
3171
3275
  "name": "ZoneConf",
3172
3276
  "output_required": true,
@@ -3176,7 +3280,7 @@
3176
3280
  {
3177
3281
  "disabled": false,
3178
3282
  "document": "Information of supported disaster recovery AZs",
3179
- "example": "[\"ap-guangzhou-2\"]",
3283
+ "example": "[\"ap-guangzhou-3\"]",
3180
3284
  "member": "string",
3181
3285
  "name": "DrZone",
3182
3286
  "output_required": true,
@@ -3196,7 +3300,7 @@
3196
3300
  {
3197
3301
  "disabled": false,
3198
3302
  "document": "Information of supported cross-AZ read-only zone",
3199
- "example": "[\"ap-guangzhou-2\"]",
3303
+ "example": "[\"ap-guangzhou-3\"]",
3200
3304
  "member": "string",
3201
3305
  "name": "RemoteRoZone",
3202
3306
  "output_required": true,
@@ -3216,7 +3320,7 @@
3216
3320
  {
3217
3321
  "disabled": false,
3218
3322
  "document": "Information of cross-AZ read-only zones supported by a dedicated instance",
3219
- "example": "[\"ap-guangzhou-2\"]",
3323
+ "example": "[\"ap-guangzhou-3\"]",
3220
3324
  "member": "string",
3221
3325
  "name": "ExClusterRemoteRoZone",
3222
3326
  "output_required": true,
@@ -3226,7 +3330,7 @@
3226
3330
  {
3227
3331
  "disabled": false,
3228
3332
  "document": "AZ information of a multi-AZ deployed dedicated instance.",
3229
- "example": "{}",
3333
+ "example": "",
3230
3334
  "member": "ZoneConf",
3231
3335
  "name": "ExClusterZoneConf",
3232
3336
  "output_required": true,
@@ -3236,7 +3340,7 @@
3236
3340
  {
3237
3341
  "disabled": false,
3238
3342
  "document": "Array of purchasable instance types. The value of `configIds` and `configs` have a one-to-one correspondence.",
3239
- "example": "[]",
3343
+ "example": "",
3240
3344
  "member": "CdbSellType",
3241
3345
  "name": "SellType",
3242
3346
  "output_required": true,
@@ -3246,7 +3350,7 @@
3246
3350
  {
3247
3351
  "disabled": false,
3248
3352
  "document": "AZ ID",
3249
- "example": "200001",
3353
+ "example": "200002",
3250
3354
  "member": "int64",
3251
3355
  "name": "ZoneId",
3252
3356
  "output_required": true,
@@ -3256,7 +3360,7 @@
3256
3360
  {
3257
3361
  "disabled": false,
3258
3362
  "document": "Whether IPv6 is supported",
3259
- "example": "fasle",
3363
+ "example": "false",
3260
3364
  "member": "bool",
3261
3365
  "name": "IsSupportIpv6",
3262
3366
  "output_required": true,
@@ -3500,6 +3604,45 @@
3500
3604
  ],
3501
3605
  "type": "object"
3502
3606
  },
3607
+ "ClusterInfo": {
3608
+ "document": "Cluster Edition node information.",
3609
+ "members": [
3610
+ {
3611
+ "disabled": false,
3612
+ "document": "Node ID.",
3613
+ "example": "\"dbn-ipffzoum\"",
3614
+ "member": "string",
3615
+ "name": "NodeId",
3616
+ "output_required": false,
3617
+ "required": false,
3618
+ "type": "string",
3619
+ "value_allowed_null": false
3620
+ },
3621
+ {
3622
+ "disabled": false,
3623
+ "document": "Node type: primary node and secondary node.",
3624
+ "example": "\"master\"",
3625
+ "member": "string",
3626
+ "name": "Role",
3627
+ "output_required": false,
3628
+ "required": false,
3629
+ "type": "string",
3630
+ "value_allowed_null": false
3631
+ },
3632
+ {
3633
+ "disabled": false,
3634
+ "document": "Region.",
3635
+ "example": "\"ap-guangzhou\"",
3636
+ "member": "string",
3637
+ "name": "Zone",
3638
+ "output_required": false,
3639
+ "required": false,
3640
+ "type": "string",
3641
+ "value_allowed_null": false
3642
+ }
3643
+ ],
3644
+ "usage": "both"
3645
+ },
3503
3646
  "ColumnPrivilege": {
3504
3647
  "document": "Column permission information",
3505
3648
  "members": [
@@ -3855,7 +3998,7 @@
3855
3998
  {
3856
3999
  "disabled": false,
3857
4000
  "document": "Proxy group ID",
3858
- "example": "proxy-test",
4001
+ "example": "proxy-kti9m7m1",
3859
4002
  "member": "string",
3860
4003
  "name": "ProxyGroupId",
3861
4004
  "required": true,
@@ -3936,7 +4079,7 @@
3936
4079
  {
3937
4080
  "disabled": false,
3938
4081
  "document": "Assignment of read/write weights",
3939
- "example": "",
4082
+ "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-2\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\",\"Weight\": 100}]}]",
3940
4083
  "member": "ProxyAllocation",
3941
4084
  "name": "ProxyAllocation",
3942
4085
  "required": true,
@@ -3972,7 +4115,7 @@
3972
4115
  {
3973
4116
  "disabled": false,
3974
4117
  "document": "Description",
3975
- "example": "test",
4118
+ "example": "andy_proxy",
3976
4119
  "member": "string",
3977
4120
  "name": "Desc",
3978
4121
  "required": false,
@@ -3999,7 +4142,7 @@
3999
4142
  {
4000
4143
  "disabled": false,
4001
4144
  "document": "Security group",
4002
- "example": "",
4145
+ "example": "sg-4qvsxc1a",
4003
4146
  "member": "string",
4004
4147
  "name": "SecurityGroup",
4005
4148
  "required": false,
@@ -4013,6 +4156,24 @@
4013
4156
  "name": "ConnectionPoolType",
4014
4157
  "required": false,
4015
4158
  "type": "string"
4159
+ },
4160
+ {
4161
+ "disabled": false,
4162
+ "document": "",
4163
+ "example": "false",
4164
+ "member": "bool",
4165
+ "name": "AutoLoadBalance",
4166
+ "required": false,
4167
+ "type": "bool"
4168
+ },
4169
+ {
4170
+ "disabled": false,
4171
+ "document": "",
4172
+ "example": "nearBy",
4173
+ "member": "string",
4174
+ "name": "AccessMode",
4175
+ "required": false,
4176
+ "type": "string"
4016
4177
  }
4017
4178
  ],
4018
4179
  "type": "object"
@@ -4023,12 +4184,12 @@
4023
4184
  {
4024
4185
  "disabled": false,
4025
4186
  "document": "Async task ID Note: This field may return null, indicating that no valid values can be obtained.",
4026
- "example": "1312",
4187
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
4027
4188
  "member": "string",
4028
4189
  "name": "AsyncRequestId",
4029
4190
  "output_required": true,
4030
4191
  "type": "string",
4031
- "value_allowed_null": true
4192
+ "value_allowed_null": false
4032
4193
  },
4033
4194
  {
4034
4195
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
@@ -7412,7 +7573,7 @@
7412
7573
  "example": "0",
7413
7574
  "member": "int64",
7414
7575
  "name": "ProtectMode",
7415
- "required": true,
7576
+ "output_required": true,
7416
7577
  "type": "int",
7417
7578
  "value_allowed_null": false
7418
7579
  },
@@ -7422,17 +7583,17 @@
7422
7583
  "example": "1",
7423
7584
  "member": "int64",
7424
7585
  "name": "DeployMode",
7425
- "required": true,
7586
+ "output_required": true,
7426
7587
  "type": "int",
7427
7588
  "value_allowed_null": false
7428
7589
  },
7429
7590
  {
7430
7591
  "disabled": false,
7431
- "document": "Instance AZ information in the format of \"ap-shanghai-1\".",
7592
+ "document": "Instance AZ information in the format of \"ap-shanghai-2\".",
7432
7593
  "example": "ap-guangzhou-3",
7433
7594
  "member": "string",
7434
7595
  "name": "Zone",
7435
- "required": true,
7596
+ "output_required": true,
7436
7597
  "type": "string",
7437
7598
  "value_allowed_null": false
7438
7599
  },
@@ -7442,7 +7603,7 @@
7442
7603
  "example": "无",
7443
7604
  "member": "SlaveConfig",
7444
7605
  "name": "SlaveConfig",
7445
- "required": true,
7606
+ "output_required": true,
7446
7607
  "type": "object",
7447
7608
  "value_allowed_null": true
7448
7609
  },
@@ -7452,7 +7613,7 @@
7452
7613
  "example": "无",
7453
7614
  "member": "BackupConfig",
7454
7615
  "name": "BackupConfig",
7455
- "required": true,
7616
+ "output_required": true,
7456
7617
  "type": "object",
7457
7618
  "value_allowed_null": true
7458
7619
  },
@@ -7462,7 +7623,7 @@
7462
7623
  "example": "false",
7463
7624
  "member": "bool",
7464
7625
  "name": "Switched",
7465
- "required": true,
7626
+ "output_required": true,
7466
7627
  "type": "bool",
7467
7628
  "value_allowed_null": false
7468
7629
  },
@@ -7708,7 +7869,7 @@
7708
7869
  {
7709
7870
  "disabled": false,
7710
7871
  "document": "Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).",
7711
- "example": "1",
7872
+ "example": "[1]",
7712
7873
  "member": "uint64",
7713
7874
  "name": "InstanceTypes",
7714
7875
  "required": false,
@@ -7717,7 +7878,7 @@
7717
7878
  {
7718
7879
  "disabled": false,
7719
7880
  "document": "Private IP address of the instance.",
7720
- "example": "\"\"",
7881
+ "example": "[\"172.1.1.1\"]",
7721
7882
  "member": "string",
7722
7883
  "name": "Vips",
7723
7884
  "required": false,
@@ -7726,7 +7887,7 @@
7726
7887
  {
7727
7888
  "disabled": false,
7728
7889
  "document": "Instance status. Valid values: <br>`0` (creating) <br>`1` (running) <br>`4` (isolating) <br>`5` (isolated; the instance can be restored and started in the recycle bin)",
7729
- "example": "1",
7890
+ "example": "[1]",
7730
7891
  "member": "uint64",
7731
7892
  "name": "Status",
7732
7893
  "required": false,
@@ -7753,7 +7914,7 @@
7753
7914
  {
7754
7915
  "disabled": false,
7755
7916
  "document": "Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.",
7756
- "example": "\"\"",
7917
+ "example": "sg-ajr1jzgj",
7757
7918
  "member": "string",
7758
7919
  "name": "SecurityGroupId",
7759
7920
  "required": false,
@@ -7761,8 +7922,8 @@
7761
7922
  },
7762
7923
  {
7763
7924
  "disabled": false,
7764
- "document": "Billing method. Value range: 0 (monthly subscribed), 1 (hourly).",
7765
- "example": "1",
7925
+ "document": "Payment type. Valid values: 0 - yearly/monthly subscription; 1 - bill by hour.",
7926
+ "example": "[1]",
7766
7927
  "member": "uint64",
7767
7928
  "name": "PayTypes",
7768
7929
  "required": false,
@@ -7771,7 +7932,7 @@
7771
7932
  {
7772
7933
  "disabled": false,
7773
7934
  "document": "Instance name.",
7774
- "example": "\"\"",
7935
+ "example": "[\"cdb27418\"]",
7775
7936
  "member": "string",
7776
7937
  "name": "InstanceNames",
7777
7938
  "required": false,
@@ -7779,8 +7940,8 @@
7779
7940
  },
7780
7941
  {
7781
7942
  "disabled": false,
7782
- "document": "Instance task status. Valid values: <br>0 - no task <br>1 - upgrading <br>2 - importing data <br>3 - enabling secondary instance access <br>4 - enabling public network access <br>5 - batch operation in progress <br>6 - rolling back <br>7 - disabling public network access <br>8 - modifying password <br>9 - renaming instance <br>10 - restarting <br>12 - migrating self-built database <br>13 - dropping tables <br>14 - Disaster recovery instance creating sync task <br>15 - waiting for switch <br>16 - switching <br>17 - upgrade and switch completed <br>19 - parameter settings to be executed",
7783
- "example": "0",
7943
+ "document": "Instance task status. Valid values:<br>0 - no task;<br>1 - upgrading;<br>2 - importing data;<br>3 - enabling secondary nodes;<br>4 - enabling public network access;<br>5 - executing batch operations;<br>6 - rolling back;<br>7 - disabling public network access;<br>8 - changing the password;<br>9 - renaming the instance;<br>10 - restarting;<br>12 - migrating self-built databases;<br>13 - deleting databases and tables;<br>14 - synchronizing the creation of disaster recovery instances;<br>15 - pending upgrade switch;<br>16 - under upgrade switch;<br>17 - upgrade switch completed;<br>19 - parameter settings pending execution;<br>34 - in-place upgrade pending execution.",
7944
+ "example": "[0]",
7784
7945
  "member": "uint64",
7785
7946
  "name": "TaskStatus",
7786
7947
  "required": false,
@@ -7789,7 +7950,7 @@
7789
7950
  {
7790
7951
  "disabled": false,
7791
7952
  "document": "Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.",
7792
- "example": "\"5.6\"",
7953
+ "example": "[\"5.7\",\"8.0\"]",
7793
7954
  "member": "string",
7794
7955
  "name": "EngineVersions",
7795
7956
  "required": false,
@@ -7798,7 +7959,7 @@
7798
7959
  {
7799
7960
  "disabled": false,
7800
7961
  "document": "VPC ID.",
7801
- "example": "0",
7962
+ "example": "[0]",
7802
7963
  "member": "uint64",
7803
7964
  "name": "VpcIds",
7804
7965
  "required": false,
@@ -7807,7 +7968,7 @@
7807
7968
  {
7808
7969
  "disabled": false,
7809
7970
  "document": "AZ ID.",
7810
- "example": "720001",
7971
+ "example": "[720001]",
7811
7972
  "member": "uint64",
7812
7973
  "name": "ZoneIds",
7813
7974
  "required": false,
@@ -7816,7 +7977,7 @@
7816
7977
  {
7817
7978
  "disabled": false,
7818
7979
  "document": "Subnet ID.",
7819
- "example": "0",
7980
+ "example": "[0]",
7820
7981
  "member": "uint64",
7821
7982
  "name": "SubnetIds",
7822
7983
  "required": false,
@@ -7825,7 +7986,7 @@
7825
7986
  {
7826
7987
  "disabled": false,
7827
7988
  "document": "Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.",
7828
- "example": "0",
7989
+ "example": "[0]",
7829
7990
  "member": "int64",
7830
7991
  "name": "CdbErrors",
7831
7992
  "required": false,
@@ -7833,8 +7994,8 @@
7833
7994
  },
7834
7995
  {
7835
7996
  "disabled": false,
7836
- "document": "Sort by field of the returned result set. Currently, supported values include \"InstanceId\", \"InstanceName\", \"CreateTime\", and \"DeadlineTime\".",
7837
- "example": "\"\"",
7997
+ "document": "Sorting field of the query results. Valid values: \"instanceId\", \"instanceName\", \"createTime\", and \"deadlineTime\".",
7998
+ "example": "instanceId",
7838
7999
  "member": "string",
7839
8000
  "name": "OrderBy",
7840
8001
  "required": false,
@@ -7842,7 +8003,7 @@
7842
8003
  },
7843
8004
  {
7844
8005
  "disabled": false,
7845
- "document": "Sorting method of the returned result set. Currently, \"ASC\" or \"DESC\" is supported.",
8006
+ "document": "Sorting method of the returned result set. Valid values: \"ASC\" - ascending order; \"DESC\" - descending order. The default value is \"DESC\".",
7846
8007
  "example": "\"DESC\"",
7847
8008
  "member": "string",
7848
8009
  "name": "OrderDirection",
@@ -7851,7 +8012,7 @@
7851
8012
  },
7852
8013
  {
7853
8014
  "disabled": false,
7854
- "document": "Whether security group ID is used as a filter",
8015
+ "document": "Whether to use the security group ID as the filter condition.\nNote: 0 indicates no; 1 indicates yes.",
7855
8016
  "example": "0",
7856
8017
  "member": "int64",
7857
8018
  "name": "WithSecurityGroup",
@@ -7870,7 +8031,7 @@
7870
8031
  {
7871
8032
  "disabled": false,
7872
8033
  "document": "Exclusive cluster ID.",
7873
- "example": "\"\"",
8034
+ "example": "cdb-g2ql0j11",
7874
8035
  "member": "string",
7875
8036
  "name": "ExClusterId",
7876
8037
  "required": false,
@@ -7879,7 +8040,7 @@
7879
8040
  {
7880
8041
  "disabled": false,
7881
8042
  "document": "Instance ID.",
7882
- "example": "[\"cdb-70zdmgg1\\r\\n\"]",
8043
+ "example": "[\"cdb-70zdmgg1\"]",
7883
8044
  "member": "string",
7884
8045
  "name": "InstanceIds",
7885
8046
  "required": false,
@@ -7924,7 +8085,7 @@
7924
8085
  {
7925
8086
  "disabled": false,
7926
8087
  "document": "Placement group ID list.",
7927
- "example": "\"\"",
8088
+ "example": "[\"ps-7t11vrwf\"]",
7928
8089
  "member": "string",
7929
8090
  "name": "DeployGroupIds",
7930
8091
  "required": false,
@@ -7933,7 +8094,7 @@
7933
8094
  {
7934
8095
  "disabled": false,
7935
8096
  "document": "Whether to use the tag key as a filter condition",
7936
- "example": "[\"\"]",
8097
+ "example": "[\"tagKey\"]",
7937
8098
  "member": "string",
7938
8099
  "name": "TagKeysForSearch",
7939
8100
  "required": false,
@@ -7942,7 +8103,7 @@
7942
8103
  {
7943
8104
  "disabled": false,
7944
8105
  "document": "Financial cage IDs.",
7945
- "example": "[\"cage-test\"]",
8106
+ "example": "[\"cage-dhges\"]",
7946
8107
  "member": "string",
7947
8108
  "name": "CageIds",
7948
8109
  "required": false,
@@ -7977,7 +8138,7 @@
7977
8138
  },
7978
8139
  {
7979
8140
  "disabled": false,
7980
- "document": "Tag key value",
8141
+ "document": "Tag key value.\nNote that tags cannot be queried for instances being created.",
7981
8142
  "example": "无",
7982
8143
  "member": "Tag",
7983
8144
  "name": "Tags",
@@ -8004,12 +8165,21 @@
8004
8165
  },
8005
8166
  {
8006
8167
  "disabled": false,
8007
- "document": "Database engine type",
8168
+ "document": "Database engine type. Valid values: InnoDB; RocksDB.",
8008
8169
  "example": "[\"InnoDB\"]",
8009
8170
  "member": "string",
8010
8171
  "name": "EngineTypes",
8011
8172
  "required": false,
8012
8173
  "type": "list"
8174
+ },
8175
+ {
8176
+ "disabled": false,
8177
+ "document": "Whether to obtain the Cluster Edition instance node information. Valid values: true or false. The default value is false.",
8178
+ "example": "false",
8179
+ "member": "bool",
8180
+ "name": "QueryClusterInfo",
8181
+ "required": false,
8182
+ "type": "bool"
8013
8183
  }
8014
8184
  ],
8015
8185
  "type": "object"
@@ -8060,7 +8230,7 @@
8060
8230
  },
8061
8231
  {
8062
8232
  "disabled": false,
8063
- "document": "AZ information in the format of \"ap-guangzhou-2\". You can use the <a href=\"https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1\">DescribeDBZoneConfig</a> API to query the configurable values. This parameter is required when `InstanceId` is empty.",
8233
+ "document": "AZ information in the format of \"ap-guangzhou-3\". You can use the <a href=\"https://intl.cloud.tencent.com/document/api/236/17229?from_cn_redirect=1\">DescribeDBZoneConfig</a> API to query the configurable values. This parameter is required when `InstanceId` is empty.",
8064
8234
  "example": "ap-guangzhou-2",
8065
8235
  "member": "string",
8066
8236
  "name": "Zone",
@@ -8165,6 +8335,15 @@
8165
8335
  "name": "Ladder",
8166
8336
  "required": false,
8167
8337
  "type": "int"
8338
+ },
8339
+ {
8340
+ "disabled": false,
8341
+ "document": "",
8342
+ "example": "CLOUD_SSD",
8343
+ "member": "string",
8344
+ "name": "DiskType",
8345
+ "required": false,
8346
+ "type": "string"
8168
8347
  }
8169
8348
  ],
8170
8349
  "type": "object"
@@ -10616,7 +10795,7 @@
10616
10795
  "example": "1",
10617
10796
  "member": "int64",
10618
10797
  "name": "Status",
10619
- "required": true,
10798
+ "output_required": true,
10620
10799
  "type": "int",
10621
10800
  "value_allowed_null": false
10622
10801
  },
@@ -10626,7 +10805,7 @@
10626
10805
  "example": "ap-beijing-3",
10627
10806
  "member": "string",
10628
10807
  "name": "Zone",
10629
- "required": true,
10808
+ "output_required": true,
10630
10809
  "type": "string",
10631
10810
  "value_allowed_null": false
10632
10811
  },
@@ -10636,7 +10815,7 @@
10636
10815
  "example": "cdb-***",
10637
10816
  "member": "string",
10638
10817
  "name": "InstanceId",
10639
- "required": true,
10818
+ "output_required": true,
10640
10819
  "type": "string",
10641
10820
  "value_allowed_null": false
10642
10821
  },
@@ -10646,7 +10825,7 @@
10646
10825
  "example": "ap-beijing",
10647
10826
  "member": "string",
10648
10827
  "name": "Region",
10649
- "required": true,
10828
+ "output_required": true,
10650
10829
  "type": "string",
10651
10830
  "value_allowed_null": false
10652
10831
  },
@@ -10656,7 +10835,7 @@
10656
10835
  "example": "2",
10657
10836
  "member": "int64",
10658
10837
  "name": "SyncStatus",
10659
- "required": true,
10838
+ "output_required": true,
10660
10839
  "type": "int",
10661
10840
  "value_allowed_null": false
10662
10841
  },
@@ -10666,7 +10845,7 @@
10666
10845
  "example": "******",
10667
10846
  "member": "string",
10668
10847
  "name": "InstanceName",
10669
- "required": true,
10848
+ "output_required": true,
10670
10849
  "type": "string",
10671
10850
  "value_allowed_null": false
10672
10851
  },
@@ -10676,7 +10855,7 @@
10676
10855
  "example": "2",
10677
10856
  "member": "int64",
10678
10857
  "name": "InstanceType",
10679
- "required": true,
10858
+ "output_required": true,
10680
10859
  "type": "int",
10681
10860
  "value_allowed_null": false
10682
10861
  }
@@ -10947,7 +11126,7 @@
10947
11126
  {
10948
11127
  "disabled": false,
10949
11128
  "document": "Public network access status. Value range: 0 (not enabled), 1 (enabled), 2 (disabled)",
10950
- "example": "0",
11129
+ "example": "2",
10951
11130
  "member": "int64",
10952
11131
  "name": "WanStatus",
10953
11132
  "output_required": true,
@@ -10976,13 +11155,13 @@
10976
11155
  },
10977
11156
  {
10978
11157
  "disabled": false,
10979
- "document": "VIP information of a read-only instance. This field is exclusive to read-only instances where read-only access is enabled separately\nNote: This field may return null, indicating that no valid values can be obtained.",
10980
- "example": "{}",
11158
+ "document": "Read-only VIP information. This field is available only for read-only instances with dedicated access enabled.",
11159
+ "example": "",
10981
11160
  "member": "RoVipInfo",
10982
11161
  "name": "RoVipInfo",
10983
11162
  "output_required": true,
10984
11163
  "type": "object",
10985
- "value_allowed_null": true
11164
+ "value_allowed_null": false
10986
11165
  },
10987
11166
  {
10988
11167
  "disabled": false,
@@ -11016,13 +11195,13 @@
11016
11195
  },
11017
11196
  {
11018
11197
  "disabled": false,
11019
- "document": "Information of a secondary server\nNote: This field may return null, indicating that no valid values can be obtained.",
11020
- "example": "{}",
11198
+ "document": "Secondary server information.",
11199
+ "example": "",
11021
11200
  "member": "SlaveInfo",
11022
11201
  "name": "SlaveInfo",
11023
11202
  "output_required": true,
11024
11203
  "type": "object",
11025
- "value_allowed_null": true
11204
+ "value_allowed_null": false
11026
11205
  },
11027
11206
  {
11028
11207
  "disabled": false,
@@ -11057,7 +11236,7 @@
11057
11236
  {
11058
11237
  "disabled": false,
11059
11238
  "document": "Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync)",
11060
- "example": "0",
11239
+ "example": "1",
11061
11240
  "member": "int64",
11062
11241
  "name": "ProtectMode",
11063
11242
  "output_required": true,
@@ -11066,13 +11245,13 @@
11066
11245
  },
11067
11246
  {
11068
11247
  "disabled": false,
11069
- "document": "Details of a read-only group\nNote: This field may return null, indicating that no valid values can be obtained.",
11070
- "example": "[]",
11248
+ "document": "Detailed information about the read-only group.",
11249
+ "example": "",
11071
11250
  "member": "RoGroup",
11072
11251
  "name": "RoGroups",
11073
11252
  "output_required": true,
11074
11253
  "type": "list",
11075
- "value_allowed_null": true
11254
+ "value_allowed_null": false
11076
11255
  },
11077
11256
  {
11078
11257
  "disabled": false,
@@ -11097,7 +11276,7 @@
11097
11276
  {
11098
11277
  "disabled": false,
11099
11278
  "document": "Project ID",
11100
- "example": "0",
11279
+ "example": "12451",
11101
11280
  "member": "int64",
11102
11281
  "name": "ProjectId",
11103
11282
  "output_required": true,
@@ -11127,7 +11306,7 @@
11127
11306
  {
11128
11307
  "disabled": false,
11129
11308
  "document": "AZ deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ)",
11130
- "example": "0",
11309
+ "example": "1",
11131
11310
  "member": "int64",
11132
11311
  "name": "DeployMode",
11133
11312
  "output_required": true,
@@ -11137,7 +11316,7 @@
11137
11316
  {
11138
11317
  "disabled": false,
11139
11318
  "document": "Instance task status. 0 - no task; 1 - upgrading; 2 - importing data; 3 - activating secondary; 4 - enabling public network access; 5 - batch operation in progress; 6 - rolling back; 7 - disabling public network access; 8 - changing password; 9 - renaming instance; 10 - restarting; 12 - migrating self-built instance; 13 - dropping table; 14 - creating and syncing disaster recovery instance; 15 - pending upgrade and switch; 16 - upgrade and switch in progress; 17 - upgrade and switch completed",
11140
- "example": "0",
11319
+ "example": "1",
11141
11320
  "member": "int64",
11142
11321
  "name": "TaskStatus",
11143
11322
  "output_required": true,
@@ -11146,13 +11325,13 @@
11146
11325
  },
11147
11326
  {
11148
11327
  "disabled": false,
11149
- "document": "Details of a primary instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11150
- "example": "{}",
11328
+ "document": "Detailed information about the primary instance.",
11329
+ "example": "",
11151
11330
  "member": "MasterInfo",
11152
11331
  "name": "MasterInfo",
11153
11332
  "output_required": true,
11154
11333
  "type": "object",
11155
- "value_allowed_null": true
11334
+ "value_allowed_null": false
11156
11335
  },
11157
11336
  {
11158
11337
  "disabled": false,
@@ -11186,18 +11365,18 @@
11186
11365
  },
11187
11366
  {
11188
11367
  "disabled": false,
11189
- "document": "Details of a disaster recovery instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11190
- "example": "[]",
11368
+ "document": "Detailed information about the disaster recovery instance.",
11369
+ "example": "",
11191
11370
  "member": "DrInfo",
11192
11371
  "name": "DrInfo",
11193
11372
  "output_required": true,
11194
11373
  "type": "list",
11195
- "value_allowed_null": true
11374
+ "value_allowed_null": false
11196
11375
  },
11197
11376
  {
11198
11377
  "disabled": false,
11199
11378
  "document": "Public domain name",
11200
- "example": "''",
11379
+ "example": "gz-cdb-******.sql.tencentcdb.com",
11201
11380
  "member": "string",
11202
11381
  "name": "WanDomain",
11203
11382
  "output_required": true,
@@ -11207,7 +11386,7 @@
11207
11386
  {
11208
11387
  "disabled": false,
11209
11388
  "document": "Public network port number",
11210
- "example": "0",
11389
+ "example": "25640",
11211
11390
  "member": "int64",
11212
11391
  "name": "WanPort",
11213
11392
  "output_required": true,
@@ -11287,7 +11466,7 @@
11287
11466
  {
11288
11467
  "disabled": false,
11289
11468
  "document": "Physical ID",
11290
- "example": "''",
11469
+ "example": "phyxxx",
11291
11470
  "member": "string",
11292
11471
  "name": "PhysicalId",
11293
11472
  "output_required": true,
@@ -11326,33 +11505,33 @@
11326
11505
  },
11327
11506
  {
11328
11507
  "disabled": false,
11329
- "document": "Physical machine model\nNote: This field may return null, indicating that no valid values can be obtained.",
11330
- "example": "‘’",
11508
+ "document": "Physical server model.",
11509
+ "example": "VSWEQ",
11331
11510
  "member": "string",
11332
11511
  "name": "DeviceClass",
11333
11512
  "output_required": true,
11334
11513
  "type": "string",
11335
- "value_allowed_null": true
11514
+ "value_allowed_null": false
11336
11515
  },
11337
11516
  {
11338
11517
  "disabled": false,
11339
- "document": "Placement group ID\nNote: this field may return null, indicating that no valid values can be obtained.",
11340
- "example": "‘’",
11518
+ "document": "Placement group ID.",
11519
+ "example": "andy",
11341
11520
  "member": "string",
11342
11521
  "name": "DeployGroupId",
11343
11522
  "output_required": true,
11344
11523
  "type": "string",
11345
- "value_allowed_null": true
11524
+ "value_allowed_null": false
11346
11525
  },
11347
11526
  {
11348
11527
  "disabled": false,
11349
- "document": "AZ ID\nNote: this field may return null, indicating that no valid values can be obtained.",
11528
+ "document": "AZ ID.",
11350
11529
  "example": "800003",
11351
11530
  "member": "int64",
11352
11531
  "name": "ZoneId",
11353
11532
  "output_required": true,
11354
11533
  "type": "int",
11355
- "value_allowed_null": true
11534
+ "value_allowed_null": false
11356
11535
  },
11357
11536
  {
11358
11537
  "disabled": false,
@@ -11366,43 +11545,93 @@
11366
11545
  },
11367
11546
  {
11368
11547
  "disabled": false,
11369
- "document": "List of tags\nNote: this field may return `null`, indicating that no valid values can be obtained.",
11370
- "example": "[]",
11548
+ "document": "Tag list.",
11549
+ "example": "",
11371
11550
  "member": "TagInfoItem",
11372
11551
  "name": "TagList",
11373
11552
  "output_required": true,
11374
11553
  "type": "list",
11375
- "value_allowed_null": true
11554
+ "value_allowed_null": false
11376
11555
  },
11377
11556
  {
11378
11557
  "disabled": false,
11379
- "document": "Engine type\nNote: This field may return null, indicating that no valid values can be obtained.",
11558
+ "document": "Engine type.",
11380
11559
  "example": "InnoDB",
11381
11560
  "member": "string",
11382
11561
  "name": "EngineType",
11383
11562
  "output_required": true,
11384
11563
  "type": "string",
11385
- "value_allowed_null": true
11564
+ "value_allowed_null": false
11386
11565
  },
11387
11566
  {
11388
11567
  "disabled": false,
11389
- "document": "Maximum delay threshold\nNote: This field may return null, indicating that no valid values can be obtained.",
11568
+ "document": "Maximum delay threshold.",
11390
11569
  "example": "1",
11391
11570
  "member": "int64",
11392
11571
  "name": "MaxDelayTime",
11393
11572
  "output_required": true,
11394
11573
  "type": "int",
11395
- "value_allowed_null": true
11574
+ "value_allowed_null": false
11396
11575
  },
11397
11576
  {
11398
11577
  "disabled": false,
11399
- "document": "Instance disk type, which is returned only for the instances of cloud disk edition. Valid values: `CLOUD_SSD` (SSD), `CLOUD_HSSD` (Enhanced SSD).",
11578
+ "document": "Instance disk type. Valid values are returned only for Cluster Edition and single-node (cloud disk) instances.\nNote:\n1. If \"DiskType\": \"CLOUD_HSSD\" is returned, it indicates that the instance disk type is Enhanced SSD.\n2. If \"DiskType\": \"CLOUD_SSD\" is returned, it indicates that the instance disk type is Cloud SSD.\n3. If \"DiskType\": \"\" is returned and the DeviceType parameter value is UNIVERSAL or EXCLUSIVE, it indicates that the instance uses a local SSD.",
11400
11579
  "example": "CLOUD_SSD",
11401
11580
  "member": "string",
11402
11581
  "name": "DiskType",
11403
11582
  "output_required": true,
11404
11583
  "type": "string",
11405
11584
  "value_allowed_null": false
11585
+ },
11586
+ {
11587
+ "disabled": false,
11588
+ "document": "Current number of CPU cores for scale-out.",
11589
+ "example": "2",
11590
+ "member": "int64",
11591
+ "name": "ExpandCpu",
11592
+ "output_required": false,
11593
+ "type": "int",
11594
+ "value_allowed_null": false
11595
+ },
11596
+ {
11597
+ "disabled": false,
11598
+ "document": "Cluster Edition instance node information.",
11599
+ "example": "无",
11600
+ "member": "ClusterInfo",
11601
+ "name": "ClusterInfo",
11602
+ "output_required": false,
11603
+ "type": "list",
11604
+ "value_allowed_null": false
11605
+ },
11606
+ {
11607
+ "disabled": false,
11608
+ "document": "Analysis engine node list.",
11609
+ "example": "无",
11610
+ "member": "AnalysisNodeInfo",
11611
+ "name": "AnalysisNodeInfos",
11612
+ "output_required": false,
11613
+ "type": "list",
11614
+ "value_allowed_null": false
11615
+ },
11616
+ {
11617
+ "disabled": false,
11618
+ "document": "Device bandwidth, in GB. This parameter is valid when DeviceClass is specified. For example, 25 means the current device bandwidth is 25 GB; 10 means the current device bandwidth is 10 GB.",
11619
+ "example": "25",
11620
+ "member": "uint64",
11621
+ "name": "DeviceBandwidth",
11622
+ "output_required": false,
11623
+ "type": "int",
11624
+ "value_allowed_null": false
11625
+ },
11626
+ {
11627
+ "disabled": false,
11628
+ "document": "Instance termination protection status. on indicates enabled; otherwise, the protection is disabled.",
11629
+ "example": "on",
11630
+ "member": "string",
11631
+ "name": "DestroyProtect",
11632
+ "output_required": false,
11633
+ "type": "string",
11634
+ "value_allowed_null": false
11406
11635
  }
11407
11636
  ],
11408
11637
  "usage": "out"
@@ -11655,7 +11884,7 @@
11655
11884
  "example": "ap-guangzhou",
11656
11885
  "member": "string",
11657
11886
  "name": "Region",
11658
- "required": true,
11887
+ "output_required": true,
11659
11888
  "type": "string",
11660
11889
  "value_allowed_null": false
11661
11890
  },
@@ -11665,7 +11894,7 @@
11665
11894
  "example": "1",
11666
11895
  "member": "int64",
11667
11896
  "name": "RegionId",
11668
- "required": true,
11897
+ "output_required": true,
11669
11898
  "type": "int",
11670
11899
  "value_allowed_null": false
11671
11900
  },
@@ -11675,7 +11904,7 @@
11675
11904
  "example": "100003",
11676
11905
  "member": "int64",
11677
11906
  "name": "ZoneId",
11678
- "required": true,
11907
+ "output_required": true,
11679
11908
  "type": "int",
11680
11909
  "value_allowed_null": false
11681
11910
  },
@@ -11685,7 +11914,7 @@
11685
11914
  "example": "ap-guangzhou-3",
11686
11915
  "member": "string",
11687
11916
  "name": "Zone",
11688
- "required": true,
11917
+ "output_required": true,
11689
11918
  "type": "string",
11690
11919
  "value_allowed_null": false
11691
11920
  },
@@ -11695,17 +11924,17 @@
11695
11924
  "example": "cdb-***",
11696
11925
  "member": "string",
11697
11926
  "name": "InstanceId",
11698
- "required": true,
11927
+ "output_required": true,
11699
11928
  "type": "string",
11700
11929
  "value_allowed_null": false
11701
11930
  },
11702
11931
  {
11703
11932
  "disabled": false,
11704
11933
  "document": "Long instance ID",
11705
- "example": "''",
11934
+ "example": "1241asdd-qwed1-213-dad",
11706
11935
  "member": "string",
11707
11936
  "name": "ResourceId",
11708
- "required": true,
11937
+ "output_required": true,
11709
11938
  "type": "string",
11710
11939
  "value_allowed_null": false
11711
11940
  },
@@ -11715,7 +11944,7 @@
11715
11944
  "example": "1",
11716
11945
  "member": "int64",
11717
11946
  "name": "Status",
11718
- "required": true,
11947
+ "output_required": true,
11719
11948
  "type": "int",
11720
11949
  "value_allowed_null": false
11721
11950
  },
@@ -11725,7 +11954,7 @@
11725
11954
  "example": "***",
11726
11955
  "member": "string",
11727
11956
  "name": "InstanceName",
11728
- "required": true,
11957
+ "output_required": true,
11729
11958
  "type": "string",
11730
11959
  "value_allowed_null": false
11731
11960
  },
@@ -11735,7 +11964,7 @@
11735
11964
  "example": "1",
11736
11965
  "member": "int64",
11737
11966
  "name": "InstanceType",
11738
- "required": true,
11967
+ "output_required": true,
11739
11968
  "type": "int",
11740
11969
  "value_allowed_null": false
11741
11970
  },
@@ -11745,7 +11974,7 @@
11745
11974
  "example": "0",
11746
11975
  "member": "int64",
11747
11976
  "name": "TaskStatus",
11748
- "required": true,
11977
+ "output_required": true,
11749
11978
  "type": "int",
11750
11979
  "value_allowed_null": false
11751
11980
  },
@@ -11755,7 +11984,7 @@
11755
11984
  "example": "1000",
11756
11985
  "member": "int64",
11757
11986
  "name": "Memory",
11758
- "required": true,
11987
+ "output_required": true,
11759
11988
  "type": "int",
11760
11989
  "value_allowed_null": false
11761
11990
  },
@@ -11765,7 +11994,7 @@
11765
11994
  "example": "50",
11766
11995
  "member": "int64",
11767
11996
  "name": "Volume",
11768
- "required": true,
11997
+ "output_required": true,
11769
11998
  "type": "int",
11770
11999
  "value_allowed_null": false
11771
12000
  },
@@ -11775,7 +12004,7 @@
11775
12004
  "example": "UNIVERSAL",
11776
12005
  "member": "string",
11777
12006
  "name": "DeviceType",
11778
- "required": true,
12007
+ "output_required": true,
11779
12008
  "type": "string",
11780
12009
  "value_allowed_null": false
11781
12010
  },
@@ -11785,7 +12014,7 @@
11785
12014
  "example": "1000",
11786
12015
  "member": "int64",
11787
12016
  "name": "Qps",
11788
- "required": true,
12017
+ "output_required": true,
11789
12018
  "type": "int",
11790
12019
  "value_allowed_null": false
11791
12020
  },
@@ -11795,7 +12024,7 @@
11795
12024
  "example": "1533",
11796
12025
  "member": "int64",
11797
12026
  "name": "VpcId",
11798
- "required": true,
12027
+ "output_required": true,
11799
12028
  "type": "int",
11800
12029
  "value_allowed_null": false
11801
12030
  },
@@ -11805,27 +12034,27 @@
11805
12034
  "example": "12364",
11806
12035
  "member": "int64",
11807
12036
  "name": "SubnetId",
11808
- "required": true,
12037
+ "output_required": true,
11809
12038
  "type": "int",
11810
12039
  "value_allowed_null": false
11811
12040
  },
11812
12041
  {
11813
12042
  "disabled": false,
11814
12043
  "document": "Dedicated cluster ID",
11815
- "example": "''",
12044
+ "example": "andy",
11816
12045
  "member": "string",
11817
12046
  "name": "ExClusterId",
11818
- "required": true,
12047
+ "output_required": true,
11819
12048
  "type": "string",
11820
12049
  "value_allowed_null": false
11821
12050
  },
11822
12051
  {
11823
12052
  "disabled": false,
11824
12053
  "document": "Dedicated cluster name",
11825
- "example": "''",
12054
+ "example": "andy",
11826
12055
  "member": "string",
11827
12056
  "name": "ExClusterName",
11828
- "required": true,
12057
+ "output_required": true,
11829
12058
  "type": "string",
11830
12059
  "value_allowed_null": false
11831
12060
  }
@@ -14332,7 +14561,7 @@
14332
14561
  "output_required": true,
14333
14562
  "required": false,
14334
14563
  "type": "string",
14335
- "value_allowed_null": true
14564
+ "value_allowed_null": false
14336
14565
  },
14337
14566
  {
14338
14567
  "disabled": false,
@@ -14343,7 +14572,7 @@
14343
14572
  "output_required": true,
14344
14573
  "required": false,
14345
14574
  "type": "string",
14346
- "value_allowed_null": true
14575
+ "value_allowed_null": false
14347
14576
  },
14348
14577
  {
14349
14578
  "disabled": false,
@@ -14354,7 +14583,7 @@
14354
14583
  "output_required": true,
14355
14584
  "required": false,
14356
14585
  "type": "int",
14357
- "value_allowed_null": true
14586
+ "value_allowed_null": false
14358
14587
  },
14359
14588
  {
14360
14589
  "disabled": false,
@@ -14365,7 +14594,7 @@
14365
14594
  "output_required": true,
14366
14595
  "required": false,
14367
14596
  "type": "int",
14368
- "value_allowed_null": true
14597
+ "value_allowed_null": false
14369
14598
  },
14370
14599
  {
14371
14600
  "disabled": false,
@@ -14376,7 +14605,7 @@
14376
14605
  "output_required": true,
14377
14606
  "required": false,
14378
14607
  "type": "int",
14379
- "value_allowed_null": true
14608
+ "value_allowed_null": false
14380
14609
  },
14381
14610
  {
14382
14611
  "disabled": false,
@@ -14387,7 +14616,7 @@
14387
14616
  "output_required": true,
14388
14617
  "required": false,
14389
14618
  "type": "string",
14390
- "value_allowed_null": true
14619
+ "value_allowed_null": false
14391
14620
  },
14392
14621
  {
14393
14622
  "disabled": false,
@@ -14398,7 +14627,7 @@
14398
14627
  "output_required": true,
14399
14628
  "required": false,
14400
14629
  "type": "string",
14401
- "value_allowed_null": true
14630
+ "value_allowed_null": false
14402
14631
  }
14403
14632
  ],
14404
14633
  "usage": "both"
@@ -14845,7 +15074,7 @@
14845
15074
  },
14846
15075
  {
14847
15076
  "disabled": false,
14848
- "document": "Read-only group ID.",
15077
+ "document": "Read-only group ID.\nNote: If the data structure is used during instance purchase, this item is required only when the read-only group mode is set to join.",
14849
15078
  "example": "cdbrg-92zkeaq2",
14850
15079
  "member": "string",
14851
15080
  "name": "RoGroupId",
@@ -14878,7 +15107,7 @@
14878
15107
  },
14879
15108
  {
14880
15109
  "disabled": false,
14881
- "document": "Latency threshold",
15110
+ "document": "Delay threshold, in seconds. Value range: 1–10000. The value is an integer.",
14882
15111
  "example": "1",
14883
15112
  "member": "int64",
14884
15113
  "name": "RoMaxDelayTime",
@@ -14923,7 +15152,7 @@
14923
15152
  {
14924
15153
  "disabled": false,
14925
15154
  "document": "Details of read-only instances in read-only group",
14926
- "example": "[]",
15155
+ "example": "",
14927
15156
  "member": "RoInstanceInfo",
14928
15157
  "name": "RoInstances",
14929
15158
  "output_required": true,
@@ -14955,58 +15184,58 @@
14955
15184
  },
14956
15185
  {
14957
15186
  "disabled": false,
14958
- "document": "VPC ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
15187
+ "document": "Virtual Private Cloud (VPC) ID.",
14959
15188
  "example": "vpc-ja6ts123",
14960
15189
  "member": "string",
14961
15190
  "name": "UniqVpcId",
14962
15191
  "output_required": true,
14963
15192
  "required": false,
14964
15193
  "type": "string",
14965
- "value_allowed_null": true
15194
+ "value_allowed_null": false
14966
15195
  },
14967
15196
  {
14968
15197
  "disabled": false,
14969
- "document": "Subnet ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
15198
+ "document": "Subnet ID.",
14970
15199
  "example": "subnet-njh2bc99",
14971
15200
  "member": "string",
14972
15201
  "name": "UniqSubnetId",
14973
15202
  "output_required": true,
14974
15203
  "required": false,
14975
15204
  "type": "string",
14976
- "value_allowed_null": true
15205
+ "value_allowed_null": false
14977
15206
  },
14978
15207
  {
14979
15208
  "disabled": false,
14980
- "document": "Read-only group region.\nNote: this field may return null, indicating that no valid values can be obtained.",
15209
+ "document": "Region of the read-only group.",
14981
15210
  "example": "ap-beijing",
14982
15211
  "member": "string",
14983
15212
  "name": "RoGroupRegion",
14984
15213
  "output_required": true,
14985
15214
  "required": false,
14986
15215
  "type": "string",
14987
- "value_allowed_null": true
15216
+ "value_allowed_null": false
14988
15217
  },
14989
15218
  {
14990
15219
  "disabled": false,
14991
- "document": "Read-only group AZ.\nNote: this field may return null, indicating that no valid values can be obtained.",
15220
+ "document": "AZ of the read-only group.",
14992
15221
  "example": "ap-beijing-3",
14993
15222
  "member": "string",
14994
15223
  "name": "RoGroupZone",
14995
15224
  "output_required": true,
14996
15225
  "required": false,
14997
15226
  "type": "string",
14998
- "value_allowed_null": true
15227
+ "value_allowed_null": false
14999
15228
  },
15000
15229
  {
15001
15230
  "disabled": false,
15002
- "document": "Replication delay.\nNote: this field may return `null`, indicating that no valid values can be obtained.",
15231
+ "document": "Replication delay time, in seconds. Value range: 1–259200. The value is an integer.",
15003
15232
  "example": "1000",
15004
15233
  "member": "int64",
15005
15234
  "name": "DelayReplicationTime",
15006
15235
  "output_required": true,
15007
15236
  "required": false,
15008
15237
  "type": "int",
15009
- "value_allowed_null": true
15238
+ "value_allowed_null": false
15010
15239
  }
15011
15240
  ],
15012
15241
  "usage": "both"
@@ -15137,8 +15366,8 @@
15137
15366
  },
15138
15367
  {
15139
15368
  "disabled": false,
15140
- "document": "Name of RO AZ, such as ap-shanghai-1",
15141
- "example": "ap-shanghai-1",
15369
+ "document": "Name of RO AZ, such as ap-shanghai-2",
15370
+ "example": "ap-shanghai-2",
15142
15371
  "member": "string",
15143
15372
  "name": "Zone",
15144
15373
  "output_required": true,
@@ -15192,7 +15421,7 @@
15192
15421
  },
15193
15422
  {
15194
15423
  "disabled": false,
15195
- "document": "Pay-as-you-go billing status. Value range: 1 (normal), 2 (in arrears)",
15424
+ "document": "Pay-as-you-go status. Valid values: 1 - normal; 2 - in arrears.",
15196
15425
  "example": "1",
15197
15426
  "member": "int64",
15198
15427
  "name": "HourFeeStatus",
@@ -15314,7 +15543,7 @@
15314
15543
  {
15315
15544
  "disabled": false,
15316
15545
  "document": "RO instance expiration time in the format of yyyy-mm-dd hh:mm:ss. If it is a pay-as-you-go instance, the value of this field is 0000-00-00 00:00:00",
15317
- "example": "‘’",
15546
+ "example": "2024-09-09 16:40:30",
15318
15547
  "member": "string",
15319
15548
  "name": "DeadlineTime",
15320
15549
  "output_required": true,
@@ -15324,7 +15553,7 @@
15324
15553
  },
15325
15554
  {
15326
15555
  "disabled": false,
15327
- "document": "RO instance billing method. Value range: 0 (monthly subscribed), 1 (pay-as-you-go), 2 (monthly postpaid)",
15556
+ "document": "Billing type of the RO instance. Valid values: 0 - yearly/monthly subscription; 1 - pay-as-you-go; 2-postpaid by month.",
15328
15557
  "example": "0",
15329
15558
  "member": "int64",
15330
15559
  "name": "PayType",
@@ -15332,6 +15561,17 @@
15332
15561
  "required": false,
15333
15562
  "type": "int",
15334
15563
  "value_allowed_null": false
15564
+ },
15565
+ {
15566
+ "disabled": false,
15567
+ "document": "RO replication delay status.",
15568
+ "example": "RUNNING",
15569
+ "member": "string",
15570
+ "name": "ReplicationStatus",
15571
+ "output_required": true,
15572
+ "required": false,
15573
+ "type": "string",
15574
+ "value_allowed_null": false
15335
15575
  }
15336
15576
  ],
15337
15577
  "usage": "both"
@@ -15342,47 +15582,52 @@
15342
15582
  {
15343
15583
  "disabled": false,
15344
15584
  "document": "VIP status of the read-only instance",
15345
- "example": "",
15585
+ "example": "2",
15346
15586
  "member": "int64",
15347
15587
  "name": "RoVipStatus",
15348
- "required": true,
15349
- "type": "int"
15588
+ "output_required": true,
15589
+ "type": "int",
15590
+ "value_allowed_null": false
15350
15591
  },
15351
15592
  {
15352
15593
  "disabled": false,
15353
15594
  "document": "VPC subnet of the read-only instance",
15354
- "example": "",
15595
+ "example": "2132421",
15355
15596
  "member": "int64",
15356
15597
  "name": "RoSubnetId",
15357
- "required": true,
15358
- "type": "int"
15598
+ "output_required": true,
15599
+ "type": "int",
15600
+ "value_allowed_null": false
15359
15601
  },
15360
15602
  {
15361
15603
  "disabled": false,
15362
15604
  "document": "VPC of the read-only instance",
15363
- "example": "",
15605
+ "example": "13421234",
15364
15606
  "member": "int64",
15365
15607
  "name": "RoVpcId",
15366
- "required": true,
15367
- "type": "int"
15608
+ "output_required": true,
15609
+ "type": "int",
15610
+ "value_allowed_null": false
15368
15611
  },
15369
15612
  {
15370
15613
  "disabled": false,
15371
15614
  "document": "VIP port number of the read-only instance",
15372
- "example": "",
15615
+ "example": "3306",
15373
15616
  "member": "int64",
15374
15617
  "name": "RoVport",
15375
- "required": true,
15376
- "type": "int"
15618
+ "output_required": true,
15619
+ "type": "int",
15620
+ "value_allowed_null": false
15377
15621
  },
15378
15622
  {
15379
15623
  "disabled": false,
15380
15624
  "document": "VIP of the read-only instance",
15381
- "example": "",
15625
+ "example": "10.1.1.1",
15382
15626
  "member": "string",
15383
15627
  "name": "RoVip",
15384
- "required": true,
15385
- "type": "string"
15628
+ "output_required": true,
15629
+ "type": "string",
15630
+ "value_allowed_null": false
15386
15631
  }
15387
15632
  ],
15388
15633
  "usage": "out"
@@ -15774,20 +16019,22 @@
15774
16019
  {
15775
16020
  "disabled": false,
15776
16021
  "document": "Replication mode of the secondary database. Value range: async, semi-sync",
15777
- "example": "",
16022
+ "example": "aysnc",
15778
16023
  "member": "string",
15779
16024
  "name": "ReplicationMode",
15780
- "required": true,
15781
- "type": "string"
16025
+ "output_required": true,
16026
+ "type": "string",
16027
+ "value_allowed_null": false
15782
16028
  },
15783
16029
  {
15784
16030
  "disabled": false,
15785
- "document": "AZ name of the secondary database, such as ap-shanghai-1",
15786
- "example": "",
16031
+ "document": "AZ name of the secondary database, such as ap-shanghai-2",
16032
+ "example": "ap-shanghai-2",
15787
16033
  "member": "string",
15788
16034
  "name": "Zone",
15789
- "required": true,
15790
- "type": "string"
16035
+ "output_required": true,
16036
+ "type": "string",
16037
+ "value_allowed_null": false
15791
16038
  }
15792
16039
  ],
15793
16040
  "usage": "out"
@@ -15798,22 +16045,22 @@
15798
16045
  {
15799
16046
  "disabled": false,
15800
16047
  "document": "Information of secondary server 1",
15801
- "example": "",
16048
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.1.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15802
16049
  "member": "SlaveInstanceInfo",
15803
16050
  "name": "First",
15804
- "required": true,
16051
+ "output_required": true,
15805
16052
  "type": "object",
15806
16053
  "value_allowed_null": false
15807
16054
  },
15808
16055
  {
15809
16056
  "disabled": false,
15810
- "document": "Information of secondary server 2\nNote: This field may return null, indicating that no valid values can be obtained.",
15811
- "example": "",
16057
+ "document": "Second secondary server information.",
16058
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.0.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15812
16059
  "member": "SlaveInstanceInfo",
15813
16060
  "name": "Second",
15814
- "required": false,
16061
+ "output_required": true,
15815
16062
  "type": "object",
15816
- "value_allowed_null": true
16063
+ "value_allowed_null": false
15817
16064
  }
15818
16065
  ],
15819
16066
  "usage": "out"
@@ -16644,25 +16891,25 @@
16644
16891
  "members": [
16645
16892
  {
16646
16893
  "disabled": false,
16647
- "document": "Tag key\nNote: this field may return `null`, indicating that no valid values can be obtained.",
16894
+ "document": "Tag key.",
16648
16895
  "example": "‘’",
16649
16896
  "member": "string",
16650
16897
  "name": "TagKey",
16651
16898
  "output_required": true,
16652
16899
  "required": true,
16653
16900
  "type": "string",
16654
- "value_allowed_null": true
16901
+ "value_allowed_null": false
16655
16902
  },
16656
16903
  {
16657
16904
  "disabled": false,
16658
- "document": "Tag value\nNote: this field may return `null`, indicating that no valid values can be obtained.",
16905
+ "document": "Tag value.",
16659
16906
  "example": "‘’",
16660
16907
  "member": "string",
16661
16908
  "name": "TagValue",
16662
16909
  "output_required": true,
16663
16910
  "required": true,
16664
16911
  "type": "string",
16665
- "value_allowed_null": true
16912
+ "value_allowed_null": false
16666
16913
  }
16667
16914
  ],
16668
16915
  "usage": "both"
@@ -17192,38 +17439,46 @@
17192
17439
  {
17193
17440
  "disabled": false,
17194
17441
  "document": "AZ deployment mode. Value range: 0 (single-AZ), 1 (multi-AZ)",
17195
- "example": "",
17442
+ "example": "[0,1]",
17196
17443
  "member": "int64",
17197
17444
  "name": "DeployMode",
17445
+ "output_required": true,
17198
17446
  "required": true,
17199
- "type": "list"
17447
+ "type": "list",
17448
+ "value_allowed_null": false
17200
17449
  },
17201
17450
  {
17202
17451
  "disabled": false,
17203
17452
  "document": "AZ where the primary instance is located",
17204
- "example": "",
17453
+ "example": "[\"ap-shanghai-2\"]",
17205
17454
  "member": "string",
17206
17455
  "name": "MasterZone",
17456
+ "output_required": true,
17207
17457
  "required": true,
17208
- "type": "list"
17458
+ "type": "list",
17459
+ "value_allowed_null": false
17209
17460
  },
17210
17461
  {
17211
17462
  "disabled": false,
17212
17463
  "document": "AZ where salve database 1 is located when the instance is deployed in multi-AZ mode",
17213
- "example": "",
17464
+ "example": "[\"ap-shanghai-2\"]",
17214
17465
  "member": "string",
17215
17466
  "name": "SlaveZone",
17467
+ "output_required": true,
17216
17468
  "required": true,
17217
- "type": "list"
17469
+ "type": "list",
17470
+ "value_allowed_null": false
17218
17471
  },
17219
17472
  {
17220
17473
  "disabled": false,
17221
17474
  "document": "AZ where salve database 2 is located when the instance is deployed in multi-AZ mode",
17222
- "example": "",
17475
+ "example": "[\"ap-shanghai-2\"]",
17223
17476
  "member": "string",
17224
17477
  "name": "BackupZone",
17478
+ "output_required": true,
17225
17479
  "required": true,
17226
- "type": "list"
17480
+ "type": "list",
17481
+ "value_allowed_null": false
17227
17482
  }
17228
17483
  ],
17229
17484
  "usage": "both"