tccli 3.0.1215.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (282) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argparser.py +1 -1
  3. tccli/command.py +2 -2
  4. tccli/configure.py +46 -1
  5. tccli/credentials.py +25 -0
  6. tccli/main.py +6 -2
  7. tccli/plugins/sso/__init__.py +61 -0
  8. tccli/plugins/sso/configs.py +4 -0
  9. tccli/plugins/sso/configure.py +45 -0
  10. tccli/plugins/sso/login.py +144 -0
  11. tccli/plugins/sso/logout.py +21 -0
  12. tccli/plugins/sso/terminal.py +161 -0
  13. tccli/plugins/sso/texts.py +40 -0
  14. tccli/services/__init__.py +6 -3
  15. tccli/services/acp/v20220105/api.json +7 -7
  16. tccli/services/acp/v20220105/examples.json +2 -2
  17. tccli/services/aiart/v20221229/api.json +29 -29
  18. tccli/services/aiart/v20221229/examples.json +8 -8
  19. tccli/services/apigateway/v20180808/api.json +18 -17
  20. tccli/services/apigateway/v20180808/examples.json +12 -12
  21. tccli/services/apm/v20210622/api.json +118 -4
  22. tccli/services/asr/v20190614/api.json +21 -20
  23. tccli/services/asr/v20190614/examples.json +13 -13
  24. tccli/services/autoscaling/v20180419/api.json +371 -309
  25. tccli/services/autoscaling/v20180419/examples.json +17 -17
  26. tccli/services/batch/v20170312/api.json +7 -7
  27. tccli/services/bda/v20200324/api.json +39 -31
  28. tccli/services/bda/v20200324/examples.json +9 -9
  29. tccli/services/bh/__init__.py +4 -0
  30. tccli/services/bh/bh_client.py +3428 -0
  31. tccli/services/bh/v20230418/api.json +8180 -0
  32. tccli/services/bh/v20230418/examples.json +519 -0
  33. tccli/services/bi/v20220105/api.json +80 -4
  34. tccli/services/bi/v20220105/examples.json +1 -1
  35. tccli/services/billing/billing_client.py +53 -0
  36. tccli/services/billing/v20180709/api.json +330 -24
  37. tccli/services/billing/v20180709/examples.json +8 -0
  38. tccli/services/bsca/v20210811/api.json +223 -18
  39. tccli/services/bsca/v20210811/examples.json +4 -4
  40. tccli/services/btoe/v20210514/api.json +4 -4
  41. tccli/services/btoe/v20210514/examples.json +2 -2
  42. tccli/services/ca/v20230228/api.json +60 -0
  43. tccli/services/cam/v20190116/api.json +11 -11
  44. tccli/services/cat/v20180409/api.json +9 -0
  45. tccli/services/cbs/v20170312/api.json +200 -188
  46. tccli/services/cbs/v20170312/examples.json +4 -4
  47. tccli/services/ccc/ccc_client.py +53 -0
  48. tccli/services/ccc/v20200210/api.json +541 -325
  49. tccli/services/ccc/v20200210/examples.json +26 -18
  50. tccli/services/cdb/cdb_client.py +13 -13
  51. tccli/services/cdb/v20170320/api.json +308 -274
  52. tccli/services/cdb/v20170320/examples.json +38 -38
  53. tccli/services/cdc/v20201214/api.json +283 -270
  54. tccli/services/cdc/v20201214/examples.json +26 -26
  55. tccli/services/cdn/v20180606/api.json +5 -3
  56. tccli/services/cds/v20180420/api.json +82 -76
  57. tccli/services/cds/v20180420/examples.json +1 -1
  58. tccli/services/cdwch/v20200915/api.json +1 -1
  59. tccli/services/cdwdoris/v20211228/api.json +54 -4
  60. tccli/services/cdz/v20221123/api.json +41 -5
  61. tccli/services/cfg/v20210820/api.json +31 -0
  62. tccli/services/cfs/v20190719/api.json +89 -1
  63. tccli/services/cfs/v20190719/examples.json +1 -1
  64. tccli/services/cfw/cfw_client.py +0 -53
  65. tccli/services/cfw/v20190904/api.json +1895 -2011
  66. tccli/services/cfw/v20190904/examples.json +175 -171
  67. tccli/services/ciam/v20220331/api.json +316 -315
  68. tccli/services/ciam/v20220331/examples.json +49 -49
  69. tccli/services/ckafka/v20190819/api.json +104 -75
  70. tccli/services/clb/v20180317/api.json +48 -26
  71. tccli/services/clb/v20180317/examples.json +1 -1
  72. tccli/services/cloudapp/v20220530/api.json +5 -1
  73. tccli/services/cloudaudit/cloudaudit_client.py +30 -30
  74. tccli/services/cloudaudit/v20190319/api.json +254 -211
  75. tccli/services/cloudaudit/v20190319/examples.json +19 -19
  76. tccli/services/cloudstudio/v20230508/api.json +38 -37
  77. tccli/services/cloudstudio/v20230508/examples.json +4 -4
  78. tccli/services/cls/cls_client.py +216 -4
  79. tccli/services/cls/v20201016/api.json +935 -147
  80. tccli/services/cls/v20201016/examples.json +43 -5
  81. tccli/services/csip/v20221121/api.json +2566 -2386
  82. tccli/services/csip/v20221121/examples.json +108 -108
  83. tccli/services/cvm/v20170312/api.json +191 -112
  84. tccli/services/cvm/v20170312/examples.json +2 -2
  85. tccli/services/cwp/cwp_client.py +4 -110
  86. tccli/services/cwp/v20180228/api.json +6498 -6252
  87. tccli/services/cwp/v20180228/examples.json +372 -412
  88. tccli/services/cynosdb/v20190107/api.json +170 -110
  89. tccli/services/cynosdb/v20190107/examples.json +91 -91
  90. tccli/services/dasb/v20191018/api.json +859 -637
  91. tccli/services/dasb/v20191018/examples.json +101 -101
  92. tccli/services/dcdb/dcdb_client.py +114 -61
  93. tccli/services/dcdb/v20180411/api.json +141 -7
  94. tccli/services/dcdb/v20180411/examples.json +32 -0
  95. tccli/services/dlc/v20210125/api.json +21 -11
  96. tccli/services/dnspod/dnspod_client.py +417 -46
  97. tccli/services/dnspod/v20210323/api.json +751 -30
  98. tccli/services/dnspod/v20210323/examples.json +62 -0
  99. tccli/services/domain/v20180808/api.json +3 -3
  100. tccli/services/domain/v20180808/examples.json +3 -3
  101. tccli/services/dts/v20211206/api.json +4 -4
  102. tccli/services/eb/v20210416/api.json +15 -15
  103. tccli/services/eb/v20210416/examples.json +1 -1
  104. tccli/services/ecm/v20190719/api.json +2 -2
  105. tccli/services/emr/v20190103/api.json +339 -114
  106. tccli/services/emr/v20190103/examples.json +64 -82
  107. tccli/services/es/es_client.py +249 -37
  108. tccli/services/es/v20180416/api.json +550 -0
  109. tccli/services/es/v20180416/examples.json +33 -1
  110. tccli/services/ess/ess_client.py +53 -0
  111. tccli/services/ess/v20201111/api.json +192 -38
  112. tccli/services/ess/v20201111/examples.json +35 -9
  113. tccli/services/essbasic/essbasic_client.py +106 -0
  114. tccli/services/essbasic/v20210526/api.json +287 -60
  115. tccli/services/essbasic/v20210526/examples.json +58 -18
  116. tccli/services/facefusion/v20181201/api.json +47 -45
  117. tccli/services/facefusion/v20181201/examples.json +2 -2
  118. tccli/services/facefusion/v20220927/api.json +54 -48
  119. tccli/services/facefusion/v20220927/examples.json +5 -5
  120. tccli/services/faceid/v20180301/api.json +497 -496
  121. tccli/services/faceid/v20180301/examples.json +219 -101
  122. tccli/services/fmu/v20191213/api.json +59 -67
  123. tccli/services/fmu/v20191213/examples.json +22 -22
  124. tccli/services/ft/v20200304/api.json +53 -57
  125. tccli/services/ft/v20200304/examples.json +14 -14
  126. tccli/services/gaap/v20180529/api.json +44 -26
  127. tccli/services/gaap/v20180529/examples.json +24 -30
  128. tccli/services/gme/v20180711/api.json +21 -11
  129. tccli/services/gme/v20180711/examples.json +1 -1
  130. tccli/services/hai/v20230812/api.json +116 -9
  131. tccli/services/hai/v20230812/examples.json +4 -4
  132. tccli/services/hunyuan/hunyuan_client.py +436 -12
  133. tccli/services/hunyuan/v20230901/api.json +1482 -118
  134. tccli/services/hunyuan/v20230901/examples.json +82 -18
  135. tccli/services/iai/v20180301/api.json +23 -19
  136. tccli/services/iai/v20180301/examples.json +2 -2
  137. tccli/services/iai/v20200303/api.json +530 -511
  138. tccli/services/iai/v20200303/examples.json +116 -86
  139. tccli/services/ig/__init__.py +4 -0
  140. tccli/services/ig/ig_client.py +195 -0
  141. tccli/services/ig/v20210518/api.json +83 -0
  142. tccli/services/ig/v20210518/examples.json +13 -0
  143. tccli/services/ioa/ioa_client.py +53 -0
  144. tccli/services/ioa/v20220601/api.json +662 -413
  145. tccli/services/ioa/v20220601/examples.json +24 -10
  146. tccli/services/iotexplorer/v20190423/api.json +73 -13
  147. tccli/services/iotexplorer/v20190423/examples.json +3 -3
  148. tccli/services/iotvideo/iotvideo_client.py +106 -0
  149. tccli/services/iotvideo/v20191126/api.json +256 -24
  150. tccli/services/iotvideo/v20191126/examples.json +19 -3
  151. tccli/services/iotvideo/v20201215/api.json +1 -1
  152. tccli/services/iotvideo/v20201215/examples.json +1 -1
  153. tccli/services/iotvideo/v20211125/api.json +1 -1
  154. tccli/services/iotvideo/v20211125/examples.json +2 -2
  155. tccli/services/iss/iss_client.py +69 -122
  156. tccli/services/iss/v20230517/api.json +10 -54
  157. tccli/services/iss/v20230517/examples.json +0 -14
  158. tccli/services/kms/v20190118/api.json +301 -268
  159. tccli/services/kms/v20190118/examples.json +45 -51
  160. tccli/services/lcic/lcic_client.py +159 -0
  161. tccli/services/lcic/v20220817/api.json +273 -1
  162. tccli/services/lcic/v20220817/examples.json +24 -0
  163. tccli/services/lighthouse/v20200324/api.json +56 -0
  164. tccli/services/live/live_client.py +159 -0
  165. tccli/services/live/v20180801/api.json +279 -9
  166. tccli/services/live/v20180801/examples.json +24 -0
  167. tccli/services/lke/v20231130/api.json +17 -17
  168. tccli/services/lke/v20231130/examples.json +19 -25
  169. tccli/services/mariadb/v20170312/api.json +7 -7
  170. tccli/services/market/v20191010/api.json +3 -3
  171. tccli/services/market/v20191010/examples.json +2 -2
  172. tccli/services/mmps/v20200710/api.json +47 -47
  173. tccli/services/mmps/v20200710/examples.json +3 -3
  174. tccli/services/mongodb/v20190725/api.json +10 -12
  175. tccli/services/monitor/v20180724/api.json +46 -19
  176. tccli/services/mps/v20190612/api.json +282 -5
  177. tccli/services/mps/v20190612/examples.json +25 -1
  178. tccli/services/mqtt/v20240516/api.json +2 -2
  179. tccli/services/mrs/v20200910/api.json +72 -34
  180. tccli/services/mrs/v20200910/examples.json +2 -2
  181. tccli/services/ms/v20180408/api.json +535 -506
  182. tccli/services/ms/v20180408/examples.json +25 -25
  183. tccli/services/oceanus/v20190422/api.json +130 -0
  184. tccli/services/ocr/ocr_client.py +232 -20
  185. tccli/services/ocr/v20181119/api.json +2263 -758
  186. tccli/services/ocr/v20181119/examples.json +200 -180
  187. tccli/services/omics/v20221128/api.json +614 -553
  188. tccli/services/omics/v20221128/examples.json +9 -9
  189. tccli/services/organization/organization_client.py +352 -34
  190. tccli/services/organization/v20210331/api.json +464 -4
  191. tccli/services/organization/v20210331/examples.json +49 -1
  192. tccli/services/partners/v20180321/api.json +244 -234
  193. tccli/services/partners/v20180321/examples.json +19 -19
  194. tccli/services/privatedns/privatedns_client.py +428 -4
  195. tccli/services/privatedns/v20201028/api.json +815 -11
  196. tccli/services/privatedns/v20201028/examples.json +64 -0
  197. tccli/services/pts/v20210728/api.json +18 -0
  198. tccli/services/pts/v20210728/examples.json +1 -1
  199. tccli/services/rce/rce_client.py +53 -0
  200. tccli/services/rce/v20201103/api.json +146 -0
  201. tccli/services/rce/v20201103/examples.json +8 -0
  202. tccli/services/redis/v20180412/api.json +42 -42
  203. tccli/services/redis/v20180412/examples.json +19 -19
  204. tccli/services/region/v20220627/api.json +1 -1
  205. tccli/services/rum/v20210622/api.json +9 -0
  206. tccli/services/scf/scf_client.py +269 -4
  207. tccli/services/scf/v20180416/api.json +569 -15
  208. tccli/services/scf/v20180416/examples.json +47 -1
  209. tccli/services/smop/v20201203/api.json +46 -42
  210. tccli/services/smop/v20201203/examples.json +2 -2
  211. tccli/services/soe/v20180724/api.json +10 -10
  212. tccli/services/sqlserver/v20180328/api.json +21 -8
  213. tccli/services/sqlserver/v20180328/examples.json +5 -5
  214. tccli/services/ssl/v20191205/api.json +98 -5
  215. tccli/services/ssm/v20190923/api.json +292 -231
  216. tccli/services/ssm/v20190923/examples.json +42 -42
  217. tccli/services/tat/v20201028/api.json +124 -122
  218. tccli/services/tat/v20201028/examples.json +24 -30
  219. tccli/services/tchd/v20230306/api.json +5 -5
  220. tccli/services/tchd/v20230306/examples.json +3 -3
  221. tccli/services/tcr/v20190924/api.json +1 -1
  222. tccli/services/tcr/v20190924/examples.json +1 -1
  223. tccli/services/tcss/v20201101/api.json +1984 -1437
  224. tccli/services/tcss/v20201101/examples.json +350 -368
  225. tccli/services/tdmq/v20200217/api.json +603 -464
  226. tccli/services/tdmq/v20200217/examples.json +105 -105
  227. tccli/services/tds/v20220801/api.json +4 -4
  228. tccli/services/tem/v20210701/api.json +429 -372
  229. tccli/services/tem/v20210701/examples.json +85 -85
  230. tccli/services/teo/teo_client.py +277 -12
  231. tccli/services/teo/v20220901/api.json +1029 -124
  232. tccli/services/teo/v20220901/examples.json +84 -8
  233. tccli/services/thpc/v20230321/api.json +5 -5
  234. tccli/services/tke/tke_client.py +270 -58
  235. tccli/services/tke/v20180525/api.json +79 -27
  236. tccli/services/tke/v20180525/examples.json +9 -1
  237. tccli/services/tke/v20220501/api.json +176 -0
  238. tccli/services/tke/v20220501/examples.json +24 -0
  239. tccli/services/tms/tms_client.py +4 -57
  240. tccli/services/tms/v20201229/api.json +0 -354
  241. tccli/services/tms/v20201229/examples.json +0 -8
  242. tccli/services/tmt/v20180321/api.json +38 -8
  243. tccli/services/trp/v20210515/api.json +86 -74
  244. tccli/services/trp/v20210515/examples.json +65 -65
  245. tccli/services/trro/v20220325/api.json +72 -71
  246. tccli/services/trro/v20220325/examples.json +8 -8
  247. tccli/services/trtc/trtc_client.py +8 -61
  248. tccli/services/trtc/v20190722/api.json +293 -52
  249. tccli/services/trtc/v20190722/examples.json +3 -11
  250. tccli/services/tse/tse_client.py +110 -4
  251. tccli/services/tse/v20201207/api.json +122 -7
  252. tccli/services/tse/v20201207/examples.json +25 -9
  253. tccli/services/vclm/v20240523/api.json +225 -82
  254. tccli/services/vclm/v20240523/examples.json +13 -19
  255. tccli/services/vod/v20180717/api.json +431 -4
  256. tccli/services/vod/v20180717/examples.json +25 -5
  257. tccli/services/vod/v20240718/api.json +11 -11
  258. tccli/services/vod/v20240718/examples.json +4 -4
  259. tccli/services/vod/vod_client.py +53 -0
  260. tccli/services/vpc/v20170312/api.json +1195 -892
  261. tccli/services/vpc/v20170312/examples.json +84 -68
  262. tccli/services/vpc/vpc_client.py +168 -62
  263. tccli/services/waf/v20180125/api.json +2611 -2187
  264. tccli/services/waf/v20180125/examples.json +224 -284
  265. tccli/services/waf/waf_client.py +225 -119
  266. tccli/services/wav/v20210129/api.json +48 -48
  267. tccli/services/wav/v20210129/examples.json +4 -4
  268. tccli/services/wedata/v20210820/api.json +1595 -25
  269. tccli/services/wedata/v20210820/examples.json +44 -4
  270. tccli/services/wedata/wedata_client.py +265 -0
  271. tccli/services/weilingwith/v20230427/api.json +6 -6
  272. tccli/services/weilingwith/v20230427/examples.json +3 -3
  273. tccli/sso.py +229 -0
  274. {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/METADATA +6 -2
  275. {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/RECORD +278 -265
  276. tccli/services/cr/__init__.py +0 -4
  277. tccli/services/cr/cr_client.py +0 -1626
  278. tccli/services/cr/v20180321/api.json +0 -2829
  279. tccli/services/cr/v20180321/examples.json +0 -235
  280. {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/WHEEL +0 -0
  281. {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/entry_points.txt +0 -0
  282. {tccli-3.0.1215.1.dist-info → tccli-3.0.1217.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "actions": {
3
3
  "AddTimeWindow": {
4
- "document": "本接口(AddTimeWindow)用于添加云数据库实例的维护时间窗口,以指定实例在哪些时间段可以自动执行切换访问操作。",
4
+ "document": "本接口(AddTimeWindow)用于添加云数据库实例的维护时间窗口,以指定实例在哪些时间段可以自动执行切换访问操作。",
5
5
  "input": "AddTimeWindowRequest",
6
6
  "name": "添加维护时间窗口",
7
7
  "output": "AddTimeWindowResponse",
@@ -15,7 +15,7 @@
15
15
  "status": "online"
16
16
  },
17
17
  "AdjustCdbProxyAddress": {
18
- "document": "调整数据库代理地址配置",
18
+ "document": "本接口(AdjustCdbProxyAddress)用于调整数据库代理地址配置。",
19
19
  "input": "AdjustCdbProxyAddressRequest",
20
20
  "name": "调整数据库代理地址",
21
21
  "output": "AdjustCdbProxyAddressResponse",
@@ -43,7 +43,7 @@
43
43
  "status": "online"
44
44
  },
45
45
  "CheckMigrateCluster": {
46
- "document": "高可用实例一键迁移到集群版校验",
46
+ "document": "本接口(CheckMigrateCluster)用于高可用实例一键迁移到集群版校验。",
47
47
  "input": "CheckMigrateClusterRequest",
48
48
  "name": "迁移集群版校验",
49
49
  "output": "CheckMigrateClusterResponse",
@@ -155,14 +155,14 @@
155
155
  "status": "online"
156
156
  },
157
157
  "CreateDBInstance": {
158
- "document": "本接口(CreateDBInstance)用于创建包年包月的云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。\n\n该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为1,且 TaskStatus 为0,表示实例已经发货成功。\n\n1. 首先请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口查询可创建的实例规格信息,然后请使用 [查询数据库价格](https://cloud.tencent.com/document/api/236/18566) 接口查询可创建实例的售卖价格;\n2. 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;\n3. 支持创建 MySQL 5.5 、 MySQL 5.6 、 MySQL 5.7 、 MySQL 8.0 版本;\n4. 支持创建主实例、只读实例、灾备实例;\n5. 当入参指定 Port 和 ParamTemplateType 参数模板,相关参数才会自动初始化(不支持基础版实例);\n6. 当入参指定 ParamTemplateId 或 AlarmPolicyList 时,需将SDK提升至最新版本方可支持;",
158
+ "document": "本接口(CreateDBInstance)用于创建包年包月的云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。\n\n该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为1,且 TaskStatus 为0,表示实例已经发货成功。\n\n1. 首先请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口查询可创建的实例规格信息,然后请使用 [查询数据库价格](https://cloud.tencent.com/document/api/236/18566) 接口查询可创建实例的售卖价格;\n2. 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;\n3. 支持创建 MySQL 5.5 、 MySQL 5.6 、 MySQL 5.7 、 MySQL 8.0 版本;\n4. 支持创建主实例、只读实例、灾备实例;\n5. 当入参指定 ParamTemplateId 或 AlarmPolicyList 时,需将SDK提升至最新版本方可支持;",
159
159
  "input": "CreateDBInstanceRequest",
160
160
  "name": "创建云数据库实例(包年包月)",
161
161
  "output": "CreateDBInstanceResponse",
162
162
  "status": "online"
163
163
  },
164
164
  "CreateDBInstanceHour": {
165
- "document": "本接口(CreateDBInstanceHour)用于创建按量计费的实例,可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例,支持主实例、灾备实例和只读实例的创建。\n\n该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为 1,且 TaskStatus 为 0,表示实例已经发货成功。\n\n1. 首先请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口查询可创建的实例规格信息,然后请使用 [查询数据库价格](https://cloud.tencent.com/document/api/236/18566) 接口查询可创建实例的售卖价格;\n2. 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;\n3. 支持创建 MySQL 5.5、MySQL 5.6 、MySQL 5.7 和 MySQL 8.0 版本;\n4. 支持创建主实例、灾备实例和只读实例;\n5. 当入参指定 Port,ParamTemplateType 或 Password 时,该实例会进行初始化操作;",
165
+ "document": "本接口(CreateDBInstanceHour)用于创建按量计费的实例,可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例,支持主实例、灾备实例和只读实例的创建。\n\n该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为 1,且 TaskStatus 为 0,表示实例已经发货成功。\n\n1. 首先请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口查询可创建的实例规格信息,然后请使用 [查询数据库价格](https://cloud.tencent.com/document/api/236/18566) 接口查询可创建实例的售卖价格;\n2. 单次创建实例最大支持 100 个,实例时长最大支持 36 个月;\n3. 支持创建 MySQL 5.5、MySQL 5.6 、MySQL 5.7 和 MySQL 8.0 版本;\n4. 支持创建主实例、灾备实例和只读实例;",
166
166
  "input": "CreateDBInstanceHourRequest",
167
167
  "name": "创建云数据库实例(按量计费)",
168
168
  "output": "CreateDBInstanceHourResponse",
@@ -442,7 +442,7 @@
442
442
  "status": "online"
443
443
  },
444
444
  "DescribeClusterInfo": {
445
- "document": "本接口(DescribeClusterInfo)用于查询集群版实例信息。",
445
+ "document": "本接口(DescribeClusterInfo)用于查询集群版实例信息。",
446
446
  "input": "DescribeClusterInfoRequest",
447
447
  "name": "查询集群版实例信息",
448
448
  "output": "DescribeClusterInfoResponse",
@@ -456,7 +456,7 @@
456
456
  "status": "online"
457
457
  },
458
458
  "DescribeDBFeatures": {
459
- "document": "本接口(DescribeDBFeatures)用于查询云数据库版本属性,包括是否支持数据库加密、数据库审计等功能。",
459
+ "document": "本接口(DescribeDBFeatures)用于查询云数据库版本属性,包括是否支持数据库加密、数据库审计等功能。",
460
460
  "input": "DescribeDBFeaturesRequest",
461
461
  "name": "查询实例版本属性",
462
462
  "output": "DescribeDBFeaturesResponse",
@@ -491,7 +491,7 @@
491
491
  "status": "online"
492
492
  },
493
493
  "DescribeDBInstanceInfo": {
494
- "document": "查询实例基本信息(实例 ID ,实例名称,是否开通加密 )",
494
+ "document": "本接口(DescribeDBInstanceInfo)用于查询实例基本信息(实例 ID,实例名称,是否开通加密)。",
495
495
  "input": "DescribeDBInstanceInfoRequest",
496
496
  "name": "查询实例基本信息",
497
497
  "output": "DescribeDBInstanceInfoResponse",
@@ -505,7 +505,7 @@
505
505
  "status": "online"
506
506
  },
507
507
  "DescribeDBInstanceRebootTime": {
508
- "document": "本接口(DescribeDBInstanceRebootTime)用于查询云数据库实例重启预计所需的时间。",
508
+ "document": "本接口(DescribeDBInstanceRebootTime)用于查询云数据库实例重启预计所需的时间。",
509
509
  "input": "DescribeDBInstanceRebootTimeRequest",
510
510
  "name": "查询云数据库实例的预期重启时间",
511
511
  "output": "DescribeDBInstanceRebootTimeResponse",
@@ -519,7 +519,7 @@
519
519
  "status": "online"
520
520
  },
521
521
  "DescribeDBPrice": {
522
- "document": "本接口(DescribeDBPrice)用于查询购买或续费云数据库实例的价格,支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。可传入实例名称来查询实例续费价格。\n\n注意:对某个地域进行询价,请使用对应地域的接入点,接入点信息请参照 <a href=\"https://cloud.tencent.com/document/api/236/15832\">服务地址</a> 文档。例如:对广州地域进行询价,请把请求发到:cdb.ap-guangzhou.tencentcloudapi.com。同理对上海地域询价,把请求发到:cdb.ap-shanghai.tencentcloudapi.com。",
522
+ "document": "本接口(DescribeDBPrice)用于查询购买或续费云数据库实例的价格,支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。可传入实例名称来查询实例续费价格。\n\n注意:对某个地域进行询价,请使用对应地域的接入点,接入点信息请参照 <a href=\"https://cloud.tencent.com/document/api/236/15832\">服务地址</a> 文档。例如:对广州地域进行询价,请把请求发到:cdb.ap-guangzhou.tencentcloudapi.com。同理对上海地域询价,把请求发到:cdb.ap-shanghai.tencentcloudapi.com。",
523
523
  "input": "DescribeDBPriceRequest",
524
524
  "name": "查询数据库价格",
525
525
  "output": "DescribeDBPriceResponse",
@@ -582,7 +582,7 @@
582
582
  "status": "online"
583
583
  },
584
584
  "DescribeInstanceAlarmEvents": {
585
- "document": "查询实例发生的事件信息",
585
+ "document": "本接口(DescribeInstanceAlarmEvents)用于查询实例发生的事件信息。",
586
586
  "input": "DescribeInstanceAlarmEventsRequest",
587
587
  "name": "查询实例发生的事件信息",
588
588
  "output": "DescribeInstanceAlarmEventsResponse",
@@ -610,7 +610,7 @@
610
610
  "status": "online"
611
611
  },
612
612
  "DescribeInstanceUpgradeType": {
613
- "document": "本接口(DescribeInstanceUpgradeType)用于查询数据库实例升级类型。",
613
+ "document": "本接口(DescribeInstanceUpgradeType)用于查询数据库实例升级类型。",
614
614
  "input": "DescribeInstanceUpgradeTypeRequest",
615
615
  "name": "查询数据库实例升级类型",
616
616
  "output": "DescribeInstanceUpgradeTypeResponse",
@@ -666,7 +666,7 @@
666
666
  "status": "online"
667
667
  },
668
668
  "DescribeRoGroups": {
669
- "document": "本接口(DescribeRoGroups)用于查询云数据库实例的所有的RO组的信息。",
669
+ "document": "本接口(DescribeRoGroups)用于查询云数据库实例的所有的 RO 组的信息。",
670
670
  "input": "DescribeRoGroupsRequest",
671
671
  "name": "查询云数据库实例的所有RO组的信息",
672
672
  "output": "DescribeRoGroupsResponse",
@@ -763,13 +763,6 @@
763
763
  "output": "DisassociateSecurityGroupsResponse",
764
764
  "status": "online"
765
765
  },
766
- "InitDBInstances": {
767
- "document": "该接口不再维护,参考CreateDBInstance+API文档,在发货时即可完成初始化。\n\n本接口(InitDBInstances)用于初始化云数据库实例,包括初始化密码、默认字符集、实例端口号等。该接口已经废弃,在发货接口CreateDBInstance、CreateDBInstanceHour可以直接使用参数Password设置密码,使用参数ParamList设置字符集,使用参数Port设置端口号。",
768
- "input": "InitDBInstancesRequest",
769
- "name": "初始化新实例(该接口已经不再维护,不建议使用)",
770
- "output": "InitDBInstancesResponse",
771
- "status": "deprecated"
772
- },
773
766
  "InquiryPriceUpgradeInstances": {
774
767
  "document": "本接口(InquiryPriceUpgradeInstances)用于查询云数据库实例升级的价格,支持查询按量计费或者包年包月实例的升级价格,实例类型支持主实例、灾备实例和只读实例。",
775
768
  "input": "InquiryPriceUpgradeInstancesRequest",
@@ -848,7 +841,7 @@
848
841
  "status": "online"
849
842
  },
850
843
  "ModifyAutoRenewFlag": {
851
- "document": "本接口(ModifyAutoRenewFlag)用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。",
844
+ "document": "本接口(ModifyAutoRenewFlag)用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。",
852
845
  "input": "ModifyAutoRenewFlagRequest",
853
846
  "name": "修改云数据库实例的自动续费标记",
854
847
  "output": "ModifyAutoRenewFlagResponse",
@@ -917,6 +910,13 @@
917
910
  "output": "ModifyDBInstanceProjectResponse",
918
911
  "status": "online"
919
912
  },
913
+ "ModifyDBInstanceReadOnlyStatus": {
914
+ "document": "本接口(ModifyDBInstanceReadOnlyStatus)用户设置MySQL云数据库实例为只读",
915
+ "input": "ModifyDBInstanceReadOnlyStatusRequest",
916
+ "name": "设置MySQL云数据库实例为只读",
917
+ "output": "ModifyDBInstanceReadOnlyStatusResponse",
918
+ "status": "online"
919
+ },
920
920
  "ModifyDBInstanceSecurityGroups": {
921
921
  "document": "本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。",
922
922
  "input": "ModifyDBInstanceSecurityGroupsRequest",
@@ -1009,7 +1009,7 @@
1009
1009
  "status": "online"
1010
1010
  },
1011
1011
  "OpenDBInstanceEncryption": {
1012
- "document": "本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。\n\n注意,启用实例数据存储加密之前,需要进行以下操作:\n\n1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作;\n\n2、开启 [KMS服务](https://console.cloud.tencent.com/kms2);\n\n3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;\n\n该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。",
1012
+ "document": "本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。\n\n注意,启用实例数据存储加密之前,需要进行以下操作:\n\n1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作;\n\n2、开启 [KMS服务](https://console.cloud.tencent.com/kms2);\n\n3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;\n\n该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。",
1013
1013
  "input": "OpenDBInstanceEncryptionRequest",
1014
1014
  "name": "启用数据存储加密",
1015
1015
  "output": "OpenDBInstanceEncryptionResponse",
@@ -1072,7 +1072,7 @@
1072
1072
  "status": "online"
1073
1073
  },
1074
1074
  "RestartDBInstances": {
1075
- "document": "本接口(RestartDBInstances)用于重启云数据库实例。\n\n注意:\n1、本接口只支持主实例进行重启操作;\n2、实例状态必须为正常,并且没有其他异步任务在执行中。",
1075
+ "document": "本接口(RestartDBInstances)用于重启云数据库实例。\n\n注意:\n1、本接口支持主实例、只读实例、灾备实例进行重启操作。\n2、实例状态必须为正常,并且没有其他异步任务在执行中。",
1076
1076
  "input": "RestartDBInstancesRequest",
1077
1077
  "name": "重启实例",
1078
1078
  "output": "RestartDBInstancesResponse",
@@ -1093,7 +1093,7 @@
1093
1093
  "status": "online"
1094
1094
  },
1095
1095
  "StartReplication": {
1096
- "document": "开启 RO 复制,从主实例同步数据。",
1096
+ "document": "本接口(StartReplication)用于开启 RO 复制,从主实例同步数据。",
1097
1097
  "input": "StartReplicationRequest",
1098
1098
  "name": "开启复制",
1099
1099
  "output": "StartReplicationResponse",
@@ -1114,7 +1114,7 @@
1114
1114
  "status": "online"
1115
1115
  },
1116
1116
  "StopReplication": {
1117
- "document": "停止 RO 复制,中断从主实例同步数据。",
1117
+ "document": "本接口(StopReplication)用于停止 RO 复制,中断从主实例同步数据。",
1118
1118
  "input": "StopReplicationRequest",
1119
1119
  "name": "停止复制",
1120
1120
  "output": "StopReplicationResponse",
@@ -1149,7 +1149,7 @@
1149
1149
  "status": "online"
1150
1150
  },
1151
1151
  "SwitchDrInstanceToMaster": {
1152
- "document": "本接口(SwitchDrInstanceToMaster)用于将云数据库灾备实例切换为主实例,注意请求必须发到灾备实例所在的地域。",
1152
+ "document": "本接口(SwitchDrInstanceToMaster)用于将云数据库灾备实例切换为主实例,注意请求必须发到灾备实例所在的地域。",
1153
1153
  "input": "SwitchDrInstanceToMasterRequest",
1154
1154
  "name": "云数据库灾备实例切换为主实例",
1155
1155
  "output": "SwitchDrInstanceToMasterResponse",
@@ -1307,7 +1307,7 @@
1307
1307
  "members": [
1308
1308
  {
1309
1309
  "disabled": false,
1310
- "document": "实例ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
1310
+ "document": "实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
1311
1311
  "example": "cdb-eb2w7dto",
1312
1312
  "member": "string",
1313
1313
  "name": "InstanceId",
@@ -1317,7 +1317,7 @@
1317
1317
  {
1318
1318
  "disabled": false,
1319
1319
  "document": "星期一的可维护时间段,其中每一个时间段的格式形如:10:00-12:00;起始时间按半个小时对齐;最短半个小时,最长三个小时;可设置多个时间段。 一周中应至少设置一天的时间窗。下同。",
1320
- "example": "[\"02:00-03:00\\n\"]",
1320
+ "example": "02:00-03:00",
1321
1321
  "member": "string",
1322
1322
  "name": "Monday",
1323
1323
  "required": false,
@@ -1326,7 +1326,7 @@
1326
1326
  {
1327
1327
  "disabled": false,
1328
1328
  "document": "星期二的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1329
- "example": "",
1329
+ "example": "02:00-03:00",
1330
1330
  "member": "string",
1331
1331
  "name": "Tuesday",
1332
1332
  "required": false,
@@ -1335,7 +1335,7 @@
1335
1335
  {
1336
1336
  "disabled": false,
1337
1337
  "document": "星期三的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1338
- "example": "",
1338
+ "example": "02:00-03:00",
1339
1339
  "member": "string",
1340
1340
  "name": "Wednesday",
1341
1341
  "required": false,
@@ -1344,7 +1344,7 @@
1344
1344
  {
1345
1345
  "disabled": false,
1346
1346
  "document": "星期四的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1347
- "example": "",
1347
+ "example": "02:00-03:00",
1348
1348
  "member": "string",
1349
1349
  "name": "Thursday",
1350
1350
  "required": false,
@@ -1353,7 +1353,7 @@
1353
1353
  {
1354
1354
  "disabled": false,
1355
1355
  "document": "星期五的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1356
- "example": "",
1356
+ "example": "02:00-03:00",
1357
1357
  "member": "string",
1358
1358
  "name": "Friday",
1359
1359
  "required": false,
@@ -1362,7 +1362,7 @@
1362
1362
  {
1363
1363
  "disabled": false,
1364
1364
  "document": "星期六的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1365
- "example": "",
1365
+ "example": "02:00-03:00",
1366
1366
  "member": "string",
1367
1367
  "name": "Saturday",
1368
1368
  "required": false,
@@ -1371,7 +1371,7 @@
1371
1371
  {
1372
1372
  "disabled": false,
1373
1373
  "document": "星期日的可维护时间窗口。 一周中应至少设置一天的时间窗。",
1374
- "example": "",
1374
+ "example": "02:00-03:00",
1375
1375
  "member": "string",
1376
1376
  "name": "Sunday",
1377
1377
  "required": false,
@@ -1379,7 +1379,7 @@
1379
1379
  },
1380
1380
  {
1381
1381
  "disabled": false,
1382
- "document": "最大延迟阈值,仅对主实例和灾备实例有效",
1382
+ "document": "最大延迟阈值,仅对主实例和灾备实例有效。",
1383
1383
  "example": "10",
1384
1384
  "member": "uint64",
1385
1385
  "name": "MaxDelayTime",
@@ -1407,7 +1407,7 @@
1407
1407
  {
1408
1408
  "disabled": false,
1409
1409
  "document": "地址的资源id标识。",
1410
- "example": "cdb-xxx",
1410
+ "example": "cdb-rqd2jddd",
1411
1411
  "member": "string",
1412
1412
  "name": "ResourceId",
1413
1413
  "output_required": true,
@@ -1417,7 +1417,7 @@
1417
1417
  {
1418
1418
  "disabled": false,
1419
1419
  "document": "地址所在的vpc。",
1420
- "example": "vpc-xxx",
1420
+ "example": "vpc-1qm52ddd",
1421
1421
  "member": "string",
1422
1422
  "name": "UniqVpcId",
1423
1423
  "output_required": true,
@@ -1427,7 +1427,7 @@
1427
1427
  {
1428
1428
  "disabled": false,
1429
1429
  "document": "地址所在的子网。",
1430
- "example": "subnet-xxx",
1430
+ "example": "subnet-i1nhbddd",
1431
1431
  "member": "string",
1432
1432
  "name": "UniqSubnetId",
1433
1433
  "output_required": true,
@@ -1437,7 +1437,7 @@
1437
1437
  {
1438
1438
  "disabled": false,
1439
1439
  "document": "地址的vip。",
1440
- "example": "",
1440
+ "example": "172.1.1.1",
1441
1441
  "member": "string",
1442
1442
  "name": "Vip",
1443
1443
  "output_required": true,
@@ -1447,7 +1447,7 @@
1447
1447
  {
1448
1448
  "disabled": false,
1449
1449
  "document": "地址的端口。",
1450
- "example": "",
1450
+ "example": "3306",
1451
1451
  "member": "int64",
1452
1452
  "name": "VPort",
1453
1453
  "output_required": true,
@@ -1457,7 +1457,7 @@
1457
1457
  {
1458
1458
  "disabled": false,
1459
1459
  "document": "外网地址域名。",
1460
- "example": "",
1460
+ "example": "gz-cdb-*******.sql.tencentcdb.com",
1461
1461
  "member": "string",
1462
1462
  "name": "WanDomain",
1463
1463
  "output_required": false,
@@ -1467,7 +1467,7 @@
1467
1467
  {
1468
1468
  "disabled": false,
1469
1469
  "document": "外网地址端口。",
1470
- "example": "",
1470
+ "example": "25640",
1471
1471
  "member": "int64",
1472
1472
  "name": "WanPort",
1473
1473
  "output_required": false,
@@ -1483,7 +1483,7 @@
1483
1483
  {
1484
1484
  "disabled": false,
1485
1485
  "document": "代理组ID",
1486
- "example": "proxy-test",
1486
+ "example": "proxy-il2nlsdn",
1487
1487
  "member": "string",
1488
1488
  "name": "ProxyGroupId",
1489
1489
  "required": true,
@@ -1555,7 +1555,7 @@
1555
1555
  {
1556
1556
  "disabled": false,
1557
1557
  "document": "代理组地址ID",
1558
- "example": "proxy-test",
1558
+ "example": "proxy-il2nlsdn",
1559
1559
  "member": "string",
1560
1560
  "name": "ProxyAddressId",
1561
1561
  "required": true,
@@ -1582,7 +1582,7 @@
1582
1582
  {
1583
1583
  "disabled": false,
1584
1584
  "document": "读写权重分配。如果 WeightMode 传的是 system ,则传入的权重不生效,由系统分配默认权重。",
1585
- "example": "",
1585
+ "example": "[{\"Region\":\"ap-guangzhou\",\"Zone\":\"ap-guangzhou-2\",\"ProxyInstance\":[{\"InstanceId\":\"cdb-aykuksx3\",\"Weight\":100}]",
1586
1586
  "member": "ProxyAllocation",
1587
1587
  "name": "ProxyAllocation",
1588
1588
  "required": false,
@@ -1615,7 +1615,7 @@
1615
1615
  {
1616
1616
  "disabled": false,
1617
1617
  "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
1618
- "example": "1312",
1618
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
1619
1619
  "member": "string",
1620
1620
  "name": "AsyncRequestId",
1621
1621
  "output_required": true,
@@ -4323,7 +4323,7 @@
4323
4323
  {
4324
4324
  "disabled": false,
4325
4325
  "document": "RW 节点拓扑。",
4326
- "example": "",
4326
+ "example": "[{\"Zone\": \"ap-guangzhou-4\",\"NodeId\": \"dbn-73ktfl1j\"}]",
4327
4327
  "member": "ReadWriteNode",
4328
4328
  "name": "ReadWriteNode",
4329
4329
  "required": false,
@@ -4332,7 +4332,7 @@
4332
4332
  {
4333
4333
  "disabled": false,
4334
4334
  "document": "RO 节点拓扑。",
4335
- "example": "",
4335
+ "example": "[{\"IsRandomZone\": \"\",\"Zone\": \"ap-guangzhou-2\",\"NodeId\": \"dbn-73ktf111\"}]",
4336
4336
  "member": "ReadonlyNode",
4337
4337
  "name": "ReadOnlyNodes",
4338
4338
  "required": false,
@@ -5594,7 +5594,7 @@
5594
5594
  {
5595
5595
  "disabled": false,
5596
5596
  "document": "私有网络 ID,如果不传则默认选择基础网络,请使用 [查询私有网络列表](/document/api/215/15778) 。\n说明:如果创建的是集群版实例,此参数为必填且为私有网络类型。",
5597
- "example": "vpc-***",
5597
+ "example": "vpc-5l7l5q11",
5598
5598
  "member": "string",
5599
5599
  "name": "UniqVpcId",
5600
5600
  "required": false,
@@ -5603,7 +5603,7 @@
5603
5603
  {
5604
5604
  "disabled": false,
5605
5605
  "document": "私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。",
5606
- "example": "subnet-***",
5606
+ "example": "subnet-b5v6i111",
5607
5607
  "member": "string",
5608
5608
  "name": "UniqSubnetId",
5609
5609
  "required": false,
@@ -5620,7 +5620,7 @@
5620
5620
  },
5621
5621
  {
5622
5622
  "disabled": false,
5623
- "document": "可用区信息,该参数缺省时,系统会自动选择一个可用区,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。",
5623
+ "document": "可用区信息,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。\n说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建集群版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。",
5624
5624
  "example": "ap-beijing-3",
5625
5625
  "member": "string",
5626
5626
  "name": "Zone",
@@ -5630,7 +5630,7 @@
5630
5630
  {
5631
5631
  "disabled": false,
5632
5632
  "document": "实例 ID,购买只读实例或者灾备实例时必填,该字段表示只读实例或者灾备实例的主实例 ID,请使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。",
5633
- "example": "cdb-***",
5633
+ "example": "cdb-q72dno11",
5634
5634
  "member": "string",
5635
5635
  "name": "MasterInstanceId",
5636
5636
  "required": false,
@@ -5638,7 +5638,7 @@
5638
5638
  },
5639
5639
  {
5640
5640
  "disabled": false,
5641
- "document": "实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。",
5641
+ "document": "实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。\n说明:必填项。",
5642
5642
  "example": "master",
5643
5643
  "member": "string",
5644
5644
  "name": "InstanceRole",
@@ -5701,7 +5701,7 @@
5701
5701
  },
5702
5702
  {
5703
5703
  "disabled": false,
5704
- "document": "备库 1 的可用区信息,默认为 Zone 的值,购买主实例时可指定该参数,购买只读实例或者灾备实例时指定该参数无意义。",
5704
+ "document": "备库 1 的可用区信息。\n说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;集群版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。",
5705
5705
  "example": "ap-beijing-3",
5706
5706
  "member": "string",
5707
5707
  "name": "SlaveZone",
@@ -5729,7 +5729,7 @@
5729
5729
  {
5730
5730
  "disabled": false,
5731
5731
  "document": "只读实例信息。购买只读实例时,该参数必传。",
5732
- "example": "null",
5732
+ "example": "{\"RoGroupMode\": \"allinone\",\"RoGroupName\": \"jersey\",\"RoMaxDelayTime\": \"5\",\"MinRoInGroup\": \"1\",\"RoOfflineDelay\": \"1\"}",
5733
5733
  "member": "RoGroup",
5734
5734
  "name": "RoGroup",
5735
5735
  "required": false,
@@ -5747,7 +5747,7 @@
5747
5747
  {
5748
5748
  "disabled": false,
5749
5749
  "document": "实例名称。一次购买多个实例命名会用后缀数字区分,例instanceName=db,goodsNum=3,实例命名分别为db1,db2,db3。",
5750
- "example": "***",
5750
+ "example": "cdbzhang",
5751
5751
  "member": "string",
5752
5752
  "name": "InstanceName",
5753
5753
  "required": false,
@@ -5900,7 +5900,7 @@
5900
5900
  {
5901
5901
  "disabled": false,
5902
5902
  "document": "集群版节点拓扑配置。\n说明:若购买的是集群版实例,此参数为必填,需设置集群版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。",
5903
- "example": "",
5903
+ "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
5904
5904
  "member": "ClusterTopology",
5905
5905
  "name": "ClusterTopology",
5906
5906
  "required": false,
@@ -5914,6 +5914,15 @@
5914
5914
  "name": "DiskType",
5915
5915
  "required": false,
5916
5916
  "type": "string"
5917
+ },
5918
+ {
5919
+ "disabled": false,
5920
+ "document": "集群类型:cage——金融围拢,cdc——CDB ON CDC;dedicate——独享集群",
5921
+ "example": "cage",
5922
+ "member": "string",
5923
+ "name": "ClusterType",
5924
+ "required": false,
5925
+ "type": "string"
5917
5926
  }
5918
5927
  ],
5919
5928
  "type": "object"
@@ -5991,7 +6000,7 @@
5991
6000
  },
5992
6001
  {
5993
6002
  "disabled": false,
5994
- "document": "可用区信息,该参数缺省时,系统会自动选择一个可用区,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。",
6003
+ "document": "可用区信息,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。\n说明:若您创建单节点、双节点、三节点实例,此参数为必填项,请指定可用区,若不指定可用区,则系统会自动选择一个可用区(可能不是您希望部署的可用区);若您创建集群版实例,此参数不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置。",
5995
6004
  "example": "ap-beijing-3",
5996
6005
  "member": "string",
5997
6006
  "name": "Zone",
@@ -6001,7 +6010,7 @@
6001
6010
  {
6002
6011
  "disabled": false,
6003
6012
  "document": "私有网络 ID,如果不传则默认选择基础网络,请使用 [查询私有网络列表](/document/api/215/15778)。\n说明:如果创建的是集群版实例,此参数为必填且为私有网络类型。",
6004
- "example": "vpc-***",
6013
+ "example": "vpc-5l7l5q11",
6005
6014
  "member": "string",
6006
6015
  "name": "UniqVpcId",
6007
6016
  "required": false,
@@ -6010,7 +6019,7 @@
6010
6019
  {
6011
6020
  "disabled": false,
6012
6021
  "document": "私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。",
6013
- "example": "subnet-***",
6022
+ "example": "subnet-b5v6i111",
6014
6023
  "member": "string",
6015
6024
  "name": "UniqSubnetId",
6016
6025
  "required": false,
@@ -6036,7 +6045,7 @@
6036
6045
  },
6037
6046
  {
6038
6047
  "disabled": false,
6039
- "document": "实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。",
6048
+ "document": "实例类型,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。\n说明:必填项。",
6040
6049
  "example": "master",
6041
6050
  "member": "string",
6042
6051
  "name": "InstanceRole",
@@ -6045,8 +6054,8 @@
6045
6054
  },
6046
6055
  {
6047
6056
  "disabled": false,
6048
- "document": "实例 ID,购买只读实例时必填,该字段表示只读实例的主实例ID,请使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。",
6049
- "example": "cdb-***",
6057
+ "document": "实例 ID,购买只读实例时必填,该字段表示只读实例的主实例 ID,请使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。",
6058
+ "example": "cdb-q72dnodd",
6050
6059
  "member": "string",
6051
6060
  "name": "MasterInstanceId",
6052
6061
  "required": false,
@@ -6090,7 +6099,7 @@
6090
6099
  },
6091
6100
  {
6092
6101
  "disabled": false,
6093
- "document": "备库 1 的可用区信息,默认为 Zone 的值。",
6102
+ "document": "备库 1 的可用区信息。\n说明:双节点、三节点实例请指定此参数值,若不指定,则默认为 Zone 的值;集群版实例此参数可不填,请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置;单节点实例为单可用区,无需指定此参数。",
6094
6103
  "example": "ap-beijing-3",
6095
6104
  "member": "string",
6096
6105
  "name": "SlaveZone",
@@ -6154,7 +6163,7 @@
6154
6163
  {
6155
6164
  "disabled": false,
6156
6165
  "document": "实例名称。一次购买多个实例命名会用后缀数字区分,例instnaceName=db,goodsNum=3,实例命名分别为db1,db2,db3。",
6157
- "example": "***",
6166
+ "example": "cdbzhang",
6158
6167
  "member": "string",
6159
6168
  "name": "InstanceName",
6160
6169
  "required": false,
@@ -6307,7 +6316,7 @@
6307
6316
  {
6308
6317
  "disabled": false,
6309
6318
  "document": "集群版节点拓扑配置。\n说明:若购买的是集群版实例,此参数为必填,需设置集群版实例的 RW 和 RO 节点拓扑,RO 节点范围是1 - 5个,请至少设置1个 RO 节点。",
6310
- "example": "",
6319
+ "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
6311
6320
  "member": "ClusterTopology",
6312
6321
  "name": "ClusterTopology",
6313
6322
  "required": false,
@@ -6748,21 +6757,23 @@
6748
6757
  "members": [
6749
6758
  {
6750
6759
  "disabled": false,
6751
- "document": "切换时间,格式为:2017-09-03 01:34:31",
6752
- "example": "",
6760
+ "document": "切换时间,格式为:2017-09-03 01:34:31\n注意:此字段可能返回 null,表示取不到有效值。",
6761
+ "example": "2024-09-03 01:34:31",
6753
6762
  "member": "datetime",
6754
6763
  "name": "SwitchTime",
6755
- "required": true,
6756
- "type": "string"
6764
+ "output_required": true,
6765
+ "type": "string",
6766
+ "value_allowed_null": true
6757
6767
  },
6758
6768
  {
6759
6769
  "disabled": false,
6760
- "document": "切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复",
6761
- "example": "",
6770
+ "document": "切换类型,可能的返回值为:TRANSFER - 数据迁移;MASTER2SLAVE - 主备切换;RECOVERY - 主从恢复\n注意:此字段可能返回 null,表示取不到有效值。",
6771
+ "example": "MASTER2SLAVE",
6762
6772
  "member": "string",
6763
6773
  "name": "SwitchType",
6764
- "required": true,
6765
- "type": "string"
6774
+ "output_required": true,
6775
+ "type": "string",
6776
+ "value_allowed_null": true
6766
6777
  }
6767
6778
  ],
6768
6779
  "usage": "out"
@@ -7003,7 +7014,7 @@
7003
7014
  },
7004
7015
  {
7005
7016
  "disabled": false,
7006
- "document": "备份任务 ID。该任务 ID 为 [创建云数据库备份](https://cloud.tencent.com/document/api/236/15844) 接口返回的任务 ID。",
7017
+ "document": "备份任务 ID。您可通过 [查询数据备份文件列表](https://cloud.tencent.com/document/api/236/15842) 来获取目标备份任务 ID。",
7007
7018
  "example": "173381",
7008
7019
  "member": "int64",
7009
7020
  "name": "BackupId",
@@ -7153,6 +7164,15 @@
7153
7164
  "name": "Password",
7154
7165
  "required": true,
7155
7166
  "type": "string"
7167
+ },
7168
+ {
7169
+ "disabled": false,
7170
+ "document": "传入不为空则对密码进行了加密处理",
7171
+ "example": "无",
7172
+ "member": "string",
7173
+ "name": "EncryptMethod",
7174
+ "required": false,
7175
+ "type": "string"
7156
7176
  }
7157
7177
  ],
7158
7178
  "type": "object"
@@ -9139,8 +9159,8 @@
9139
9159
  "members": [
9140
9160
  {
9141
9161
  "disabled": false,
9142
- "document": "实例id。",
9143
- "example": "cdb-xxx",
9162
+ "document": "实例 ID。",
9163
+ "example": "cdb-dctw4edd",
9144
9164
  "member": "string",
9145
9165
  "name": "InstanceId",
9146
9166
  "required": true,
@@ -9155,7 +9175,7 @@
9155
9175
  {
9156
9176
  "disabled": false,
9157
9177
  "document": "实例名称。",
9158
- "example": "",
9178
+ "example": "cdb38936",
9159
9179
  "member": "string",
9160
9180
  "name": "ClusterName",
9161
9181
  "output_required": false,
@@ -9165,7 +9185,7 @@
9165
9185
  {
9166
9186
  "disabled": false,
9167
9187
  "document": "集群读写地址信息。",
9168
- "example": "",
9188
+ "example": "10.1.*.1:3306",
9169
9189
  "member": "AddressInfo",
9170
9190
  "name": "ReadWriteAddress",
9171
9191
  "output_required": false,
@@ -9175,7 +9195,7 @@
9175
9195
  {
9176
9196
  "disabled": false,
9177
9197
  "document": "集群只读地址信息。",
9178
- "example": "",
9198
+ "example": "10.1.*.2:3306",
9179
9199
  "member": "AddressInfo",
9180
9200
  "name": "ReadOnlyAddress",
9181
9201
  "output_required": false,
@@ -9185,7 +9205,7 @@
9185
9205
  {
9186
9206
  "disabled": false,
9187
9207
  "document": "集群节点列表信息。",
9188
- "example": "",
9208
+ "example": "[{\"NodeId\": \"dbn-qqeo1111\",\"Role\": \"master\",\"Zone\": \"ap-guangzhou-1\",\"Weight\": 1,\"Status\": \"online\"},{\"NodeId\": \"dbn-qqeo2222\",\"Role\": \"slave\",\"Zone\": \"ap-guangzhou-2\",\"Weight\": 1,\"Status\": \"online\"}]",
9189
9209
  "member": "ClusterNodeInfo",
9190
9210
  "name": "NodeList",
9191
9211
  "output_required": false,
@@ -9195,7 +9215,7 @@
9195
9215
  {
9196
9216
  "disabled": false,
9197
9217
  "document": "只读空间保护阈值,单位GB",
9198
- "example": "",
9218
+ "example": "2",
9199
9219
  "member": "int64",
9200
9220
  "name": "ReadonlyLimit",
9201
9221
  "output_required": false,
@@ -9205,7 +9225,7 @@
9205
9225
  {
9206
9226
  "disabled": false,
9207
9227
  "document": "实例节点数。",
9208
- "example": "",
9228
+ "example": "2",
9209
9229
  "member": "int64",
9210
9230
  "name": "NodeCount",
9211
9231
  "output_required": false,
@@ -9296,63 +9316,70 @@
9296
9316
  {
9297
9317
  "disabled": false,
9298
9318
  "document": "是否支持数据库审计功能。",
9299
- "example": "1",
9319
+ "example": "true",
9300
9320
  "member": "bool",
9301
9321
  "name": "IsSupportAudit",
9322
+ "output_required": true,
9302
9323
  "type": "bool",
9303
9324
  "value_allowed_null": false
9304
9325
  },
9305
9326
  {
9306
9327
  "disabled": false,
9307
9328
  "document": "开启审计是否需要升级内核版本。",
9308
- "example": "",
9329
+ "example": "false",
9309
9330
  "member": "bool",
9310
9331
  "name": "AuditNeedUpgrade",
9332
+ "output_required": true,
9311
9333
  "type": "bool",
9312
9334
  "value_allowed_null": false
9313
9335
  },
9314
9336
  {
9315
9337
  "disabled": false,
9316
9338
  "document": "是否支持数据库加密功能。",
9317
- "example": "1",
9339
+ "example": "true",
9318
9340
  "member": "bool",
9319
9341
  "name": "IsSupportEncryption",
9342
+ "output_required": true,
9320
9343
  "type": "bool",
9321
9344
  "value_allowed_null": false
9322
9345
  },
9323
9346
  {
9324
9347
  "disabled": false,
9325
9348
  "document": "开启加密是否需要升级内核版本。",
9326
- "example": "",
9349
+ "example": "false",
9327
9350
  "member": "bool",
9328
9351
  "name": "EncryptionNeedUpgrade",
9352
+ "output_required": true,
9329
9353
  "type": "bool",
9330
9354
  "value_allowed_null": false
9331
9355
  },
9332
9356
  {
9333
9357
  "disabled": false,
9334
9358
  "document": "是否为异地只读实例。",
9335
- "example": "",
9359
+ "example": "false",
9336
9360
  "member": "bool",
9337
9361
  "name": "IsRemoteRo",
9362
+ "output_required": true,
9338
9363
  "type": "bool",
9339
9364
  "value_allowed_null": false
9340
9365
  },
9341
9366
  {
9342
9367
  "disabled": false,
9343
- "document": "主实例所在地域。",
9344
- "example": "",
9368
+ "document": "主实例所在地域。\n说明:此参数可能返回空值,您可忽略此出参返回值。如需获取实例所在地域详情,您可调用 [查询实例列表](https://cloud.tencent.com/document/product/236/15872) 接口查询。",
9369
+ "example": "ap-beijing",
9345
9370
  "member": "string",
9346
9371
  "name": "MasterRegion",
9372
+ "output_required": true,
9347
9373
  "type": "string",
9348
9374
  "value_allowed_null": false
9349
9375
  },
9350
9376
  {
9351
9377
  "disabled": false,
9352
9378
  "document": "是否支持小版本升级。",
9353
- "example": "1",
9379
+ "example": "true",
9354
9380
  "member": "bool",
9355
9381
  "name": "IsSupportUpdateSubVersion",
9382
+ "output_required": true,
9356
9383
  "type": "bool",
9357
9384
  "value_allowed_null": false
9358
9385
  },
@@ -9362,6 +9389,7 @@
9362
9389
  "example": "20190203",
9363
9390
  "member": "string",
9364
9391
  "name": "CurrentSubVersion",
9392
+ "output_required": true,
9365
9393
  "type": "string",
9366
9394
  "value_allowed_null": false
9367
9395
  },
@@ -9371,6 +9399,7 @@
9371
9399
  "example": "20190930",
9372
9400
  "member": "string",
9373
9401
  "name": "TargetSubVersion",
9402
+ "output_required": true,
9374
9403
  "type": "string",
9375
9404
  "value_allowed_null": false
9376
9405
  },
@@ -9632,7 +9661,7 @@
9632
9661
  "members": [
9633
9662
  {
9634
9663
  "disabled": false,
9635
- "document": "实例 ID 。",
9664
+ "document": "实例 ID。",
9636
9665
  "example": "cdb-59dm059k",
9637
9666
  "member": "string",
9638
9667
  "name": "InstanceId",
@@ -9651,7 +9680,7 @@
9651
9680
  "example": "cdb-59dm059k",
9652
9681
  "member": "string",
9653
9682
  "name": "InstanceId",
9654
- "required": true,
9683
+ "output_required": true,
9655
9684
  "type": "string",
9656
9685
  "value_allowed_null": false
9657
9686
  },
@@ -9661,7 +9690,7 @@
9661
9690
  "example": "your_cdb_name",
9662
9691
  "member": "string",
9663
9692
  "name": "InstanceName",
9664
- "required": true,
9693
+ "output_required": true,
9665
9694
  "type": "string",
9666
9695
  "value_allowed_null": false
9667
9696
  },
@@ -9671,27 +9700,27 @@
9671
9700
  "example": "NO",
9672
9701
  "member": "string",
9673
9702
  "name": "Encryption",
9674
- "required": true,
9703
+ "output_required": true,
9675
9704
  "type": "string",
9676
9705
  "value_allowed_null": false
9677
9706
  },
9678
9707
  {
9679
9708
  "disabled": false,
9680
9709
  "document": "加密使用的密钥 ID 。\n注意:此字段可能返回 null,表示取不到有效值。",
9681
- "example": "''",
9710
+ "example": "***-CDB",
9682
9711
  "member": "string",
9683
9712
  "name": "KeyId",
9684
- "required": true,
9713
+ "output_required": true,
9685
9714
  "type": "string",
9686
9715
  "value_allowed_null": true
9687
9716
  },
9688
9717
  {
9689
9718
  "disabled": false,
9690
9719
  "document": "密钥所在地域。\n注意:此字段可能返回 null,表示取不到有效值。",
9691
- "example": "''",
9720
+ "example": "ap-guangzhou",
9692
9721
  "member": "string",
9693
9722
  "name": "KeyRegion",
9694
- "required": true,
9723
+ "output_required": true,
9695
9724
  "type": "string",
9696
9725
  "value_allowed_null": true
9697
9726
  },
@@ -9701,7 +9730,7 @@
9701
9730
  "example": "ap-shanghai",
9702
9731
  "member": "string",
9703
9732
  "name": "DefaultKmsRegion",
9704
- "required": true,
9733
+ "output_required": true,
9705
9734
  "type": "string",
9706
9735
  "value_allowed_null": true
9707
9736
  },
@@ -9775,8 +9804,8 @@
9775
9804
  "members": [
9776
9805
  {
9777
9806
  "disabled": false,
9778
- "document": "实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
9779
- "example": "[\"cdb-f35wr6wj\\r\\n\"]",
9807
+ "document": "实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。\n说明:可输入多个实例 ID 进行查询,json 格式如下。\n[\n \"cdb-30z11v8s\",\n \"cdb-93h11efg\"\n ]",
9808
+ "example": "cdb-f35wr6wj",
9780
9809
  "member": "string",
9781
9810
  "name": "InstanceIds",
9782
9811
  "required": true,
@@ -9794,17 +9823,17 @@
9794
9823
  "example": "1",
9795
9824
  "member": "int64",
9796
9825
  "name": "TotalCount",
9797
- "required": true,
9826
+ "output_required": true,
9798
9827
  "type": "int",
9799
9828
  "value_allowed_null": false
9800
9829
  },
9801
9830
  {
9802
9831
  "disabled": false,
9803
9832
  "document": "返回的参数信息。",
9804
- "example": "",
9833
+ "example": "[{\"TimeInSeconds\": 50,\"InstanceId\": \"cdb-rozjda3j\"}]",
9805
9834
  "member": "InstanceRebootTime",
9806
9835
  "name": "Items",
9807
- "required": true,
9836
+ "output_required": true,
9808
9837
  "type": "list",
9809
9838
  "value_allowed_null": false
9810
9839
  },
@@ -10211,7 +10240,7 @@
10211
10240
  },
10212
10241
  {
10213
10242
  "disabled": false,
10214
- "document": "实例内存大小,单位:MB。InstanceId为空时该参数为必填项。",
10243
+ "document": "实例内存大小,单位:MB。InstanceId 为空时该参数为必填项。为保证传入值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可售卖的实例内存大小范围。",
10215
10244
  "example": "1000",
10216
10245
  "member": "int64",
10217
10246
  "name": "Memory",
@@ -10220,7 +10249,7 @@
10220
10249
  },
10221
10250
  {
10222
10251
  "disabled": false,
10223
- "document": "实例硬盘大小,单位:GB。InstanceId为空时该参数为必填项。",
10252
+ "document": "实例硬盘大小,单位:GB。InstanceId 为空时该参数为必填项。为保证传入值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可售卖的硬盘大小范围。",
10224
10253
  "example": "50",
10225
10254
  "member": "int64",
10226
10255
  "name": "Volume",
@@ -10256,7 +10285,7 @@
10256
10285
  },
10257
10286
  {
10258
10287
  "disabled": false,
10259
- "document": "实例隔离类型。支持值包括: \"UNIVERSAL\" - 通用型实例, \"EXCLUSIVE\" - 独享型实例, \"BASIC_V2\" - 单节点云盘版实例。 不指定则默认为通用型实例。",
10288
+ "document": "实例隔离类型。支持值包括: \"UNIVERSAL\" - 通用型实例, \"EXCLUSIVE\" - 独享型实例, \"BASIC_V2\" - 单节点云盘版实例。 \"CLOUD_NATIVE_CLUSTER\" - 集群版标准型, \"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 集群版加强型。 不指定则默认为通用型实例。",
10260
10289
  "example": "UNIVERSAL",
10261
10290
  "member": "string",
10262
10291
  "name": "DeviceType",
@@ -10298,6 +10327,15 @@
10298
10327
  "name": "Ladder",
10299
10328
  "required": false,
10300
10329
  "type": "int"
10330
+ },
10331
+ {
10332
+ "disabled": false,
10333
+ "document": "磁盘类型,查询集群版、单节点云盘版实例价格可以指定该参数。支持值包括: \"CLOUD_SSD\" - SSD云硬盘, \"CLOUD_HSSD\" - 增强型SSD云硬盘。 默认为 SSD云硬盘。",
10334
+ "example": "CLOUD_SSD",
10335
+ "member": "string",
10336
+ "name": "DiskType",
10337
+ "required": false,
10338
+ "type": "string"
10301
10339
  }
10302
10340
  ],
10303
10341
  "type": "object"
@@ -10422,7 +10460,7 @@
10422
10460
  },
10423
10461
  {
10424
10462
  "disabled": false,
10425
- "document": "分页大小,默认值为 50,最小值为 1,最大值为 2000。",
10463
+ "document": "分页大小,默认值为50,最小值为1,最大值为1000。",
10426
10464
  "example": "10",
10427
10465
  "member": "int64",
10428
10466
  "name": "Limit",
@@ -10441,17 +10479,17 @@
10441
10479
  "example": "1",
10442
10480
  "member": "int64",
10443
10481
  "name": "TotalCount",
10444
- "required": true,
10482
+ "output_required": true,
10445
10483
  "type": "int",
10446
10484
  "value_allowed_null": false
10447
10485
  },
10448
10486
  {
10449
10487
  "disabled": false,
10450
10488
  "document": "实例切换记录详情。",
10451
- "example": "",
10489
+ "example": "[{\"SwitchTime\": \"2017-11-07 15:15:48\",\"SwitchType\": \"TRANSFER\"}]",
10452
10490
  "member": "DBSwitchInfo",
10453
10491
  "name": "Items",
10454
- "required": true,
10492
+ "output_required": true,
10455
10493
  "type": "list",
10456
10494
  "value_allowed_null": false
10457
10495
  },
@@ -11199,8 +11237,8 @@
11199
11237
  "members": [
11200
11238
  {
11201
11239
  "disabled": false,
11202
- "document": "实例id",
11203
- "example": "cdb-xxx",
11240
+ "document": "实例 ID。",
11241
+ "example": "cdb-2wpip1dd",
11204
11242
  "member": "string",
11205
11243
  "name": "InstanceId",
11206
11244
  "required": true,
@@ -11208,7 +11246,7 @@
11208
11246
  },
11209
11247
  {
11210
11248
  "disabled": false,
11211
- "document": "目标实例cpu",
11249
+ "document": "目标实例 CPU 的核数。",
11212
11250
  "example": "2",
11213
11251
  "member": "float",
11214
11252
  "name": "DstCpu",
@@ -11217,7 +11255,7 @@
11217
11255
  },
11218
11256
  {
11219
11257
  "disabled": false,
11220
- "document": "目标实例内存",
11258
+ "document": "目标实例内存大小,单位:MB。",
11221
11259
  "example": "4000",
11222
11260
  "member": "uint64",
11223
11261
  "name": "DstMemory",
@@ -11226,8 +11264,8 @@
11226
11264
  },
11227
11265
  {
11228
11266
  "disabled": false,
11229
- "document": "目标实例磁盘",
11230
- "example": "8000",
11267
+ "document": "目标实例磁盘大小,单位:GB。",
11268
+ "example": "1000",
11231
11269
  "member": "uint64",
11232
11270
  "name": "DstDisk",
11233
11271
  "required": true,
@@ -11235,7 +11273,7 @@
11235
11273
  },
11236
11274
  {
11237
11275
  "disabled": false,
11238
- "document": "目标实例版本",
11276
+ "document": "目标实例数据库版本。",
11239
11277
  "example": "5.7",
11240
11278
  "member": "string",
11241
11279
  "name": "DstVersion",
@@ -11244,7 +11282,7 @@
11244
11282
  },
11245
11283
  {
11246
11284
  "disabled": false,
11247
- "document": "目标实例部署模型",
11285
+ "document": "目标实例部署模型。",
11248
11286
  "example": "0",
11249
11287
  "member": "int64",
11250
11288
  "name": "DstDeployMode",
@@ -11253,7 +11291,7 @@
11253
11291
  },
11254
11292
  {
11255
11293
  "disabled": false,
11256
- "document": "目标实例复制类型",
11294
+ "document": "目标实例复制类型。",
11257
11295
  "example": "0",
11258
11296
  "member": "int64",
11259
11297
  "name": "DstProtectMode",
@@ -11262,7 +11300,7 @@
11262
11300
  },
11263
11301
  {
11264
11302
  "disabled": false,
11265
- "document": "目标实例备机1可用区",
11303
+ "document": "目标实例备机1可用区。",
11266
11304
  "example": "100001",
11267
11305
  "member": "int64",
11268
11306
  "name": "DstSlaveZone",
@@ -11271,7 +11309,7 @@
11271
11309
  },
11272
11310
  {
11273
11311
  "disabled": false,
11274
- "document": "目标实例备机2可用区",
11312
+ "document": "目标实例备机2可用区。",
11275
11313
  "example": "100001",
11276
11314
  "member": "int64",
11277
11315
  "name": "DstBackupZone",
@@ -11280,7 +11318,7 @@
11280
11318
  },
11281
11319
  {
11282
11320
  "disabled": false,
11283
- "document": "目标实例类型",
11321
+ "document": "目标实例类型。",
11284
11322
  "example": "CUSTOM",
11285
11323
  "member": "string",
11286
11324
  "name": "DstCdbType",
@@ -11289,7 +11327,7 @@
11289
11327
  },
11290
11328
  {
11291
11329
  "disabled": false,
11292
- "document": "目标实例主可用区",
11330
+ "document": "目标实例主可用区。",
11293
11331
  "example": "100001",
11294
11332
  "member": "int64",
11295
11333
  "name": "DstZoneId",
@@ -11298,8 +11336,8 @@
11298
11336
  },
11299
11337
  {
11300
11338
  "disabled": false,
11301
- "document": "独享集群CDB实例的节点分布情况",
11302
- "example": "",
11339
+ "document": "独享集群 CDB 实例的节点分布情况。",
11340
+ "example": " [{\"Node\": dch-fexbu7pp,\"SlaveNodeOne\": \"dch-cawss6q\",\"SlaveNodeTwo\": \"dch-bsxj39l\"}]",
11303
11341
  "member": "NodeDistribution",
11304
11342
  "name": "NodeDistribution",
11305
11343
  "required": false,
@@ -11308,7 +11346,7 @@
11308
11346
  {
11309
11347
  "disabled": false,
11310
11348
  "document": "集群版的节点拓扑配置",
11311
- "example": "",
11349
+ "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
11312
11350
  "member": "ClusterTopology",
11313
11351
  "name": "ClusterTopology",
11314
11352
  "required": false,
@@ -11322,8 +11360,8 @@
11322
11360
  "members": [
11323
11361
  {
11324
11362
  "disabled": false,
11325
- "document": "实例id",
11326
- "example": "cdb-xxx",
11363
+ "document": "实例 ID。",
11364
+ "example": "cdb-2wpip1dd",
11327
11365
  "member": "string",
11328
11366
  "name": "InstanceId",
11329
11367
  "output_required": true,
@@ -11332,7 +11370,7 @@
11332
11370
  },
11333
11371
  {
11334
11372
  "disabled": false,
11335
- "document": "实例升级类型",
11373
+ "document": "实例升级类型。",
11336
11374
  "example": "Trsf",
11337
11375
  "member": "string",
11338
11376
  "name": "UpgradeType",
@@ -11900,7 +11938,7 @@
11900
11938
  "members": [
11901
11939
  {
11902
11940
  "disabled": false,
11903
- "document": "实例ID,格式如:cdb-c1nl9rpv或者cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同。",
11941
+ "document": "实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
11904
11942
  "example": "cdb-eggz8oj5",
11905
11943
  "member": "string",
11906
11944
  "name": "InstanceId",
@@ -11915,11 +11953,11 @@
11915
11953
  "members": [
11916
11954
  {
11917
11955
  "disabled": false,
11918
- "document": "RO组信息数组,一个实例可关联多个RO组。",
11956
+ "document": "RO 组信息数组,一个实例可关联多个 RO 组。",
11919
11957
  "example": "无",
11920
11958
  "member": "RoGroup",
11921
11959
  "name": "RoGroups",
11922
- "required": true,
11960
+ "output_required": true,
11923
11961
  "type": "list",
11924
11962
  "value_allowed_null": false
11925
11963
  },
@@ -13437,70 +13475,6 @@
13437
13475
  ],
13438
13476
  "usage": "out"
13439
13477
  },
13440
- "InitDBInstancesRequest": {
13441
- "document": "InitDBInstances请求参数结构体",
13442
- "members": [
13443
- {
13444
- "disabled": false,
13445
- "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。",
13446
- "example": "[\"cdb-f35wr6wj\\r\\n\"]",
13447
- "member": "string",
13448
- "name": "InstanceIds",
13449
- "required": true,
13450
- "type": "list"
13451
- },
13452
- {
13453
- "disabled": false,
13454
- "document": "实例新的密码,密码规则:8-64个字符,至少包含字母、数字、字符(支持的字符:!@#$%^*())中的两种。",
13455
- "example": "Gx18ux23F^X",
13456
- "member": "string",
13457
- "name": "NewPassword",
13458
- "required": true,
13459
- "type": "string"
13460
- },
13461
- {
13462
- "disabled": false,
13463
- "document": "实例的参数列表,目前支持设置“character_set_server”、“lower_case_table_names”参数。其中,“character_set_server”参数可选值为[\"utf8\",\"latin1\",\"gbk\",\"utf8mb4\"];“lower_case_table_names”可选值为[“0”,“1”]。",
13464
- "example": "无",
13465
- "member": "ParamInfo",
13466
- "name": "Parameters",
13467
- "required": true,
13468
- "type": "list"
13469
- },
13470
- {
13471
- "disabled": false,
13472
- "document": "实例的端口,取值范围为[1024, 65535]",
13473
- "example": "无",
13474
- "member": "int64",
13475
- "name": "Vport",
13476
- "required": false,
13477
- "type": "int"
13478
- }
13479
- ],
13480
- "type": "object"
13481
- },
13482
- "InitDBInstancesResponse": {
13483
- "document": "InitDBInstances返回参数结构体",
13484
- "members": [
13485
- {
13486
- "disabled": false,
13487
- "document": "异步任务的请求ID数组,可使用此ID查询异步任务的执行结果",
13488
- "example": "[\"8cd119d4-61ba-11e7-aeff-018cfa1f5560\"]",
13489
- "member": "string",
13490
- "name": "AsyncRequestIds",
13491
- "required": true,
13492
- "type": "list",
13493
- "value_allowed_null": false
13494
- },
13495
- {
13496
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
13497
- "member": "string",
13498
- "name": "RequestId",
13499
- "type": "string"
13500
- }
13501
- ],
13502
- "type": "object"
13503
- },
13504
13478
  "InquiryPriceUpgradeInstancesRequest": {
13505
13479
  "document": "InquiryPriceUpgradeInstances请求参数结构体",
13506
13480
  "members": [
@@ -14282,21 +14256,23 @@
14282
14256
  "members": [
14283
14257
  {
14284
14258
  "disabled": false,
14285
- "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同",
14286
- "example": "",
14259
+ "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同\n注意:此字段可能返回 null,表示取不到有效值。",
14260
+ "example": "cdb-c1nl9rpv",
14287
14261
  "member": "string",
14288
14262
  "name": "InstanceId",
14289
- "required": true,
14290
- "type": "string"
14263
+ "output_required": true,
14264
+ "type": "string",
14265
+ "value_allowed_null": true
14291
14266
  },
14292
14267
  {
14293
14268
  "disabled": false,
14294
- "document": "预期重启时间",
14295
- "example": "",
14269
+ "document": "预期重启时间\n注意:此字段可能返回 null,表示取不到有效值。",
14270
+ "example": "360",
14296
14271
  "member": "int64",
14297
14272
  "name": "TimeInSeconds",
14298
- "required": true,
14299
- "type": "int"
14273
+ "output_required": true,
14274
+ "type": "int",
14275
+ "value_allowed_null": true
14300
14276
  }
14301
14277
  ],
14302
14278
  "usage": "out"
@@ -14963,7 +14939,7 @@
14963
14939
  {
14964
14940
  "disabled": false,
14965
14941
  "document": "全局权限。其中,GlobalPrivileges 中权限的可选值为:\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"PROCESS\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"SHOW DATABASES\",\"CREATE TEMPORARY TABLES\",\"LOCK TABLES\",\"EXECUTE\",\"CREATE VIEW\",\"SHOW VIEW\",\"CREATE ROUTINE\",\"ALTER ROUTINE\",\"EVENT\",\"TRIGGER\",\"CREATE USER\",\"RELOAD\",\"REPLICATION CLIENT\",\"REPLICATION SLAVE\"。\n注意,ModifyAction为空时,不传该参数表示清除该权限。",
14966
- "example": "[\"SELECT\\n\"]",
14942
+ "example": "[\"SELECT\"]",
14967
14943
  "member": "string",
14968
14944
  "name": "GlobalPrivileges",
14969
14945
  "required": false,
@@ -15017,7 +14993,7 @@
15017
14993
  "example": "256117ed-efa08b54-61784d44-91781bbd",
15018
14994
  "member": "string",
15019
14995
  "name": "AsyncRequestId",
15020
- "required": true,
14996
+ "output_required": true,
15021
14997
  "type": "string",
15022
14998
  "value_allowed_null": false
15023
14999
  },
@@ -15296,8 +15272,8 @@
15296
15272
  "members": [
15297
15273
  {
15298
15274
  "disabled": false,
15299
- "document": "实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
15300
- "example": "[\"cdb-f35wr6wj\\r\\n\"]",
15275
+ "document": "实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。\n说明:可输入多个实例 ID 进行修改,json 格式如下。\n[\n \"cdb-30z11v8s\",\n \"cdb-93h11efg\"\n ]",
15276
+ "example": "cdb-f35wr6wj",
15301
15277
  "member": "string",
15302
15278
  "name": "InstanceIds",
15303
15279
  "required": true,
@@ -15944,8 +15920,8 @@
15944
15920
  "members": [
15945
15921
  {
15946
15922
  "disabled": false,
15947
- "document": "实例 ID 数组,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。",
15948
- "example": "[\"cdb-f35wr6wj\\r\\n\"]",
15923
+ "document": "实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。\n说明:可输入多个实例 ID 进行修改,json 格式如下。\n[\n \"cdb-30z11v8s\",\n \"cdb-93h11efg\"\n ]",
15924
+ "example": "cdb-f35wr6wj",
15949
15925
  "member": "string",
15950
15926
  "name": "InstanceIds",
15951
15927
  "required": true,
@@ -15953,8 +15929,8 @@
15953
15929
  },
15954
15930
  {
15955
15931
  "disabled": false,
15956
- "document": "项目的 ID",
15957
- "example": "12",
15932
+ "document": "实例所属项目的 ID,可在账号中心下的项目管理页面查询。",
15933
+ "example": "11954",
15958
15934
  "member": "int64",
15959
15935
  "name": "NewProjectId",
15960
15936
  "required": false,
@@ -15975,6 +15951,42 @@
15975
15951
  ],
15976
15952
  "type": "object"
15977
15953
  },
15954
+ "ModifyDBInstanceReadOnlyStatusRequest": {
15955
+ "document": "ModifyDBInstanceReadOnlyStatus请求参数结构体",
15956
+ "members": [
15957
+ {
15958
+ "disabled": false,
15959
+ "document": "实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同,可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。",
15960
+ "example": "cdb-uns231ns",
15961
+ "member": "string",
15962
+ "name": "InstanceId",
15963
+ "required": true,
15964
+ "type": "string"
15965
+ },
15966
+ {
15967
+ "disabled": false,
15968
+ "document": "是否设置为只读。其中:1表示设置实例为只读,0表示解除只读状态",
15969
+ "example": "0",
15970
+ "member": "int64",
15971
+ "name": "ReadOnly",
15972
+ "required": true,
15973
+ "type": "int"
15974
+ }
15975
+ ],
15976
+ "type": "object"
15977
+ },
15978
+ "ModifyDBInstanceReadOnlyStatusResponse": {
15979
+ "document": "ModifyDBInstanceReadOnlyStatus返回参数结构体",
15980
+ "members": [
15981
+ {
15982
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
15983
+ "member": "string",
15984
+ "name": "RequestId",
15985
+ "type": "string"
15986
+ }
15987
+ ],
15988
+ "type": "object"
15989
+ },
15978
15990
  "ModifyDBInstanceSecurityGroupsRequest": {
15979
15991
  "document": "ModifyDBInstanceSecurityGroups请求参数结构体",
15980
15992
  "members": [
@@ -16344,7 +16356,7 @@
16344
16356
  {
16345
16357
  "disabled": false,
16346
16358
  "document": "置放群组 ID。",
16347
- "example": "test",
16359
+ "example": "172837",
16348
16360
  "member": "string",
16349
16361
  "name": "DeployGroupId",
16350
16362
  "required": true,
@@ -16362,7 +16374,7 @@
16362
16374
  {
16363
16375
  "disabled": false,
16364
16376
  "document": "置放群组描述,最长不能超过200个字符。置放群组名和置放群组描述不能都为空。",
16365
- "example": "test",
16377
+ "example": "一区群组",
16366
16378
  "member": "string",
16367
16379
  "name": "Description",
16368
16380
  "required": false,
@@ -16587,8 +16599,8 @@
16587
16599
  },
16588
16600
  {
16589
16601
  "disabled": false,
16590
- "document": "修改后的可维护时间段,其中每一个时间段的格式形如:10:00-12:00;起止时间按半个小时对齐;最短半个小时,最长三个小时;最多设置两个时间段;起止时间范围为:[00:00, 24:00]",
16591
- "example": "[\"03:00-03:30\\r\\n\"]",
16602
+ "document": "修改后的可维护时间段,其中每一个时间段的格式形如:10:00-12:00;起止时间按半个小时对齐;最短半个小时,最长三个小时;最多设置两个时间段;起止时间范围为:[00:00, 24:00]。\n说明:设置两个时间段的 json 示例如下。\n[\n \"01:00-01:30\",\n \"02:00-02:30\"\n ]",
16603
+ "example": "00:00-01:30",
16592
16604
  "member": "string",
16593
16605
  "name": "TimeRanges",
16594
16606
  "required": true,
@@ -16596,8 +16608,8 @@
16596
16608
  },
16597
16609
  {
16598
16610
  "disabled": false,
16599
- "document": "指定修改哪一天的客户时间段,可能的取值为:monday,tuesday,wednesday,thursday,friday,saturday,sunday。如果不指定该值或者为空,则默认一周七天都修改。",
16600
- "example": "[\"monday\\r\\n\"]",
16611
+ "document": "指定修改哪一天的可维护时间段,可能的取值为:monday,tuesday,wednesday,thursday,friday,saturday,sunday。如果不指定该值或者为空,则默认一周七天都修改。\n说明:指定修改多天的 json 示例如下。\n[\n \"monday\",\n \"tuesday\"\n ]",
16612
+ "example": "monday",
16601
16613
  "member": "string",
16602
16614
  "name": "Weekdays",
16603
16615
  "required": false,
@@ -16776,8 +16788,8 @@
16776
16788
  },
16777
16789
  {
16778
16790
  "disabled": false,
16779
- "document": "用户自定义密钥ID,CMK唯一标识符。该值为空时,将使用腾讯云自动生成的密钥KMS-CDB。",
16780
- "example": "testkey",
16791
+ "document": "用户自定义密钥 ID,CMK 唯一标识符。该值为空时,将使用腾讯云自动生成的密钥 KMS-CDB。",
16792
+ "example": "KMS-CDB",
16781
16793
  "member": "string",
16782
16794
  "name": "KeyId",
16783
16795
  "required": false,
@@ -16785,8 +16797,8 @@
16785
16797
  },
16786
16798
  {
16787
16799
  "disabled": false,
16788
- "document": "用户自定义密钥的存储地域。如:ap-guangzhou 。KeyId不为空时,该参数必填。",
16789
- "example": "ap-guangzou",
16800
+ "document": "用户自定义密钥的存储地域。如:ap-guangzhou 。KeyId 不为空时,该参数必填。",
16801
+ "example": "ap-guangzhou",
16790
16802
  "member": "string",
16791
16803
  "name": "KeyRegion",
16792
16804
  "required": false,
@@ -17018,7 +17030,7 @@
17018
17030
  {
17019
17031
  "disabled": false,
17020
17032
  "document": "参数名",
17021
- "example": "",
17033
+ "example": "auto_increment",
17022
17034
  "member": "string",
17023
17035
  "name": "Name",
17024
17036
  "required": true,
@@ -17027,7 +17039,7 @@
17027
17039
  {
17028
17040
  "disabled": false,
17029
17041
  "document": "参数值",
17030
- "example": "",
17042
+ "example": "1",
17031
17043
  "member": "string",
17032
17044
  "name": "Value",
17033
17045
  "required": true,
@@ -17525,6 +17537,7 @@
17525
17537
  "example": "ap-guangzhou",
17526
17538
  "member": "string",
17527
17539
  "name": "Region",
17540
+ "output_required": true,
17528
17541
  "required": true,
17529
17542
  "type": "string",
17530
17543
  "value_allowed_null": false
@@ -17535,6 +17548,7 @@
17535
17548
  "example": "ap-guangzhou-1",
17536
17549
  "member": "string",
17537
17550
  "name": "Zone",
17551
+ "output_required": true,
17538
17552
  "required": true,
17539
17553
  "type": "string",
17540
17554
  "value_allowed_null": false
@@ -17542,9 +17556,10 @@
17542
17556
  {
17543
17557
  "disabled": false,
17544
17558
  "document": "代理实例分布",
17545
- "example": "",
17559
+ "example": "[{\"InstanceId\": \"cdb-aykuksx3\",\"InstanceName\": \"cdb37262\",\"InstanceType\": \"1\",\"Status\": \"1\",\"Weight\": \"100\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"InstNodeId\": \"cbn-ehjshe\",\"InstNodeRole\": \"master\"}]",
17546
17560
  "member": "ProxyInst",
17547
17561
  "name": "ProxyInstance",
17562
+ "output_required": true,
17548
17563
  "required": true,
17549
17564
  "type": "list",
17550
17565
  "value_allowed_null": false
@@ -17675,7 +17690,7 @@
17675
17690
  {
17676
17691
  "disabled": false,
17677
17692
  "document": "实例名称\n注意:此字段可能返回 null,表示取不到有效值。",
17678
- "example": "test",
17693
+ "example": "cdb3874",
17679
17694
  "member": "string",
17680
17695
  "name": "InstanceName",
17681
17696
  "output_required": true,
@@ -17740,25 +17755,25 @@
17740
17755
  },
17741
17756
  {
17742
17757
  "disabled": false,
17743
- "document": "实例节点ID\n注意:此字段可能返回 null,表示取不到有效值。",
17758
+ "document": "实例节点ID",
17744
17759
  "example": "cbn-test",
17745
17760
  "member": "string",
17746
17761
  "name": "InstNodeId",
17747
17762
  "output_required": false,
17748
17763
  "required": false,
17749
17764
  "type": "string",
17750
- "value_allowed_null": true
17765
+ "value_allowed_null": false
17751
17766
  },
17752
17767
  {
17753
17768
  "disabled": false,
17754
- "document": "节点角色\n注意:此字段可能返回 null,表示取不到有效值。",
17769
+ "document": "节点角色",
17755
17770
  "example": "master",
17756
17771
  "member": "string",
17757
17772
  "name": "InstNodeRole",
17758
17773
  "output_required": false,
17759
17774
  "required": false,
17760
17775
  "type": "string",
17761
- "value_allowed_null": true
17776
+ "value_allowed_null": false
17762
17777
  }
17763
17778
  ],
17764
17779
  "usage": "both"
@@ -17934,7 +17949,7 @@
17934
17949
  {
17935
17950
  "disabled": false,
17936
17951
  "document": "指定该节点分布在哪个可用区。",
17937
- "example": "",
17952
+ "example": "ap-beijing-3",
17938
17953
  "member": "string",
17939
17954
  "name": "Zone",
17940
17955
  "required": false,
@@ -17943,7 +17958,7 @@
17943
17958
  {
17944
17959
  "disabled": false,
17945
17960
  "document": "升级集群版实例时,如果要调整只读节点可用区,需要指定节点id。",
17946
- "example": "",
17961
+ "example": "dbn-h7erp111",
17947
17962
  "member": "string",
17948
17963
  "name": "NodeId",
17949
17964
  "required": false,
@@ -17957,8 +17972,8 @@
17957
17972
  "members": [
17958
17973
  {
17959
17974
  "disabled": false,
17960
- "document": "实例 ID 数组,单个实例 ID 格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。",
17961
- "example": "[\"cdb-f35wr6wj\\r\\n\"]",
17975
+ "document": "实例 ID,单个实例 ID 格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。\n说明:可输入多个实例 ID 进行操作,json 格式如下。\n[\n \"cdb-30z11v8s\",\n \"cdb-93h11efg\"\n ]",
17976
+ "example": "cdb-f35wr6wj",
17962
17977
  "member": "string",
17963
17978
  "name": "InstanceIds",
17964
17979
  "required": true,
@@ -17973,7 +17988,7 @@
17973
17988
  {
17974
17989
  "disabled": false,
17975
17990
  "document": "解隔离操作的结果集。",
17976
- "example": "",
17991
+ "example": "[{\"InstanceId\": \"cdb-f35wr6wj\",\"Code\": 0,\"Message\": \"ok\"}]",
17977
17992
  "member": "ReleaseResult",
17978
17993
  "name": "Items",
17979
17994
  "output_required": true,
@@ -17995,30 +18010,30 @@
17995
18010
  {
17996
18011
  "disabled": false,
17997
18012
  "document": "实例 ID。",
17998
- "example": "",
18013
+ "example": "cdb-4zs10111",
17999
18014
  "member": "string",
18000
18015
  "name": "InstanceId",
18001
- "required": true,
18016
+ "output_required": true,
18002
18017
  "type": "string",
18003
18018
  "value_allowed_null": false
18004
18019
  },
18005
18020
  {
18006
18021
  "disabled": false,
18007
18022
  "document": "实例解隔离操作的结果值。返回值为0表示成功。",
18008
- "example": "",
18023
+ "example": "0",
18009
18024
  "member": "int64",
18010
18025
  "name": "Code",
18011
- "required": true,
18026
+ "output_required": true,
18012
18027
  "type": "int",
18013
18028
  "value_allowed_null": false
18014
18029
  },
18015
18030
  {
18016
18031
  "disabled": false,
18017
18032
  "document": "实例解隔离操作的错误信息。",
18018
- "example": "",
18033
+ "example": "",
18019
18034
  "member": "string",
18020
18035
  "name": "Message",
18021
- "required": true,
18036
+ "output_required": true,
18022
18037
  "type": "string",
18023
18038
  "value_allowed_null": false
18024
18039
  }
@@ -18142,7 +18157,7 @@
18142
18157
  {
18143
18158
  "disabled": false,
18144
18159
  "document": "续费时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。",
18145
- "example": "12",
18160
+ "example": "1",
18146
18161
  "member": "int64",
18147
18162
  "name": "TimeSpan",
18148
18163
  "required": true,
@@ -18197,7 +18212,7 @@
18197
18212
  {
18198
18213
  "disabled": false,
18199
18214
  "document": "实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
18200
- "example": "",
18215
+ "example": "cdb-c1nl9rpv",
18201
18216
  "member": "string",
18202
18217
  "name": "InstanceId",
18203
18218
  "required": true,
@@ -18206,7 +18221,7 @@
18206
18221
  {
18207
18222
  "disabled": false,
18208
18223
  "document": "手动刷新轮转密码的实例账户名,例如root",
18209
- "example": "",
18224
+ "example": "andy",
18210
18225
  "member": "string",
18211
18226
  "name": "User",
18212
18227
  "required": true,
@@ -18215,7 +18230,7 @@
18215
18230
  {
18216
18231
  "disabled": false,
18217
18232
  "document": "手动刷新轮转密码的实例账户域名,例如%",
18218
- "example": "",
18233
+ "example": "172.1.1.1",
18219
18234
  "member": "string",
18220
18235
  "name": "Host",
18221
18236
  "required": true,
@@ -18306,9 +18321,10 @@
18306
18321
  {
18307
18322
  "disabled": false,
18308
18323
  "document": "只读组模式,可选值为:alone-系统自动分配只读组;allinone-新建只读组;join-使用现有只读组。",
18309
- "example": "''",
18324
+ "example": "alone",
18310
18325
  "member": "string",
18311
18326
  "name": "RoGroupMode",
18327
+ "output_required": true,
18312
18328
  "required": true,
18313
18329
  "type": "string",
18314
18330
  "value_allowed_null": false
@@ -18319,6 +18335,7 @@
18319
18335
  "example": "cdbrg-92zkeaq2",
18320
18336
  "member": "string",
18321
18337
  "name": "RoGroupId",
18338
+ "output_required": true,
18322
18339
  "required": false,
18323
18340
  "type": "string",
18324
18341
  "value_allowed_null": false
@@ -18329,6 +18346,7 @@
18329
18346
  "example": "your_group_name",
18330
18347
  "member": "string",
18331
18348
  "name": "RoGroupName",
18349
+ "output_required": true,
18332
18350
  "required": false,
18333
18351
  "type": "string",
18334
18352
  "value_allowed_null": false
@@ -18339,6 +18357,7 @@
18339
18357
  "example": "0",
18340
18358
  "member": "int64",
18341
18359
  "name": "RoOfflineDelay",
18360
+ "output_required": true,
18342
18361
  "required": false,
18343
18362
  "type": "int",
18344
18363
  "value_allowed_null": false
@@ -18349,6 +18368,7 @@
18349
18368
  "example": "1",
18350
18369
  "member": "int64",
18351
18370
  "name": "RoMaxDelayTime",
18371
+ "output_required": true,
18352
18372
  "required": false,
18353
18373
  "type": "int",
18354
18374
  "value_allowed_null": false
@@ -18359,6 +18379,7 @@
18359
18379
  "example": "1",
18360
18380
  "member": "int64",
18361
18381
  "name": "MinRoInGroup",
18382
+ "output_required": true,
18362
18383
  "required": false,
18363
18384
  "type": "int",
18364
18385
  "value_allowed_null": false
@@ -18369,6 +18390,7 @@
18369
18390
  "example": "system",
18370
18391
  "member": "string",
18371
18392
  "name": "WeightMode",
18393
+ "output_required": true,
18372
18394
  "required": false,
18373
18395
  "type": "string",
18374
18396
  "value_allowed_null": false
@@ -18379,6 +18401,7 @@
18379
18401
  "example": "0",
18380
18402
  "member": "int64",
18381
18403
  "name": "Weight",
18404
+ "output_required": true,
18382
18405
  "required": false,
18383
18406
  "type": "int",
18384
18407
  "value_allowed_null": false
@@ -18389,6 +18412,7 @@
18389
18412
  "example": "[]",
18390
18413
  "member": "RoInstanceInfo",
18391
18414
  "name": "RoInstances",
18415
+ "output_required": true,
18392
18416
  "required": false,
18393
18417
  "type": "list",
18394
18418
  "value_allowed_null": false
@@ -18399,6 +18423,7 @@
18399
18423
  "example": "10.89.90.66",
18400
18424
  "member": "string",
18401
18425
  "name": "Vip",
18426
+ "output_required": true,
18402
18427
  "required": false,
18403
18428
  "type": "string",
18404
18429
  "value_allowed_null": false
@@ -18409,6 +18434,7 @@
18409
18434
  "example": "3306",
18410
18435
  "member": "int64",
18411
18436
  "name": "Vport",
18437
+ "output_required": true,
18412
18438
  "required": false,
18413
18439
  "type": "int",
18414
18440
  "value_allowed_null": false
@@ -18419,6 +18445,7 @@
18419
18445
  "example": "vpc-ja6ts123",
18420
18446
  "member": "string",
18421
18447
  "name": "UniqVpcId",
18448
+ "output_required": true,
18422
18449
  "required": false,
18423
18450
  "type": "string",
18424
18451
  "value_allowed_null": true
@@ -18429,6 +18456,7 @@
18429
18456
  "example": "subnet-njh2bc99",
18430
18457
  "member": "string",
18431
18458
  "name": "UniqSubnetId",
18459
+ "output_required": true,
18432
18460
  "required": false,
18433
18461
  "type": "string",
18434
18462
  "value_allowed_null": true
@@ -18439,6 +18467,7 @@
18439
18467
  "example": "ap-beijing",
18440
18468
  "member": "string",
18441
18469
  "name": "RoGroupRegion",
18470
+ "output_required": true,
18442
18471
  "required": false,
18443
18472
  "type": "string",
18444
18473
  "value_allowed_null": true
@@ -18449,6 +18478,7 @@
18449
18478
  "example": "ap-beijing-3",
18450
18479
  "member": "string",
18451
18480
  "name": "RoGroupZone",
18481
+ "output_required": true,
18452
18482
  "required": false,
18453
18483
  "type": "string",
18454
18484
  "value_allowed_null": true
@@ -18459,6 +18489,7 @@
18459
18489
  "example": "1000",
18460
18490
  "member": "int64",
18461
18491
  "name": "DelayReplicationTime",
18492
+ "output_required": true,
18462
18493
  "required": false,
18463
18494
  "type": "int",
18464
18495
  "value_allowed_null": true
@@ -18560,7 +18591,7 @@
18560
18591
  {
18561
18592
  "disabled": false,
18562
18593
  "document": "RO实例在RO组内上一次下线的时间",
18563
- "example": "''",
18594
+ "example": "2024-09-09 16:40:30",
18564
18595
  "member": "string",
18565
18596
  "name": "OfflineTime",
18566
18597
  "output_required": true,
@@ -18637,7 +18668,7 @@
18637
18668
  {
18638
18669
  "disabled": false,
18639
18670
  "document": "RO实例名称",
18640
- "example": "''",
18671
+ "example": "cdbro-khe2c111",
18641
18672
  "member": "string",
18642
18673
  "name": "InstanceName",
18643
18674
  "output_required": true,
@@ -19806,7 +19837,7 @@
19806
19837
  {
19807
19838
  "disabled": false,
19808
19839
  "document": "实例 ID。仅支持只读实例。",
19809
- "example": "cdb-test",
19840
+ "example": "cdbro-lsjh9i11",
19810
19841
  "member": "string",
19811
19842
  "name": "InstanceId",
19812
19843
  "required": true,
@@ -19821,10 +19852,10 @@
19821
19852
  {
19822
19853
  "disabled": false,
19823
19854
  "document": "异步任务 ID。\n注意:此字段可能返回 null,表示取不到有效值。",
19824
- "example": "xx",
19855
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
19825
19856
  "member": "string",
19826
19857
  "name": "AsyncRequestId",
19827
- "required": true,
19858
+ "output_required": true,
19828
19859
  "type": "string",
19829
19860
  "value_allowed_null": true
19830
19861
  },
@@ -19843,7 +19874,7 @@
19843
19874
  {
19844
19875
  "disabled": false,
19845
19876
  "document": "实例 ID 。",
19846
- "example": "cdb-test",
19877
+ "example": "cdb-himitj11",
19847
19878
  "member": "string",
19848
19879
  "name": "InstanceId",
19849
19880
  "required": true,
@@ -19858,9 +19889,10 @@
19858
19889
  {
19859
19890
  "disabled": false,
19860
19891
  "document": "异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询",
19861
- "example": "xxxxxxx-xxxxxxxx",
19892
+ "example": "02e874af-e4876fb4-4c672e64-86f17866",
19862
19893
  "member": "string",
19863
19894
  "name": "AsyncRequestId",
19895
+ "output_required": true,
19864
19896
  "type": "string",
19865
19897
  "value_allowed_null": false
19866
19898
  },
@@ -19906,7 +19938,7 @@
19906
19938
  {
19907
19939
  "disabled": false,
19908
19940
  "document": "实例 ID。仅支持只读实例。",
19909
- "example": "cdb-test",
19941
+ "example": "cdb-himitj11",
19910
19942
  "member": "string",
19911
19943
  "name": "InstanceId",
19912
19944
  "required": true,
@@ -19921,10 +19953,10 @@
19921
19953
  {
19922
19954
  "disabled": false,
19923
19955
  "document": "异步任务 ID。\n注意:此字段可能返回 null,表示取不到有效值。",
19924
- "example": "xx",
19956
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
19925
19957
  "member": "string",
19926
19958
  "name": "AsyncRequestId",
19927
- "required": true,
19959
+ "output_required": true,
19928
19960
  "type": "string",
19929
19961
  "value_allowed_null": true
19930
19962
  },
@@ -19979,8 +20011,8 @@
19979
20011
  "members": [
19980
20012
  {
19981
20013
  "disabled": false,
19982
- "document": "实例D",
19983
- "example": "\"cdb-g3rbtabc\"",
20014
+ "document": "实例 ID。",
20015
+ "example": "cdb-g3rbtabc",
19984
20016
  "member": "string",
19985
20017
  "name": "InstanceId",
19986
20018
  "required": true,
@@ -19988,8 +20020,8 @@
19988
20020
  },
19989
20021
  {
19990
20022
  "disabled": false,
19991
- "document": "目标数据库版本",
19992
- "example": "\"8.0\"",
20023
+ "document": "目标数据库版本。",
20024
+ "example": "8.0",
19993
20025
  "member": "string",
19994
20026
  "name": "DstMysqlVersion",
19995
20027
  "required": true,
@@ -20003,8 +20035,8 @@
20003
20035
  "members": [
20004
20036
  {
20005
20037
  "disabled": false,
20006
- "document": "任务ID",
20007
- "example": "123",
20038
+ "document": "任务 ID",
20039
+ "example": "145",
20008
20040
  "member": "int64",
20009
20041
  "name": "JobId",
20010
20042
  "output_required": true,
@@ -20062,7 +20094,7 @@
20062
20094
  {
20063
20095
  "disabled": false,
20064
20096
  "document": "实例 ID。",
20065
- "example": "\"cdb-xxx\"",
20097
+ "example": "cdb-rqd2jndd",
20066
20098
  "member": "string",
20067
20099
  "name": "InstanceId",
20068
20100
  "required": true,
@@ -20071,7 +20103,7 @@
20071
20103
  {
20072
20104
  "disabled": false,
20073
20105
  "document": "目标从实例。可选值:\"first\" - 第一备机;\"second\" - 第二备机。默认值为 \"first\",仅多可用区实例支持设置为 \"second\"。",
20074
- "example": "\"first\"",
20106
+ "example": "first",
20075
20107
  "member": "string",
20076
20108
  "name": "DstSlave",
20077
20109
  "required": false,
@@ -20097,8 +20129,8 @@
20097
20129
  },
20098
20130
  {
20099
20131
  "disabled": false,
20100
- "document": "集群版实例指定节点id发起主从切换。",
20101
- "example": "dbn-xxx",
20132
+ "document": "集群版实例指定节点 ID 发起主从切换。",
20133
+ "example": "dbn-iql06r1s",
20102
20134
  "member": "string",
20103
20135
  "name": "DstNodeId",
20104
20136
  "required": false,
@@ -20113,7 +20145,7 @@
20113
20145
  {
20114
20146
  "disabled": false,
20115
20147
  "document": "异步任务 ID。",
20116
- "example": "\"\"",
20148
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
20117
20149
  "member": "string",
20118
20150
  "name": "AsyncRequestId",
20119
20151
  "output_required": true,
@@ -20134,8 +20166,8 @@
20134
20166
  "members": [
20135
20167
  {
20136
20168
  "disabled": false,
20137
- "document": "灾备实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同。",
20138
- "example": "cdb-***",
20169
+ "document": "灾备实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。",
20170
+ "example": "cdb-c1nl9rpv",
20139
20171
  "member": "string",
20140
20172
  "name": "InstanceId",
20141
20173
  "required": true,
@@ -20153,7 +20185,7 @@
20153
20185
  "example": "be9f64a6-fa652dc6-f5c878b6-a6a50746",
20154
20186
  "member": "string",
20155
20187
  "name": "AsyncRequestId",
20156
- "required": true,
20188
+ "output_required": true,
20157
20189
  "type": "string",
20158
20190
  "value_allowed_null": false
20159
20191
  },
@@ -20258,9 +20290,10 @@
20258
20290
  {
20259
20291
  "disabled": false,
20260
20292
  "document": "标签键",
20261
- "example": "",
20293
+ "example": "name",
20262
20294
  "member": "string",
20263
20295
  "name": "TagKey",
20296
+ "output_required": true,
20264
20297
  "required": true,
20265
20298
  "type": "string",
20266
20299
  "value_allowed_null": false
@@ -20268,9 +20301,10 @@
20268
20301
  {
20269
20302
  "disabled": false,
20270
20303
  "document": "标签值",
20271
- "example": "",
20304
+ "example": "[\"zhang\",\"li\"]",
20272
20305
  "member": "string",
20273
20306
  "name": "TagValue",
20307
+ "output_required": true,
20274
20308
  "required": true,
20275
20309
  "type": "list",
20276
20310
  "value_allowed_null": false