tccli 3.0.1238.1__py2.py3-none-any.whl → 3.0.1239.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 (58) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/cdb/v20170320/api.json +730 -649
  3. tccli/services/cdb/v20170320/examples.json +37 -37
  4. tccli/services/cdwdoris/v20211228/api.json +16 -7
  5. tccli/services/chdfs/v20201112/api.json +95 -78
  6. tccli/services/chdfs/v20201112/examples.json +14 -14
  7. tccli/services/clb/v20180317/api.json +2 -2
  8. tccli/services/cynosdb/v20190107/api.json +370 -365
  9. tccli/services/cynosdb/v20190107/examples.json +39 -39
  10. tccli/services/dbbrain/v20191016/api.json +206 -188
  11. tccli/services/dbbrain/v20191016/examples.json +10 -10
  12. tccli/services/dbbrain/v20210527/api.json +274 -267
  13. tccli/services/dbbrain/v20210527/examples.json +25 -25
  14. tccli/services/dc/v20180410/api.json +101 -41
  15. tccli/services/dc/v20180410/examples.json +5 -5
  16. tccli/services/dts/v20180330/api.json +9 -9
  17. tccli/services/dts/v20180330/examples.json +4 -4
  18. tccli/services/dts/v20211206/api.json +28 -28
  19. tccli/services/dts/v20211206/examples.json +4 -4
  20. tccli/services/eb/v20210416/api.json +2 -2
  21. tccli/services/eb/v20210416/examples.json +2 -2
  22. tccli/services/ecm/v20190719/api.json +267 -224
  23. tccli/services/ecm/v20190719/examples.json +21 -21
  24. tccli/services/ess/v20201111/api.json +21 -3
  25. tccli/services/essbasic/v20210526/api.json +18 -0
  26. tccli/services/facefusion/v20220927/api.json +2 -2
  27. tccli/services/gaap/v20180529/api.json +22 -22
  28. tccli/services/hunyuan/v20230901/api.json +21 -2
  29. tccli/services/lcic/v20220817/api.json +1 -1
  30. tccli/services/lighthouse/v20200324/api.json +4 -4
  31. tccli/services/live/v20180801/api.json +60 -60
  32. tccli/services/live/v20180801/examples.json +37 -37
  33. tccli/services/mongodb/v20180408/api.json +104 -104
  34. tccli/services/mongodb/v20190725/api.json +116 -103
  35. tccli/services/ocr/v20181119/api.json +2 -2
  36. tccli/services/ocr/v20181119/examples.json +1 -1
  37. tccli/services/redis/v20180412/api.json +1 -1
  38. tccli/services/sqlserver/v20180328/api.json +611 -450
  39. tccli/services/sqlserver/v20180328/examples.json +16 -16
  40. tccli/services/tbaas/v20180416/api.json +47 -49
  41. tccli/services/tbaas/v20180416/examples.json +4 -4
  42. tccli/services/tdmq/tdmq_client.py +53 -0
  43. tccli/services/tdmq/v20200217/api.json +61 -0
  44. tccli/services/tdmq/v20200217/examples.json +8 -0
  45. tccli/services/trocket/trocket_client.py +171 -12
  46. tccli/services/trocket/v20230308/api.json +524 -0
  47. tccli/services/trocket/v20230308/examples.json +24 -0
  48. tccli/services/tsf/v20180326/api.json +39 -37
  49. tccli/services/tsf/v20180326/examples.json +16 -16
  50. tccli/services/vod/v20180717/api.json +21 -3
  51. tccli/services/vod/v20180717/examples.json +2 -2
  52. tccli/services/vpc/v20170312/api.json +3 -3
  53. tccli/services/vpc/v20170312/examples.json +4 -4
  54. {tccli-3.0.1238.1.dist-info → tccli-3.0.1239.1.dist-info}/METADATA +2 -2
  55. {tccli-3.0.1238.1.dist-info → tccli-3.0.1239.1.dist-info}/RECORD +58 -58
  56. {tccli-3.0.1238.1.dist-info → tccli-3.0.1239.1.dist-info}/WHEEL +0 -0
  57. {tccli-3.0.1238.1.dist-info → tccli-3.0.1239.1.dist-info}/entry_points.txt +0 -0
  58. {tccli-3.0.1238.1.dist-info → tccli-3.0.1239.1.dist-info}/license_files/LICENSE +0 -0
@@ -22,7 +22,7 @@
22
22
  "status": "online"
23
23
  },
24
24
  "AnalyzeAuditLogs": {
25
- "document": "在不同过滤条件下的审计日志结果集中,选定特定的数据列进行聚合统计。",
25
+ "document": "本接口(AnalyzeAuditLogs)用于在不同过滤条件下的审计日志结果集中,选定特定的数据列进行聚合统计。",
26
26
  "input": "AnalyzeAuditLogsRequest",
27
27
  "name": "分析审计日志",
28
28
  "output": "AnalyzeAuditLogsResponse",
@@ -113,14 +113,14 @@
113
113
  "status": "deprecated"
114
114
  },
115
115
  "CreateAuditRuleTemplate": {
116
- "document": "创建审计规则模板",
116
+ "document": "本接口(CreateAuditRuleTemplate)用于创建审计规则模板。",
117
117
  "input": "CreateAuditRuleTemplateRequest",
118
118
  "name": "创建审计规则模板",
119
119
  "output": "CreateAuditRuleTemplateResponse",
120
120
  "status": "online"
121
121
  },
122
122
  "CreateBackup": {
123
- "document": "本接口(CreateBackup)用于创建数据库备份。",
123
+ "document": "本接口(CreateBackup)用于创建数据库备份。",
124
124
  "input": "CreateBackupRequest",
125
125
  "name": "创建云数据库备份",
126
126
  "output": "CreateBackupResponse",
@@ -134,21 +134,21 @@
134
134
  "status": "online"
135
135
  },
136
136
  "CreateCdbProxyAddress": {
137
- "document": "数据库代理增加代理地址",
137
+ "document": "本接口(CreateCdbProxyAddress)用于数据库代理增加代理地址。",
138
138
  "input": "CreateCdbProxyAddressRequest",
139
139
  "name": "创建数据库代理地址",
140
140
  "output": "CreateCdbProxyAddressResponse",
141
141
  "status": "online"
142
142
  },
143
143
  "CreateCloneInstance": {
144
- "document": "本接口(CreateCloneInstance) 用于从目标源实例创建一个克隆实例,可以指定克隆实例回档到源实例的指定物理备份文件或者指定的回档时间点。",
144
+ "document": "本接口(CreateCloneInstance)用于从目标源实例创建一个克隆实例,可以指定克隆实例回档到源实例的指定物理备份文件或者指定的回档时间点。",
145
145
  "input": "CreateCloneInstanceRequest",
146
146
  "name": "创建克隆实例",
147
147
  "output": "CreateCloneInstanceResponse",
148
148
  "status": "online"
149
149
  },
150
150
  "CreateDBImportJob": {
151
- "document": "本接口(CreateDBImportJob)用于创建云数据库数据导入任务。\n\n注意,用户进行数据导入任务的文件,必须提前上传到腾讯云。用户须在控制台进行文件导入。",
151
+ "document": "本接口(CreateDBImportJob)用于创建云数据库数据导入任务。\n注意,用户进行数据导入任务的文件,必须提前上传到腾讯云。用户须在控制台进行文件导入。",
152
152
  "input": "CreateDBImportJobRequest",
153
153
  "name": "创建数据导入任务",
154
154
  "output": "CreateDBImportJobResponse",
@@ -183,7 +183,7 @@
183
183
  "status": "online"
184
184
  },
185
185
  "CreateParamTemplate": {
186
- "document": "该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数Region均为ap-guangzhou。",
186
+ "document": "该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数 Region 均为 ap-guangzhou。",
187
187
  "input": "CreateParamTemplateRequest",
188
188
  "name": "创建参数模板",
189
189
  "output": "CreateParamTemplateResponse",
@@ -197,14 +197,14 @@
197
197
  "status": "online"
198
198
  },
199
199
  "CreateRotationPassword": {
200
- "document": "开启密码轮转",
200
+ "document": "本接口(CreateRotationPassword)用于开启密码轮转。",
201
201
  "input": "CreateRotationPasswordRequest",
202
202
  "name": "开启密码轮转",
203
203
  "output": "CreateRotationPasswordResponse",
204
204
  "status": "online"
205
205
  },
206
206
  "DeleteAccounts": {
207
- "document": "本接口(DeleteAccounts)用于删除云数据库的账户。",
207
+ "document": "本接口(DeleteAccounts)用于删除云数据库的账户。",
208
208
  "input": "DeleteAccountsRequest",
209
209
  "name": "删除云数据库的账号",
210
210
  "output": "DeleteAccountsResponse",
@@ -260,14 +260,14 @@
260
260
  "status": "online"
261
261
  },
262
262
  "DeleteParamTemplate": {
263
- "document": "该接口(DeleteParamTemplate)用于删除参数模板,全地域公共参数Region均为ap-guangzhou。",
263
+ "document": "该接口(DeleteParamTemplate)用于删除参数模板,全地域公共参数 Region 均为 ap-guangzhou。",
264
264
  "input": "DeleteParamTemplateRequest",
265
265
  "name": "删除参数模板",
266
266
  "output": "DeleteParamTemplateResponse",
267
267
  "status": "online"
268
268
  },
269
269
  "DeleteRotationPassword": {
270
- "document": "关闭实例账户密码轮转",
270
+ "document": "本接口(DeleteRotationPassword)用于关闭实例账户密码轮转。",
271
271
  "input": "DeleteRotationPasswordRequest",
272
272
  "name": "关闭密码轮转",
273
273
  "output": "DeleteRotationPasswordResponse",
@@ -288,7 +288,7 @@
288
288
  "status": "online"
289
289
  },
290
290
  "DescribeAccounts": {
291
- "document": "本接口(DescribeAccounts)用于查询云数据库的所有账户信息。",
291
+ "document": "本接口(DescribeAccounts)用于查询云数据库的所有账户信息。",
292
292
  "input": "DescribeAccountsRequest",
293
293
  "name": "查询云数据库的所有账号信息",
294
294
  "output": "DescribeAccountsResponse",
@@ -309,14 +309,14 @@
309
309
  "status": "online"
310
310
  },
311
311
  "DescribeAuditInstanceList": {
312
- "document": "获取审计实例列表",
312
+ "document": "本接口(DescribeAuditInstanceList)用于获取审计实例列表。",
313
313
  "input": "DescribeAuditInstanceListRequest",
314
314
  "name": "获取审计实例列表",
315
315
  "output": "DescribeAuditInstanceListResponse",
316
316
  "status": "online"
317
317
  },
318
318
  "DescribeAuditLogFiles": {
319
- "document": "本接口(DescribeAuditLogFiles)用于查询云数据库实例的审计日志文件。",
319
+ "document": "本接口(DescribeAuditLogFiles)用于查询云数据库实例的审计日志文件。",
320
320
  "input": "DescribeAuditLogFilesRequest",
321
321
  "name": "查询审计日志文件",
322
322
  "output": "DescribeAuditLogFilesResponse",
@@ -330,21 +330,21 @@
330
330
  "status": "online"
331
331
  },
332
332
  "DescribeAuditPolicies": {
333
- "document": "本接口(DescribeAuditPolicies)用于查询云数据库实例的审计策略。",
333
+ "document": "本接口(DescribeAuditPolicies)用于查询云数据库实例的审计策略。",
334
334
  "input": "DescribeAuditPoliciesRequest",
335
335
  "name": "查询审计策略",
336
336
  "output": "DescribeAuditPoliciesResponse",
337
337
  "status": "online"
338
338
  },
339
339
  "DescribeAuditRuleTemplateModifyHistory": {
340
- "document": "查询规则模板变更记录",
340
+ "document": "本接口(DescribeAuditRuleTemplateModifyHistory)用于查询规则模板变更记录。",
341
341
  "input": "DescribeAuditRuleTemplateModifyHistoryRequest",
342
342
  "name": "查询规则模板变更记录",
343
343
  "output": "DescribeAuditRuleTemplateModifyHistoryResponse",
344
344
  "status": "online"
345
345
  },
346
346
  "DescribeAuditRuleTemplates": {
347
- "document": "查询审计规则模板信息",
347
+ "document": "本接口(DescribeAuditRuleTemplates)用于查询审计规则模板信息。",
348
348
  "input": "DescribeAuditRuleTemplatesRequest",
349
349
  "name": "查询审计规则模板",
350
350
  "output": "DescribeAuditRuleTemplatesResponse",
@@ -365,7 +365,7 @@
365
365
  "status": "online"
366
366
  },
367
367
  "DescribeBackupDecryptionKey": {
368
- "document": "本接口(DescribeBackupDecryptionKey)用于查询备份文件解密密钥。",
368
+ "document": "本接口(DescribeBackupDecryptionKey)用于查询备份文件解密密钥。",
369
369
  "input": "DescribeBackupDecryptionKeyRequest",
370
370
  "name": "查询备份文件解密密钥",
371
371
  "output": "DescribeBackupDecryptionKeyResponse",
@@ -421,7 +421,7 @@
421
421
  "status": "online"
422
422
  },
423
423
  "DescribeCdbProxyInfo": {
424
- "document": "查询数据库代理详情信息",
424
+ "document": "本接口(DescribeCdbProxyInfo)用于查询数据库代理详情信息。",
425
425
  "input": "DescribeCdbProxyInfoRequest",
426
426
  "name": "查询数据库代理详情",
427
427
  "output": "DescribeCdbProxyInfoResponse",
@@ -435,7 +435,7 @@
435
435
  "status": "online"
436
436
  },
437
437
  "DescribeCloneList": {
438
- "document": "本接口(DescribeCloneList) 用于查询用户实例的克隆任务列表。",
438
+ "document": "本接口(DescribeCloneList)用于查询用户实例的克隆任务列表。",
439
439
  "input": "DescribeCloneListRequest",
440
440
  "name": "查询克隆任务列表",
441
441
  "output": "DescribeCloneListResponse",
@@ -701,7 +701,7 @@
701
701
  "status": "online"
702
702
  },
703
703
  "DescribeSlowLogData": {
704
- "document": "条件检索实例的慢日志。只允许查看一个月之内的慢日志。\n使用时需要注意:可能存在单条慢日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。",
704
+ "document": "本接口(DescribeSlowLogData)用于使用条件检索实例的慢日志。只允许查看一个月之内的慢日志。\n使用时需要注意:可能存在单条慢日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。",
705
705
  "input": "DescribeSlowLogDataRequest",
706
706
  "name": "查询实例慢日志",
707
707
  "output": "DescribeSlowLogDataResponse",
@@ -939,7 +939,7 @@
939
939
  "status": "online"
940
940
  },
941
941
  "ModifyInstancePasswordComplexity": {
942
- "document": "本接口(ModifyInstancePasswordComplexity)用于修改云数据库实例的密码复杂度。",
942
+ "document": "本接口(ModifyInstancePasswordComplexity)用于修改云数据库实例的密码复杂度。",
943
943
  "input": "ModifyInstancePasswordComplexityRequest",
944
944
  "name": "修改实例密码复杂度",
945
945
  "output": "ModifyInstancePasswordComplexityResponse",
@@ -1242,7 +1242,7 @@
1242
1242
  "example": "your note",
1243
1243
  "member": "string",
1244
1244
  "name": "Notes",
1245
- "required": true,
1245
+ "output_required": true,
1246
1246
  "type": "string",
1247
1247
  "value_allowed_null": false
1248
1248
  },
@@ -1252,7 +1252,7 @@
1252
1252
  "example": "%",
1253
1253
  "member": "string",
1254
1254
  "name": "Host",
1255
- "required": true,
1255
+ "output_required": true,
1256
1256
  "type": "string",
1257
1257
  "value_allowed_null": false
1258
1258
  },
@@ -1262,7 +1262,7 @@
1262
1262
  "example": "root",
1263
1263
  "member": "string",
1264
1264
  "name": "User",
1265
- "required": true,
1265
+ "output_required": true,
1266
1266
  "type": "string",
1267
1267
  "value_allowed_null": false
1268
1268
  },
@@ -1272,7 +1272,7 @@
1272
1272
  "example": "2020-09-09 16:40:30",
1273
1273
  "member": "datetime",
1274
1274
  "name": "ModifyTime",
1275
- "required": true,
1275
+ "output_required": true,
1276
1276
  "type": "string",
1277
1277
  "value_allowed_null": false
1278
1278
  },
@@ -1282,17 +1282,17 @@
1282
1282
  "example": "2020-09-09 16:40:30",
1283
1283
  "member": "datetime",
1284
1284
  "name": "ModifyPasswordTime",
1285
- "required": true,
1285
+ "output_required": true,
1286
1286
  "type": "string",
1287
1287
  "value_allowed_null": false
1288
1288
  },
1289
1289
  {
1290
1290
  "disabled": false,
1291
1291
  "document": "该值已废弃",
1292
- "example": "''",
1292
+ "example": "2021-09-09 16:40:30",
1293
1293
  "member": "datetime",
1294
1294
  "name": "CreateTime",
1295
- "required": true,
1295
+ "output_required": true,
1296
1296
  "type": "string",
1297
1297
  "value_allowed_null": false
1298
1298
  },
@@ -1302,9 +1302,19 @@
1302
1302
  "example": "10240",
1303
1303
  "member": "int64",
1304
1304
  "name": "MaxUserConnections",
1305
- "required": true,
1305
+ "output_required": true,
1306
1306
  "type": "int",
1307
1307
  "value_allowed_null": false
1308
+ },
1309
+ {
1310
+ "disabled": false,
1311
+ "document": "用户账号是否开启了密码轮转",
1312
+ "example": "true",
1313
+ "member": "bool",
1314
+ "name": "OpenCam",
1315
+ "output_required": true,
1316
+ "type": "bool",
1317
+ "value_allowed_null": false
1308
1318
  }
1309
1319
  ],
1310
1320
  "usage": "out"
@@ -1721,28 +1731,25 @@
1721
1731
  "member": "string",
1722
1732
  "name": "AggregationField",
1723
1733
  "required": true,
1724
- "type": "string",
1725
- "value_allowed_null": false
1734
+ "type": "string"
1726
1735
  },
1727
1736
  {
1728
1737
  "disabled": false,
1729
1738
  "document": "偏移量。",
1730
- "example": "",
1739
+ "example": "0",
1731
1740
  "member": "uint64",
1732
1741
  "name": "Offset",
1733
1742
  "required": false,
1734
- "type": "int",
1735
- "value_allowed_null": true
1743
+ "type": "int"
1736
1744
  },
1737
1745
  {
1738
1746
  "disabled": false,
1739
1747
  "document": "该聚合字段下要返回聚合桶的数量,最大100。",
1740
- "example": "",
1748
+ "example": "100",
1741
1749
  "member": "uint64",
1742
1750
  "name": "Limit",
1743
1751
  "required": false,
1744
- "type": "int",
1745
- "value_allowed_null": true
1752
+ "type": "int"
1746
1753
  }
1747
1754
  ],
1748
1755
  "usage": "in"
@@ -1780,7 +1787,7 @@
1780
1787
  {
1781
1788
  "disabled": false,
1782
1789
  "document": "聚合维度的排序条件。",
1783
- "example": "",
1790
+ "example": "[{\"AggregationField\": \"host\",\"Offset\": 0,\"Limit\": 3}]",
1784
1791
  "member": "AggregationCondition",
1785
1792
  "name": "AggregationConditions",
1786
1793
  "required": true,
@@ -1789,7 +1796,7 @@
1789
1796
  {
1790
1797
  "disabled": false,
1791
1798
  "document": "已废弃。该过滤条件下的审计日志结果集作为分析日志。",
1792
- "example": "",
1799
+ "example": "{\"SqlTypes\": [\"CREATE\"]}",
1793
1800
  "member": "AuditLogFilter",
1794
1801
  "name": "AuditLogFilter",
1795
1802
  "required": false,
@@ -1798,7 +1805,7 @@
1798
1805
  {
1799
1806
  "disabled": false,
1800
1807
  "document": "该过滤条件下的审计日志结果集作为分析日志。",
1801
- "example": "",
1808
+ "example": "{\"SqlTypes\": [\"SELECT\"]}",
1802
1809
  "member": "InstanceAuditLogFilters",
1803
1810
  "name": "LogFilter",
1804
1811
  "required": false,
@@ -1813,7 +1820,7 @@
1813
1820
  {
1814
1821
  "disabled": false,
1815
1822
  "document": "返回的聚合桶信息集\n注意:此字段可能返回 null,表示取不到有效值。",
1816
- "example": "",
1823
+ "example": "[{\"AggregationField\": \"host\",\"Buckets\": [{\"Count\": 3,\"Key\": \"100.122.76.176\"},{\"Count\": 2,\"Key\": \"9.71.156.179\"}]}]",
1817
1824
  "member": "AuditLogAggregationResult",
1818
1825
  "name": "Items",
1819
1826
  "output_required": true,
@@ -1823,7 +1830,7 @@
1823
1830
  {
1824
1831
  "disabled": false,
1825
1832
  "document": "扫描的日志条数\n注意:此字段可能返回 null,表示取不到有效值。",
1826
- "example": "",
1833
+ "example": "100",
1827
1834
  "member": "int64",
1828
1835
  "name": "TotalCount",
1829
1836
  "output_required": true,
@@ -1890,9 +1897,10 @@
1890
1897
  {
1891
1898
  "disabled": false,
1892
1899
  "document": "过滤条件参数名称。目前支持:\nSrcIp – 客户端 IP;\nUser – 数据库账户;\nDB – 数据库名称;",
1893
- "example": "",
1900
+ "example": "User",
1894
1901
  "member": "string",
1895
1902
  "name": "Type",
1903
+ "output_required": true,
1896
1904
  "required": true,
1897
1905
  "type": "string",
1898
1906
  "value_allowed_null": false
@@ -1900,9 +1908,10 @@
1900
1908
  {
1901
1909
  "disabled": false,
1902
1910
  "document": "过滤条件匹配类型。目前支持:\nINC – 包含;\nEXC – 不包含;\nEQ – 等于;\nNEQ – 不等于;",
1903
- "example": "",
1911
+ "example": "INC",
1904
1912
  "member": "string",
1905
1913
  "name": "Compare",
1914
+ "output_required": true,
1906
1915
  "required": true,
1907
1916
  "type": "string",
1908
1917
  "value_allowed_null": false
@@ -1910,9 +1919,10 @@
1910
1919
  {
1911
1920
  "disabled": false,
1912
1921
  "document": "过滤条件匹配值。",
1913
- "example": "",
1922
+ "example": "andy",
1914
1923
  "member": "string",
1915
1924
  "name": "Value",
1925
+ "output_required": true,
1916
1926
  "required": true,
1917
1927
  "type": "string",
1918
1928
  "value_allowed_null": false
@@ -1965,17 +1975,17 @@
1965
1975
  "example": "23414",
1966
1976
  "member": "int64",
1967
1977
  "name": "ProjectId",
1968
- "required": false,
1978
+ "output_required": true,
1969
1979
  "type": "int",
1970
1980
  "value_allowed_null": true
1971
1981
  },
1972
1982
  {
1973
1983
  "disabled": false,
1974
1984
  "document": "标签信息\n注意:此字段可能返回 null,表示取不到有效值。",
1975
- "example": "",
1985
+ "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]",
1976
1986
  "member": "TagInfoUnit",
1977
1987
  "name": "TagList",
1978
- "required": false,
1988
+ "output_required": true,
1979
1989
  "type": "list",
1980
1990
  "value_allowed_null": true
1981
1991
  },
@@ -1985,7 +1995,7 @@
1985
1995
  "example": "MYSQL",
1986
1996
  "member": "string",
1987
1997
  "name": "DbType",
1988
- "required": false,
1998
+ "output_required": true,
1989
1999
  "type": "string",
1990
2000
  "value_allowed_null": true
1991
2001
  },
@@ -1995,7 +2005,7 @@
1995
2005
  "example": "5.7",
1996
2006
  "member": "string",
1997
2007
  "name": "DbVersion",
1998
- "required": false,
2008
+ "output_required": true,
1999
2009
  "type": "string",
2000
2010
  "value_allowed_null": true
2001
2011
  }
@@ -2217,17 +2227,17 @@
2217
2227
  "example": "host",
2218
2228
  "member": "string",
2219
2229
  "name": "AggregationField",
2220
- "required": true,
2230
+ "output_required": true,
2221
2231
  "type": "string",
2222
2232
  "value_allowed_null": true
2223
2233
  },
2224
2234
  {
2225
2235
  "disabled": false,
2226
2236
  "document": "聚合桶的结果集\n注意:此字段可能返回 null,表示取不到有效值。",
2227
- "example": "",
2237
+ "example": "[{\"Key\": \"10.0.0.8\",\"Count\": \"10\"}]",
2228
2238
  "member": "Bucket",
2229
2239
  "name": "Buckets",
2230
- "required": true,
2240
+ "output_required": true,
2231
2241
  "type": "list",
2232
2242
  "value_allowed_null": true
2233
2243
  }
@@ -2240,60 +2250,60 @@
2240
2250
  {
2241
2251
  "disabled": false,
2242
2252
  "document": "审计日志文件名称",
2243
- "example": "",
2253
+ "example": "1308***106_cdb-3gj***th_1730***660_373***68.csv",
2244
2254
  "member": "string",
2245
2255
  "name": "FileName",
2246
- "required": true,
2256
+ "output_required": true,
2247
2257
  "type": "string",
2248
2258
  "value_allowed_null": false
2249
2259
  },
2250
2260
  {
2251
2261
  "disabled": false,
2252
2262
  "document": "审计日志文件创建时间。格式为 : \"2019-03-20 17:09:13\"。",
2253
- "example": "",
2263
+ "example": "2024-03-20 17:09:13",
2254
2264
  "member": "string",
2255
2265
  "name": "CreateTime",
2256
- "required": true,
2266
+ "output_required": true,
2257
2267
  "type": "string",
2258
2268
  "value_allowed_null": false
2259
2269
  },
2260
2270
  {
2261
2271
  "disabled": false,
2262
2272
  "document": "文件状态值。可能返回的值为:\n\"creating\" - 生成中;\n\"failed\" - 创建失败;\n\"success\" - 已生成;",
2263
- "example": "",
2273
+ "example": "success",
2264
2274
  "member": "string",
2265
2275
  "name": "Status",
2266
- "required": true,
2276
+ "output_required": true,
2267
2277
  "type": "string",
2268
2278
  "value_allowed_null": false
2269
2279
  },
2270
2280
  {
2271
2281
  "disabled": false,
2272
2282
  "document": "文件大小,单位为 KB。\n注意:此字段可能返回 null,表示取不到有效值。",
2273
- "example": "",
2283
+ "example": "1",
2274
2284
  "member": "int64",
2275
2285
  "name": "FileSize",
2276
- "required": true,
2286
+ "output_required": true,
2277
2287
  "type": "int",
2278
2288
  "value_allowed_null": true
2279
2289
  },
2280
2290
  {
2281
2291
  "disabled": false,
2282
2292
  "document": "审计日志下载地址。\n注意:此字段可能返回 null,表示取不到有效值。",
2283
- "example": "",
2293
+ "example": "https://gz-audit-125****829.cos.ap-guangzhou.myqcloud.com/130****106_cdb-3g****ath_1730****60_37****68.csv?q-sign-algorithm=sh***",
2284
2294
  "member": "string",
2285
2295
  "name": "DownloadUrl",
2286
- "required": true,
2296
+ "output_required": true,
2287
2297
  "type": "string",
2288
2298
  "value_allowed_null": true
2289
2299
  },
2290
2300
  {
2291
2301
  "disabled": false,
2292
2302
  "document": "错误信息。\n注意:此字段可能返回 null,表示取不到有效值。",
2293
- "example": "",
2303
+ "example": "",
2294
2304
  "member": "string",
2295
2305
  "name": "ErrMsg",
2296
- "required": true,
2306
+ "output_required": true,
2297
2307
  "type": "string",
2298
2308
  "value_allowed_null": true
2299
2309
  }
@@ -2495,7 +2505,7 @@
2495
2505
  "example": "cdbpolicy-g78s8xn6",
2496
2506
  "member": "string",
2497
2507
  "name": "PolicyId",
2498
- "required": true,
2508
+ "output_required": true,
2499
2509
  "type": "string",
2500
2510
  "value_allowed_null": false
2501
2511
  },
@@ -2505,7 +2515,7 @@
2505
2515
  "example": "running",
2506
2516
  "member": "string",
2507
2517
  "name": "Status",
2508
- "required": true,
2518
+ "output_required": true,
2509
2519
  "type": "string",
2510
2520
  "value_allowed_null": false
2511
2521
  },
@@ -2515,7 +2525,7 @@
2515
2525
  "example": "cdb-pr1rb3j9",
2516
2526
  "member": "string",
2517
2527
  "name": "InstanceId",
2518
- "required": true,
2528
+ "output_required": true,
2519
2529
  "type": "string",
2520
2530
  "value_allowed_null": false
2521
2531
  },
@@ -2525,7 +2535,7 @@
2525
2535
  "example": "2021-02-15 15:24:22",
2526
2536
  "member": "string",
2527
2537
  "name": "CreateTime",
2528
- "required": true,
2538
+ "output_required": true,
2529
2539
  "type": "string",
2530
2540
  "value_allowed_null": false
2531
2541
  },
@@ -2535,7 +2545,7 @@
2535
2545
  "example": "2022-01-15 15:24:22",
2536
2546
  "member": "string",
2537
2547
  "name": "ModifyTime",
2538
- "required": true,
2548
+ "output_required": true,
2539
2549
  "type": "string",
2540
2550
  "value_allowed_null": false
2541
2551
  },
@@ -2545,7 +2555,7 @@
2545
2555
  "example": "fullaudit",
2546
2556
  "member": "string",
2547
2557
  "name": "PolicyName",
2548
- "required": true,
2558
+ "output_required": true,
2549
2559
  "type": "string",
2550
2560
  "value_allowed_null": false
2551
2561
  },
@@ -2555,7 +2565,7 @@
2555
2565
  "example": "cdbrule-11o5fvz2",
2556
2566
  "member": "string",
2557
2567
  "name": "RuleId",
2558
- "required": true,
2568
+ "output_required": true,
2559
2569
  "type": "string",
2560
2570
  "value_allowed_null": false
2561
2571
  },
@@ -2565,17 +2575,17 @@
2565
2575
  "example": "allrule",
2566
2576
  "member": "string",
2567
2577
  "name": "RuleName",
2568
- "required": true,
2578
+ "output_required": true,
2569
2579
  "type": "string",
2570
2580
  "value_allowed_null": true
2571
2581
  },
2572
2582
  {
2573
2583
  "disabled": false,
2574
2584
  "document": "数据库实例名称\n注意:此字段可能返回 null,表示取不到有效值。",
2575
- "example": "test",
2585
+ "example": "cdb463333",
2576
2586
  "member": "string",
2577
2587
  "name": "InstanceName",
2578
- "required": true,
2588
+ "output_required": true,
2579
2589
  "type": "string",
2580
2590
  "value_allowed_null": true
2581
2591
  }
@@ -2588,70 +2598,70 @@
2588
2598
  {
2589
2599
  "disabled": false,
2590
2600
  "document": "审计规则 Id。",
2591
- "example": "",
2601
+ "example": "172",
2592
2602
  "member": "string",
2593
2603
  "name": "RuleId",
2594
- "required": true,
2604
+ "output_required": true,
2595
2605
  "type": "string",
2596
2606
  "value_allowed_null": false
2597
2607
  },
2598
2608
  {
2599
2609
  "disabled": false,
2600
2610
  "document": "审计规则创建时间。格式为 : \"2019-03-20 17:09:13\"。",
2601
- "example": "",
2611
+ "example": "2022-06-21 16:19:35",
2602
2612
  "member": "string",
2603
2613
  "name": "CreateTime",
2604
- "required": true,
2614
+ "output_required": true,
2605
2615
  "type": "string",
2606
2616
  "value_allowed_null": false
2607
2617
  },
2608
2618
  {
2609
2619
  "disabled": false,
2610
2620
  "document": "审计规则最后修改时间。格式为 : \"2019-03-20 17:09:13\"。",
2611
- "example": "",
2621
+ "example": "2022-09-05 11:40:07",
2612
2622
  "member": "string",
2613
2623
  "name": "ModifyTime",
2614
- "required": true,
2624
+ "output_required": true,
2615
2625
  "type": "string",
2616
2626
  "value_allowed_null": false
2617
2627
  },
2618
2628
  {
2619
2629
  "disabled": false,
2620
2630
  "document": "审计规则名称。\n注意:此字段可能返回 null,表示取不到有效值。",
2621
- "example": "",
2631
+ "example": "Default",
2622
2632
  "member": "string",
2623
2633
  "name": "RuleName",
2624
- "required": true,
2634
+ "output_required": true,
2625
2635
  "type": "string",
2626
2636
  "value_allowed_null": true
2627
2637
  },
2628
2638
  {
2629
2639
  "disabled": false,
2630
2640
  "document": "审计规则描述。\n注意:此字段可能返回 null,表示取不到有效值。",
2631
- "example": "",
2641
+ "example": "Default",
2632
2642
  "member": "string",
2633
2643
  "name": "Description",
2634
- "required": true,
2644
+ "output_required": true,
2635
2645
  "type": "string",
2636
2646
  "value_allowed_null": true
2637
2647
  },
2638
2648
  {
2639
2649
  "disabled": false,
2640
2650
  "document": "审计规则过滤条件。\n注意:此字段可能返回 null,表示取不到有效值。",
2641
- "example": "",
2651
+ "example": "[{\"Type\": \"User\",\"Compare\": \"\tINC\",\"Value\": \"andy\"}]",
2642
2652
  "member": "AuditFilter",
2643
2653
  "name": "RuleFilters",
2644
- "required": true,
2654
+ "output_required": true,
2645
2655
  "type": "list",
2646
2656
  "value_allowed_null": true
2647
2657
  },
2648
2658
  {
2649
2659
  "disabled": false,
2650
2660
  "document": "是否开启全审计。",
2651
- "example": "",
2661
+ "example": "true",
2652
2662
  "member": "bool",
2653
2663
  "name": "AuditAll",
2654
- "required": true,
2664
+ "output_required": true,
2655
2665
  "type": "bool",
2656
2666
  "value_allowed_null": false
2657
2667
  }
@@ -2691,7 +2701,7 @@
2691
2701
  {
2692
2702
  "disabled": false,
2693
2703
  "document": "规则模板名称。",
2694
- "example": "",
2704
+ "example": "andy",
2695
2705
  "member": "string",
2696
2706
  "name": "RuleTemplateName",
2697
2707
  "output_required": true,
@@ -2701,7 +2711,7 @@
2701
2711
  {
2702
2712
  "disabled": false,
2703
2713
  "document": "规则模板的过滤条件。",
2704
- "example": "",
2714
+ "example": "[{\"Type\": \"sqlType\",\"INC\": \"employees\",\"Value\": [\"employees\"]}]",
2705
2715
  "member": "RuleFilters",
2706
2716
  "name": "RuleFilters",
2707
2717
  "output_required": true,
@@ -2711,7 +2721,7 @@
2711
2721
  {
2712
2722
  "disabled": false,
2713
2723
  "document": "规则模板描述。\n注意:此字段可能返回 null,表示取不到有效值。",
2714
- "example": "",
2724
+ "example": "dd_yif",
2715
2725
  "member": "string",
2716
2726
  "name": "Description",
2717
2727
  "output_required": true,
@@ -2730,53 +2740,53 @@
2730
2740
  },
2731
2741
  {
2732
2742
  "disabled": false,
2733
- "document": "告警等级。1-低风险,2-中风险,3-高风险。\n注意:此字段可能返回 null,表示取不到有效值。",
2743
+ "document": "告警等级。1-低风险,2-中风险,3-高风险。",
2734
2744
  "example": "3",
2735
2745
  "member": "uint64",
2736
2746
  "name": "AlarmLevel",
2737
2747
  "output_required": false,
2738
2748
  "type": "int",
2739
- "value_allowed_null": true
2749
+ "value_allowed_null": false
2740
2750
  },
2741
2751
  {
2742
2752
  "disabled": false,
2743
- "document": "告警策略。0-不告警,1-告警。\n注意:此字段可能返回 null,表示取不到有效值。",
2753
+ "document": "告警策略。0-不告警,1-告警。",
2744
2754
  "example": "1",
2745
2755
  "member": "uint64",
2746
2756
  "name": "AlarmPolicy",
2747
2757
  "output_required": false,
2748
2758
  "type": "int",
2749
- "value_allowed_null": true
2759
+ "value_allowed_null": false
2750
2760
  },
2751
2761
  {
2752
2762
  "disabled": false,
2753
- "document": "规则模板应用在哪些在实例。\n注意:此字段可能返回 null,表示取不到有效值。",
2754
- "example": "",
2763
+ "document": "规则模板应用在哪些在实例。",
2764
+ "example": "[\"cdb-gbpmgksv\",\"cdb-geyhwksv\"]",
2755
2765
  "member": "string",
2756
2766
  "name": "AffectedInstances",
2757
2767
  "output_required": false,
2758
2768
  "type": "list",
2759
- "value_allowed_null": true
2769
+ "value_allowed_null": false
2760
2770
  },
2761
2771
  {
2762
2772
  "disabled": false,
2763
- "document": "模板状态。0-无任务 ,1-修改中。\n注意:此字段可能返回 null,表示取不到有效值。",
2764
- "example": "",
2773
+ "document": "模板状态。0-无任务 ,1-修改中。",
2774
+ "example": "0",
2765
2775
  "member": "uint64",
2766
2776
  "name": "Status",
2767
2777
  "output_required": false,
2768
2778
  "type": "int",
2769
- "value_allowed_null": true
2779
+ "value_allowed_null": false
2770
2780
  },
2771
2781
  {
2772
2782
  "disabled": false,
2773
- "document": "模板更新时间。\n注意:此字段可能返回 null,表示取不到有效值。",
2774
- "example": "",
2783
+ "document": "模板更新时间。",
2784
+ "example": "2023-11-08 15:34:57",
2775
2785
  "member": "string",
2776
2786
  "name": "UpdateAt",
2777
2787
  "output_required": false,
2778
2788
  "type": "string",
2779
- "value_allowed_null": true
2789
+ "value_allowed_null": false
2780
2790
  }
2781
2791
  ],
2782
2792
  "usage": "out"
@@ -2829,40 +2839,40 @@
2829
2839
  {
2830
2840
  "disabled": false,
2831
2841
  "document": "第二个从库复制方式,可能的返回值:async-异步,semisync-半同步",
2832
- "example": "",
2842
+ "example": "async",
2833
2843
  "member": "string",
2834
2844
  "name": "ReplicationMode",
2835
- "required": true,
2845
+ "output_required": true,
2836
2846
  "type": "string",
2837
2847
  "value_allowed_null": false
2838
2848
  },
2839
2849
  {
2840
2850
  "disabled": false,
2841
2851
  "document": "第二个从库可用区的正式名称,如ap-shanghai-1",
2842
- "example": "",
2852
+ "example": "ap-shanghai-1",
2843
2853
  "member": "string",
2844
2854
  "name": "Zone",
2845
- "required": true,
2855
+ "output_required": true,
2846
2856
  "type": "string",
2847
2857
  "value_allowed_null": false
2848
2858
  },
2849
2859
  {
2850
2860
  "disabled": false,
2851
2861
  "document": "第二个从库内网IP地址",
2852
- "example": "",
2862
+ "example": "172.1.1.1",
2853
2863
  "member": "string",
2854
2864
  "name": "Vip",
2855
- "required": true,
2865
+ "output_required": true,
2856
2866
  "type": "string",
2857
2867
  "value_allowed_null": false
2858
2868
  },
2859
2869
  {
2860
2870
  "disabled": false,
2861
2871
  "document": "第二个从库访问端口",
2862
- "example": "",
2872
+ "example": "3306",
2863
2873
  "member": "uint64",
2864
2874
  "name": "Vport",
2865
- "required": true,
2875
+ "output_required": true,
2866
2876
  "type": "int",
2867
2877
  "value_allowed_null": false
2868
2878
  }
@@ -2875,7 +2885,7 @@
2875
2885
  {
2876
2886
  "disabled": false,
2877
2887
  "document": "备份文件名",
2878
- "example": "XXX",
2888
+ "example": "andybackup",
2879
2889
  "member": "string",
2880
2890
  "name": "Name",
2881
2891
  "output_required": true,
@@ -3005,7 +3015,7 @@
3005
3015
  {
3006
3016
  "disabled": false,
3007
3017
  "document": "手动备份别名",
3008
- "example": "\"\"",
3018
+ "example": "andybackup",
3009
3019
  "member": "string",
3010
3020
  "name": "ManualBackupName",
3011
3021
  "output_required": true,
@@ -3035,7 +3045,7 @@
3035
3045
  {
3036
3046
  "disabled": false,
3037
3047
  "document": "异地备份详细信息",
3038
- "example": "",
3048
+ "example": "[{\"SubBackupId\": \"145\",\"Region\": \"ap-guangzhou\",\"Status\": \"SUCCESS\",\"StartTime\": \"2024-03-17 02:00:37\",\"FinishTime\": \"2024-03-17 03:00:37\",\"Url\": \"https://******\"}]",
3039
3049
  "member": "RemoteBackupInfo",
3040
3050
  "name": "RemoteInfo",
3041
3051
  "output_required": true,
@@ -3045,7 +3055,7 @@
3045
3055
  {
3046
3056
  "disabled": false,
3047
3057
  "document": "存储方式,0-常规存储,1-归档存储,2-标准存储,默认为0",
3048
- "example": "",
3058
+ "example": "0",
3049
3059
  "member": "int64",
3050
3060
  "name": "CosStorageType",
3051
3061
  "output_required": true,
@@ -3055,7 +3065,7 @@
3055
3065
  {
3056
3066
  "disabled": false,
3057
3067
  "document": "实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。",
3058
- "example": "",
3068
+ "example": "cdb-c1nl9rpv",
3059
3069
  "member": "string",
3060
3070
  "name": "InstanceId",
3061
3071
  "output_required": true,
@@ -3074,13 +3084,13 @@
3074
3084
  },
3075
3085
  {
3076
3086
  "disabled": false,
3077
- "document": "备份GTID点位\n注意:此字段可能返回 null,表示取不到有效值。",
3087
+ "document": "备份GTID点位",
3078
3088
  "example": "无",
3079
3089
  "member": "string",
3080
3090
  "name": "ExecutedGTIDSet",
3081
3091
  "output_required": false,
3082
3092
  "type": "string",
3083
- "value_allowed_null": true
3093
+ "value_allowed_null": false
3084
3094
  }
3085
3095
  ],
3086
3096
  "usage": "out"
@@ -3091,22 +3101,20 @@
3091
3101
  {
3092
3102
  "disabled": false,
3093
3103
  "document": "需要备份的库名",
3094
- "example": "",
3104
+ "example": "db1",
3095
3105
  "member": "string",
3096
3106
  "name": "Db",
3097
3107
  "required": true,
3098
- "type": "string",
3099
- "value_allowed_null": false
3108
+ "type": "string"
3100
3109
  },
3101
3110
  {
3102
3111
  "disabled": false,
3103
3112
  "document": "需要备份的表名。 如果传该参数,表示备份该库中的指定表。如果不传该参数则备份该db库",
3104
- "example": "",
3113
+ "example": "andy_table1",
3105
3114
  "member": "string",
3106
3115
  "name": "Table",
3107
3116
  "required": false,
3108
- "type": "string",
3109
- "value_allowed_null": false
3117
+ "type": "string"
3110
3118
  }
3111
3119
  ],
3112
3120
  "usage": "in"
@@ -3143,100 +3151,100 @@
3143
3151
  {
3144
3152
  "disabled": false,
3145
3153
  "document": "实例ID。",
3146
- "example": "",
3154
+ "example": "cdb-3gj2yddd",
3147
3155
  "member": "string",
3148
3156
  "name": "InstanceId",
3149
- "required": true,
3157
+ "output_required": true,
3150
3158
  "type": "string",
3151
3159
  "value_allowed_null": false
3152
3160
  },
3153
3161
  {
3154
3162
  "disabled": false,
3155
3163
  "document": "该实例自动数据备份的个数。",
3156
- "example": "",
3164
+ "example": "5",
3157
3165
  "member": "int64",
3158
3166
  "name": "AutoBackupCount",
3159
- "required": true,
3167
+ "output_required": true,
3160
3168
  "type": "int",
3161
3169
  "value_allowed_null": false
3162
3170
  },
3163
3171
  {
3164
3172
  "disabled": false,
3165
3173
  "document": "该实例自动数据备份的容量。",
3166
- "example": "",
3174
+ "example": "1024",
3167
3175
  "member": "int64",
3168
3176
  "name": "AutoBackupVolume",
3169
- "required": true,
3177
+ "output_required": true,
3170
3178
  "type": "int",
3171
3179
  "value_allowed_null": false
3172
3180
  },
3173
3181
  {
3174
3182
  "disabled": false,
3175
3183
  "document": "该实例手动数据备份的个数。",
3176
- "example": "",
3184
+ "example": "5",
3177
3185
  "member": "int64",
3178
3186
  "name": "ManualBackupCount",
3179
- "required": true,
3187
+ "output_required": true,
3180
3188
  "type": "int",
3181
3189
  "value_allowed_null": false
3182
3190
  },
3183
3191
  {
3184
3192
  "disabled": false,
3185
3193
  "document": "该实例手动数据备份的容量。",
3186
- "example": "",
3194
+ "example": "1024",
3187
3195
  "member": "int64",
3188
3196
  "name": "ManualBackupVolume",
3189
- "required": true,
3197
+ "output_required": true,
3190
3198
  "type": "int",
3191
3199
  "value_allowed_null": false
3192
3200
  },
3193
3201
  {
3194
3202
  "disabled": false,
3195
3203
  "document": "该实例总的数据备份(包含自动备份和手动备份)个数。",
3196
- "example": "",
3204
+ "example": "10",
3197
3205
  "member": "int64",
3198
3206
  "name": "DataBackupCount",
3199
- "required": true,
3207
+ "output_required": true,
3200
3208
  "type": "int",
3201
3209
  "value_allowed_null": false
3202
3210
  },
3203
3211
  {
3204
3212
  "disabled": false,
3205
3213
  "document": "该实例总的数据备份容量。",
3206
- "example": "",
3214
+ "example": "2048",
3207
3215
  "member": "int64",
3208
3216
  "name": "DataBackupVolume",
3209
- "required": true,
3217
+ "output_required": true,
3210
3218
  "type": "int",
3211
3219
  "value_allowed_null": false
3212
3220
  },
3213
3221
  {
3214
3222
  "disabled": false,
3215
3223
  "document": "该实例日志备份的个数。",
3216
- "example": "",
3224
+ "example": "5",
3217
3225
  "member": "int64",
3218
3226
  "name": "BinlogBackupCount",
3219
- "required": true,
3227
+ "output_required": true,
3220
3228
  "type": "int",
3221
3229
  "value_allowed_null": false
3222
3230
  },
3223
3231
  {
3224
3232
  "disabled": false,
3225
3233
  "document": "该实例日志备份的容量。",
3226
- "example": "",
3234
+ "example": "1024",
3227
3235
  "member": "int64",
3228
3236
  "name": "BinlogBackupVolume",
3229
- "required": true,
3237
+ "output_required": true,
3230
3238
  "type": "int",
3231
3239
  "value_allowed_null": false
3232
3240
  },
3233
3241
  {
3234
3242
  "disabled": false,
3235
3243
  "document": "该实例的总备份(包含数据备份和日志备份)占用容量。",
3236
- "example": "",
3244
+ "example": "3072",
3237
3245
  "member": "int64",
3238
3246
  "name": "BackupVolume",
3239
- "required": true,
3247
+ "output_required": true,
3240
3248
  "type": "int",
3241
3249
  "value_allowed_null": false
3242
3250
  }
@@ -4044,20 +4052,20 @@
4044
4052
  {
4045
4053
  "disabled": false,
4046
4054
  "document": "克隆任务的源实例Id。",
4047
- "example": "\"\"",
4055
+ "example": "cdb-4zs10ddd",
4048
4056
  "member": "string",
4049
4057
  "name": "SrcInstanceId",
4050
- "required": true,
4058
+ "output_required": true,
4051
4059
  "type": "string",
4052
4060
  "value_allowed_null": false
4053
4061
  },
4054
4062
  {
4055
4063
  "disabled": false,
4056
4064
  "document": "克隆任务的新产生实例Id。",
4057
- "example": "\"\"",
4065
+ "example": "cdb-4nd83sss",
4058
4066
  "member": "string",
4059
4067
  "name": "DstInstanceId",
4060
- "required": true,
4068
+ "output_required": true,
4061
4069
  "type": "string",
4062
4070
  "value_allowed_null": false
4063
4071
  },
@@ -4067,57 +4075,57 @@
4067
4075
  "example": "1",
4068
4076
  "member": "int64",
4069
4077
  "name": "CloneJobId",
4070
- "required": true,
4078
+ "output_required": true,
4071
4079
  "type": "int",
4072
4080
  "value_allowed_null": false
4073
4081
  },
4074
4082
  {
4075
4083
  "disabled": false,
4076
4084
  "document": "克隆实例使用的策略, 包括以下类型: timepoint:指定时间点回档, backupset: 指定备份文件回档。",
4077
- "example": "\"\"",
4085
+ "example": "timepoint",
4078
4086
  "member": "string",
4079
4087
  "name": "RollbackStrategy",
4080
- "required": true,
4088
+ "output_required": true,
4081
4089
  "type": "string",
4082
4090
  "value_allowed_null": false
4083
4091
  },
4084
4092
  {
4085
4093
  "disabled": false,
4086
4094
  "document": "克隆实例回档的时间点。",
4087
- "example": "\"\"",
4095
+ "example": "2024-10-31 02:00:37",
4088
4096
  "member": "string",
4089
4097
  "name": "RollbackTargetTime",
4090
- "required": true,
4098
+ "output_required": true,
4091
4099
  "type": "string",
4092
4100
  "value_allowed_null": false
4093
4101
  },
4094
4102
  {
4095
4103
  "disabled": false,
4096
4104
  "document": "任务开始时间。",
4097
- "example": "\"\"",
4105
+ "example": "2024-10-31 03:00:37",
4098
4106
  "member": "string",
4099
4107
  "name": "StartTime",
4100
- "required": true,
4108
+ "output_required": true,
4101
4109
  "type": "string",
4102
4110
  "value_allowed_null": false
4103
4111
  },
4104
4112
  {
4105
4113
  "disabled": false,
4106
4114
  "document": "任务结束时间。",
4107
- "example": "\"\"",
4115
+ "example": "2024-10-31 03:10:37",
4108
4116
  "member": "string",
4109
4117
  "name": "EndTime",
4110
- "required": true,
4118
+ "output_required": true,
4111
4119
  "type": "string",
4112
4120
  "value_allowed_null": false
4113
4121
  },
4114
4122
  {
4115
4123
  "disabled": false,
4116
4124
  "document": "任务状态,包括以下状态:initial,running,wait_complete,success,failed",
4117
- "example": "\"\"",
4125
+ "example": "running",
4118
4126
  "member": "string",
4119
4127
  "name": "TaskStatus",
4120
- "required": true,
4128
+ "output_required": true,
4121
4129
  "type": "string",
4122
4130
  "value_allowed_null": false
4123
4131
  },
@@ -4127,7 +4135,7 @@
4127
4135
  "example": "1",
4128
4136
  "member": "int64",
4129
4137
  "name": "NewRegionId",
4130
- "required": true,
4138
+ "output_required": true,
4131
4139
  "type": "int",
4132
4140
  "value_allowed_null": false
4133
4141
  },
@@ -4137,7 +4145,7 @@
4137
4145
  "example": "2",
4138
4146
  "member": "int64",
4139
4147
  "name": "SrcRegionId",
4140
- "required": true,
4148
+ "output_required": true,
4141
4149
  "type": "int",
4142
4150
  "value_allowed_null": false
4143
4151
  }
@@ -4349,36 +4357,36 @@
4349
4357
  "members": [
4350
4358
  {
4351
4359
  "disabled": false,
4352
- "document": "节点id\n注意:此字段可能返回 null,表示取不到有效值。",
4360
+ "document": "节点id",
4353
4361
  "example": "\"dbn-ipffzoum\"",
4354
4362
  "member": "string",
4355
4363
  "name": "NodeId",
4356
4364
  "output_required": false,
4357
4365
  "required": false,
4358
4366
  "type": "string",
4359
- "value_allowed_null": true
4367
+ "value_allowed_null": false
4360
4368
  },
4361
4369
  {
4362
4370
  "disabled": false,
4363
- "document": "节点类型:主节点,从节点\n注意:此字段可能返回 null,表示取不到有效值。",
4371
+ "document": "节点类型:主节点,从节点",
4364
4372
  "example": "\"master\"",
4365
4373
  "member": "string",
4366
4374
  "name": "Role",
4367
4375
  "output_required": false,
4368
4376
  "required": false,
4369
4377
  "type": "string",
4370
- "value_allowed_null": true
4378
+ "value_allowed_null": false
4371
4379
  },
4372
4380
  {
4373
4381
  "disabled": false,
4374
- "document": "地域\n注意:此字段可能返回 null,表示取不到有效值。",
4382
+ "document": "地域",
4375
4383
  "example": "\"ap-guangzhou\"",
4376
4384
  "member": "string",
4377
4385
  "name": "Zone",
4378
4386
  "output_required": false,
4379
4387
  "required": false,
4380
4388
  "type": "string",
4381
- "value_allowed_null": true
4389
+ "value_allowed_null": false
4382
4390
  }
4383
4391
  ],
4384
4392
  "usage": "both"
@@ -4922,7 +4930,7 @@
4922
4930
  {
4923
4931
  "disabled": false,
4924
4932
  "document": "审计规则",
4925
- "example": "",
4933
+ "example": "[{\"Type\": \"host\",\"Compare\": \"EQS\",\"Value\": [\"100.122.76.176\",\"10.0.0.9\"]}]",
4926
4934
  "member": "RuleFilters",
4927
4935
  "name": "RuleFilters",
4928
4936
  "required": true,
@@ -4931,7 +4939,7 @@
4931
4939
  {
4932
4940
  "disabled": false,
4933
4941
  "document": "规则模板名称",
4934
- "example": "",
4942
+ "example": "andy",
4935
4943
  "member": "string",
4936
4944
  "name": "RuleTemplateName",
4937
4945
  "required": true,
@@ -4940,7 +4948,7 @@
4940
4948
  {
4941
4949
  "disabled": false,
4942
4950
  "document": "规则模板描述",
4943
- "example": "",
4951
+ "example": "用于测试的规则模板",
4944
4952
  "member": "string",
4945
4953
  "name": "Description",
4946
4954
  "required": false,
@@ -4995,7 +5003,7 @@
4995
5003
  {
4996
5004
  "disabled": false,
4997
5005
  "document": "实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。",
4998
- "example": "\"\"",
5006
+ "example": "cdb-c1nl9rpv",
4999
5007
  "member": "string",
5000
5008
  "name": "InstanceId",
5001
5009
  "required": true,
@@ -5004,7 +5012,7 @@
5004
5012
  {
5005
5013
  "disabled": false,
5006
5014
  "document": "目标备份方法,可选的值:logical - 逻辑冷备,physical - 物理冷备,snapshot - 快照备份。基础版实例仅支持快照备份。",
5007
- "example": "\"\"",
5015
+ "example": "physical",
5008
5016
  "member": "string",
5009
5017
  "name": "BackupMethod",
5010
5018
  "required": true,
@@ -5012,8 +5020,8 @@
5012
5020
  },
5013
5021
  {
5014
5022
  "disabled": false,
5015
- "document": "需要备份的库表信息,如果不设置该参数,则默认整实例备份。在 BackupMethod=logical 逻辑备份中才可设置该参数。指定的库表必须存在,否则可能导致备份失败。\n例:如果需要备份 db1 库的 tb1、tb2 表 和 db2 库。则该参数设置为 [{\"Db\": \"db1\", \"Table\": \"tb1\"}, {\"Db\": \"db1\", \"Table\": \"tb2\"}, {\"Db\": \"db2\"} ]。",
5016
- "example": "",
5023
+ "document": "需要备份的库表信息,如果不设置该参数,则默认整实例备份。在 BackupMethod=logical 逻辑备份中才可设置该参数。指定的库表必须存在,否则可能导致备份失败。\n例:如果需要备份 db1 库的 tb1、tb2 表 和 db2 库。则该参数设置为 [{\"Db\": \"db1\", \"Table\": \"tb1\"}, {\"Db\": \"db1\", \"Table\": \"tb2\"}, {\"Db\": \"db2\"}]。",
5024
+ "example": "[{\"Db\": \"db1\", \"Table\": \"tb1\"}, {\"Db\": \"db1\", \"Table\": \"tb2\"}, {\"Db\": \"db2\"}]",
5017
5025
  "member": "BackupItem",
5018
5026
  "name": "BackupDBTableList",
5019
5027
  "required": false,
@@ -5022,11 +5030,20 @@
5022
5030
  {
5023
5031
  "disabled": false,
5024
5032
  "document": "手动备份别名",
5025
- "example": "\"\"",
5033
+ "example": "手动备份1",
5026
5034
  "member": "string",
5027
5035
  "name": "ManualBackupName",
5028
5036
  "required": false,
5029
5037
  "type": "string"
5038
+ },
5039
+ {
5040
+ "disabled": false,
5041
+ "document": "是否需要加密物理备份, 当BackupMethod为physical 时,该值才有意义。 不指定则使用实例备份默认加密策略。",
5042
+ "example": "no",
5043
+ "member": "string",
5044
+ "name": "EncryptionFlag",
5045
+ "required": false,
5046
+ "type": "string"
5030
5047
  }
5031
5048
  ],
5032
5049
  "type": "object"
@@ -5040,7 +5057,7 @@
5040
5057
  "example": "102996666",
5041
5058
  "member": "uint64",
5042
5059
  "name": "BackupId",
5043
- "required": true,
5060
+ "output_required": true,
5044
5061
  "type": "int",
5045
5062
  "value_allowed_null": false
5046
5063
  },
@@ -5059,7 +5076,7 @@
5059
5076
  {
5060
5077
  "disabled": false,
5061
5078
  "document": "代理组ID",
5062
- "example": "proxy-test",
5079
+ "example": "proxy-kti9m7m1",
5063
5080
  "member": "string",
5064
5081
  "name": "ProxyGroupId",
5065
5082
  "required": true,
@@ -5140,7 +5157,7 @@
5140
5157
  {
5141
5158
  "disabled": false,
5142
5159
  "document": "读写权重分配",
5143
- "example": "",
5160
+ "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-2\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\",\"Weight\": 100}]}]",
5144
5161
  "member": "ProxyAllocation",
5145
5162
  "name": "ProxyAllocation",
5146
5163
  "required": true,
@@ -5176,7 +5193,7 @@
5176
5193
  {
5177
5194
  "disabled": false,
5178
5195
  "document": "描述",
5179
- "example": "test",
5196
+ "example": "andy_proxy",
5180
5197
  "member": "string",
5181
5198
  "name": "Desc",
5182
5199
  "required": false,
@@ -5203,7 +5220,7 @@
5203
5220
  {
5204
5221
  "disabled": false,
5205
5222
  "document": "安全组",
5206
- "example": "",
5223
+ "example": "sg-4qvsxc1a",
5207
5224
  "member": "string",
5208
5225
  "name": "SecurityGroup",
5209
5226
  "required": false,
@@ -5245,7 +5262,7 @@
5245
5262
  {
5246
5263
  "disabled": false,
5247
5264
  "document": "异步任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
5248
- "example": "1312",
5265
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
5249
5266
  "member": "string",
5250
5267
  "name": "AsyncRequestId",
5251
5268
  "output_required": true,
@@ -5367,7 +5384,7 @@
5367
5384
  {
5368
5385
  "disabled": false,
5369
5386
  "document": "克隆源实例Id。",
5370
- "example": "cdb-***",
5387
+ "example": "cdb-9303wd4x",
5371
5388
  "member": "string",
5372
5389
  "name": "InstanceId",
5373
5390
  "required": true,
@@ -5394,7 +5411,7 @@
5394
5411
  {
5395
5412
  "disabled": false,
5396
5413
  "document": "私有网络 ID,如果不传则默认选择基础网络,请使用 [查询私有网络列表](/document/api/215/15778) 。",
5397
- "example": "vpc-***",
5414
+ "example": "vpc-594gwq4l",
5398
5415
  "member": "string",
5399
5416
  "name": "UniqVpcId",
5400
5417
  "required": false,
@@ -5403,7 +5420,7 @@
5403
5420
  {
5404
5421
  "disabled": false,
5405
5422
  "document": "私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 [查询子网列表](/document/api/215/15784)。",
5406
- "example": "subnet-***",
5423
+ "example": "subnet-dz5pj862",
5407
5424
  "member": "string",
5408
5425
  "name": "UniqSubnetId",
5409
5426
  "required": false,
@@ -5430,7 +5447,7 @@
5430
5447
  {
5431
5448
  "disabled": false,
5432
5449
  "document": "新产生的克隆实例名称。",
5433
- "example": "***",
5450
+ "example": "Instance_andy",
5434
5451
  "member": "string",
5435
5452
  "name": "InstanceName",
5436
5453
  "required": false,
@@ -5439,7 +5456,7 @@
5439
5456
  {
5440
5457
  "disabled": false,
5441
5458
  "document": "安全组参数,可使用 [查询项目安全组信息](https://cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。",
5442
- "example": "[]",
5459
+ "example": "[{\"CreateTime\": \"2024-09-26 10:25:05\",\"Inbound\": [{\"Action\": \"ACCEPT\",\"AddressModule\": \"\",\"CidrIp\": \"120.2.2.2\",\"Desc\": \"qta-HA\",\"Dir\": \"\",\"IpProtocol\": \"tcp\",\"PortRange\": \"36000,1,1,1\"}]}]",
5443
5460
  "member": "string",
5444
5461
  "name": "SecurityGroup",
5445
5462
  "required": false,
@@ -5448,7 +5465,7 @@
5448
5465
  {
5449
5466
  "disabled": false,
5450
5467
  "document": "实例标签信息。",
5451
- "example": "[]",
5468
+ "example": "[{\"TagKey\": \"key1\",\"TagValue\": \"value2\"}]",
5452
5469
  "member": "TagInfo",
5453
5470
  "name": "ResourceTags",
5454
5471
  "required": false,
@@ -5484,7 +5501,7 @@
5484
5501
  {
5485
5502
  "disabled": false,
5486
5503
  "document": "新产生的克隆实例备库 1 的可用区信息,默认同源实例 Zone 的值。",
5487
- "example": "‘’",
5504
+ "example": "ap-guangzhou-1",
5488
5505
  "member": "string",
5489
5506
  "name": "SlaveZone",
5490
5507
  "required": false,
@@ -5493,7 +5510,7 @@
5493
5510
  {
5494
5511
  "disabled": false,
5495
5512
  "document": "备库 2 的可用区信息,默认为空,克隆强同步主实例时可指定该参数。",
5496
- "example": "‘’",
5513
+ "example": "ap-guangzhou-2",
5497
5514
  "member": "string",
5498
5515
  "name": "BackupZone",
5499
5516
  "required": false,
@@ -5556,7 +5573,7 @@
5556
5573
  {
5557
5574
  "disabled": false,
5558
5575
  "document": "付费类型,PRE_PAID:包年包月,USED_PAID:按量计费。默认为按量计费",
5559
- "example": "",
5576
+ "example": "PRE_PAID",
5560
5577
  "member": "string",
5561
5578
  "name": "PayType",
5562
5579
  "required": false,
@@ -5565,7 +5582,7 @@
5565
5582
  {
5566
5583
  "disabled": false,
5567
5584
  "document": "实例时长,PayType为PRE_PAID时必传,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。",
5568
- "example": "",
5585
+ "example": "1",
5569
5586
  "member": "int64",
5570
5587
  "name": "Period",
5571
5588
  "required": false,
@@ -5574,7 +5591,7 @@
5574
5591
  {
5575
5592
  "disabled": false,
5576
5593
  "document": "集群版节点拓扑配置。",
5577
- "example": "",
5594
+ "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
5578
5595
  "member": "ClusterTopology",
5579
5596
  "name": "ClusterTopology",
5580
5597
  "required": false,
@@ -5620,7 +5637,7 @@
5620
5637
  {
5621
5638
  "disabled": false,
5622
5639
  "document": "云数据库的用户名。",
5623
- "example": "xxxxx",
5640
+ "example": "andy",
5624
5641
  "member": "string",
5625
5642
  "name": "User",
5626
5643
  "required": true,
@@ -5629,7 +5646,7 @@
5629
5646
  {
5630
5647
  "disabled": false,
5631
5648
  "document": "文件名称。该文件是指用户已上传到腾讯云的文件,仅支持.sql文件。",
5632
- "example": "test.sql",
5649
+ "example": "andy.sql",
5633
5650
  "member": "string",
5634
5651
  "name": "FileName",
5635
5652
  "required": false,
@@ -5638,7 +5655,7 @@
5638
5655
  {
5639
5656
  "disabled": false,
5640
5657
  "document": "云数据库实例 User 账号的密码。",
5641
- "example": "xxxxxxxxxx",
5658
+ "example": "Andy454545",
5642
5659
  "member": "string",
5643
5660
  "name": "Password",
5644
5661
  "required": false,
@@ -5647,7 +5664,7 @@
5647
5664
  {
5648
5665
  "disabled": false,
5649
5666
  "document": "导入的目标数据库名,不传表示不指定数据库。",
5650
- "example": "\"\"",
5667
+ "example": "db1",
5651
5668
  "member": "string",
5652
5669
  "name": "DbName",
5653
5670
  "required": false,
@@ -5656,7 +5673,7 @@
5656
5673
  {
5657
5674
  "disabled": false,
5658
5675
  "document": "腾讯云COS文件链接。 用户需要指定 FileName 或者 CosUrl 其中一个。 COS文件需要是 .sql 文件。",
5659
- "example": "XXX",
5676
+ "example": "https://test-bulk-XXXXX.cos.ap-chengdu.myqcloud.com/myFile/create_db.sql",
5660
5677
  "member": "string",
5661
5678
  "name": "CosUrl",
5662
5679
  "required": false,
@@ -6625,7 +6642,7 @@
6625
6642
  {
6626
6643
  "disabled": false,
6627
6644
  "document": "参数模板名称。",
6628
- "example": "test",
6645
+ "example": "mysql1",
6629
6646
  "member": "string",
6630
6647
  "name": "Name",
6631
6648
  "required": true,
@@ -6634,7 +6651,7 @@
6634
6651
  {
6635
6652
  "disabled": false,
6636
6653
  "document": "参数模板描述。",
6637
- "example": "\"\"",
6654
+ "example": "1区使用",
6638
6655
  "member": "string",
6639
6656
  "name": "Description",
6640
6657
  "required": false,
@@ -6652,7 +6669,7 @@
6652
6669
  {
6653
6670
  "disabled": false,
6654
6671
  "document": "源参数模板 ID。",
6655
- "example": "",
6672
+ "example": "17192",
6656
6673
  "member": "int64",
6657
6674
  "name": "TemplateId",
6658
6675
  "required": false,
@@ -6661,7 +6678,7 @@
6661
6678
  {
6662
6679
  "disabled": false,
6663
6680
  "document": "参数列表。",
6664
- "example": "",
6681
+ "example": "[{\"CurrentValue\": \"59\",\"OldValue\": \"60\",\"ParamName\": \"authentication_timeout\"}]",
6665
6682
  "member": "Parameter",
6666
6683
  "name": "ParamList",
6667
6684
  "required": false,
@@ -6697,7 +6714,7 @@
6697
6714
  "example": "2333",
6698
6715
  "member": "int64",
6699
6716
  "name": "TemplateId",
6700
- "required": true,
6717
+ "output_required": true,
6701
6718
  "type": "int",
6702
6719
  "value_allowed_null": false
6703
6720
  },
@@ -6810,7 +6827,7 @@
6810
6827
  {
6811
6828
  "disabled": false,
6812
6829
  "document": "当前需开启密码轮转的账号信息,包含账户名与主机名",
6813
- "example": "",
6830
+ "example": "[{\"User\": \"andy\",\"Host\": \"192.1.1.1\"}]",
6814
6831
  "member": "Account",
6815
6832
  "name": "Accounts",
6816
6833
  "required": true,
@@ -6947,20 +6964,20 @@
6947
6964
  {
6948
6965
  "disabled": false,
6949
6966
  "document": "数据库名",
6950
- "example": "\"\"",
6967
+ "example": "db1",
6951
6968
  "member": "string",
6952
6969
  "name": "DatabaseName",
6953
- "required": true,
6970
+ "output_required": true,
6954
6971
  "type": "string",
6955
6972
  "value_allowed_null": false
6956
6973
  },
6957
6974
  {
6958
6975
  "disabled": false,
6959
6976
  "document": "字符集类型",
6960
- "example": "\"\"",
6977
+ "example": "utf8",
6961
6978
  "member": "string",
6962
6979
  "name": "CharacterSet",
6963
- "required": true,
6980
+ "output_required": true,
6964
6981
  "type": "string",
6965
6982
  "value_allowed_null": false
6966
6983
  }
@@ -6982,7 +6999,7 @@
6982
6999
  {
6983
7000
  "disabled": false,
6984
7001
  "document": "云数据库账号。",
6985
- "example": "",
7002
+ "example": "[\"User\": \"andy\",\"Host\": \"192.1.1.1\"}]",
6986
7003
  "member": "Account",
6987
7004
  "name": "Accounts",
6988
7005
  "required": true,
@@ -7000,7 +7017,7 @@
7000
7017
  "example": "256117ed-efa08b54-61784d44-91781bbd",
7001
7018
  "member": "string",
7002
7019
  "name": "AsyncRequestId",
7003
- "required": true,
7020
+ "output_required": true,
7004
7021
  "type": "string",
7005
7022
  "value_allowed_null": false
7006
7023
  },
@@ -7019,7 +7036,7 @@
7019
7036
  {
7020
7037
  "disabled": false,
7021
7038
  "document": "审计日志文件名称。",
7022
- "example": "",
7039
+ "example": "13123**346_cdb-0ej6n21d_1734**9765_42322441.csv",
7023
7040
  "member": "string",
7024
7041
  "name": "FileName",
7025
7042
  "required": true,
@@ -7028,7 +7045,7 @@
7028
7045
  {
7029
7046
  "disabled": false,
7030
7047
  "document": "实例 ID。",
7031
- "example": "",
7048
+ "example": "cdb-0ej6n21d",
7032
7049
  "member": "string",
7033
7050
  "name": "InstanceId",
7034
7051
  "required": true,
@@ -7055,7 +7072,7 @@
7055
7072
  {
7056
7073
  "disabled": false,
7057
7074
  "document": "审计策略 ID。",
7058
- "example": "",
7075
+ "example": "cdbpolicy-234",
7059
7076
  "member": "string",
7060
7077
  "name": "PolicyId",
7061
7078
  "required": true,
@@ -7064,7 +7081,7 @@
7064
7081
  {
7065
7082
  "disabled": false,
7066
7083
  "document": "实例 ID。",
7067
- "example": "",
7084
+ "example": "cdb-0ej6n21d",
7068
7085
  "member": "string",
7069
7086
  "name": "InstanceId",
7070
7087
  "required": false,
@@ -7217,7 +7234,7 @@
7217
7234
  {
7218
7235
  "disabled": false,
7219
7236
  "document": "要删除的置放群组 ID 列表。",
7220
- "example": "[\"test\\r\\n\"]",
7237
+ "example": "[\"andy\\r\\n\"]",
7221
7238
  "member": "string",
7222
7239
  "name": "DeployGroupIds",
7223
7240
  "required": true,
@@ -7244,7 +7261,7 @@
7244
7261
  {
7245
7262
  "disabled": false,
7246
7263
  "document": "参数模板ID。",
7247
- "example": "1234",
7264
+ "example": "17192",
7248
7265
  "member": "int64",
7249
7266
  "name": "TemplateId",
7250
7267
  "required": true,
@@ -7280,7 +7297,7 @@
7280
7297
  {
7281
7298
  "disabled": false,
7282
7299
  "document": "关闭密码轮转的实例账户名,例如root",
7283
- "example": "",
7300
+ "example": "andy",
7284
7301
  "member": "string",
7285
7302
  "name": "User",
7286
7303
  "required": true,
@@ -7289,7 +7306,7 @@
7289
7306
  {
7290
7307
  "disabled": false,
7291
7308
  "document": "关闭密码轮转的实例账户域名,例如%",
7292
- "example": "",
7309
+ "example": "192.1.1.1",
7293
7310
  "member": "string",
7294
7311
  "name": "Host",
7295
7312
  "required": true,
@@ -7298,7 +7315,7 @@
7298
7315
  {
7299
7316
  "disabled": false,
7300
7317
  "document": "关闭密码轮转后实例账户的最新密码",
7301
- "example": "",
7318
+ "example": "Andy454545",
7302
7319
  "member": "string",
7303
7320
  "name": "Password",
7304
7321
  "required": true,
@@ -7307,7 +7324,7 @@
7307
7324
  {
7308
7325
  "disabled": false,
7309
7326
  "document": "传入不为空则对密码进行了加密处理",
7310
- "example": "",
7327
+ "example": "134531",
7311
7328
  "member": "string",
7312
7329
  "name": "EncryptMethod",
7313
7330
  "required": false,
@@ -7559,7 +7576,7 @@
7559
7576
  {
7560
7577
  "disabled": false,
7561
7578
  "document": "匹配账号名的正则表达式,规则同 MySQL 官网。",
7562
- "example": "\"\"",
7579
+ "example": "^[a-zA-Z0-9_]{3,20}$",
7563
7580
  "member": "string",
7564
7581
  "name": "AccountRegexp",
7565
7582
  "required": false,
@@ -7584,7 +7601,7 @@
7584
7601
  {
7585
7602
  "disabled": false,
7586
7603
  "document": "符合查询条件的账号详细信息。",
7587
- "example": "",
7604
+ "example": "[{\"Notes\": \"andy1\",\"Host\": \"localhost\",\"User\": \"andy_user\",\"ModifyTime\": \"2020-11-10 01:00:00\",\"ModifyPasswordTime\": \"2020-11-10 01:00:00\",\"CreateTime\": \"2020-11-10 01:00:00\",\"MaxUserConnections\": 20},{\"Notes\": \"andy2\",\"Host\": \"localhost\",\"User\": \"root\",\"ModifyTime\": \"2020-11-10 01:00:00\",\"ModifyPasswordTime\": \"2020-11-10 01:00:00\",\"CreateTime\": \"2020-11-10 01:00:00\",\"MaxUserConnections\": 20}]",
7588
7605
  "member": "AccountInfo",
7589
7606
  "name": "Items",
7590
7607
  "output_required": true,
@@ -7739,7 +7756,7 @@
7739
7756
  {
7740
7757
  "disabled": false,
7741
7758
  "document": "查询实例列表的过滤条件。",
7742
- "example": "",
7759
+ "example": "[{\"Values\": [\"cdb-euu5fkcj\"], \"Name\": \"InstanceId\",\"ExactMatch\": true}]",
7743
7760
  "member": "AuditInstanceFilters",
7744
7761
  "name": "Filters",
7745
7762
  "required": false,
@@ -7784,15 +7801,17 @@
7784
7801
  "example": "0",
7785
7802
  "member": "uint64",
7786
7803
  "name": "TotalCount",
7804
+ "output_required": true,
7787
7805
  "type": "int",
7788
7806
  "value_allowed_null": false
7789
7807
  },
7790
7808
  {
7791
7809
  "disabled": false,
7792
7810
  "document": "审计实例详细信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
7793
- "example": "",
7811
+ "example": "[{\"BillingAmount\": 0,\"LowRealStorage\": 0,\"InstanceId\": \"cdb-euu5fkcj\",\"AuditTask\": 1,\"CreateAt\": \"2022-03-02 10:09:08\",\"AuditStatus\": \"1\",\"LogExpireDay\": 1,\"AuditAll\": true,\"InstanceInfo\": {\"ProjectId\": 0,\"TagList\": [{\"TagKey\": \"andy\",\"TagValue\": \"1\"}]},\"HighRealStorage\": 0,\"HighLogExpireDay\": 30,\"LowLogExpireDay\": 7}]",
7794
7812
  "member": "InstanceDbAuditStatus",
7795
7813
  "name": "Items",
7814
+ "output_required": true,
7796
7815
  "type": "list",
7797
7816
  "value_allowed_null": true
7798
7817
  },
@@ -7838,7 +7857,7 @@
7838
7857
  {
7839
7858
  "disabled": false,
7840
7859
  "document": "审计日志文件名。",
7841
- "example": "abc",
7860
+ "example": "shenji_andy",
7842
7861
  "member": "string",
7843
7862
  "name": "FileName",
7844
7863
  "required": false,
@@ -7856,17 +7875,17 @@
7856
7875
  "example": "1",
7857
7876
  "member": "int64",
7858
7877
  "name": "TotalCount",
7859
- "required": true,
7878
+ "output_required": true,
7860
7879
  "type": "int",
7861
7880
  "value_allowed_null": false
7862
7881
  },
7863
7882
  {
7864
7883
  "disabled": false,
7865
7884
  "document": "审计日志文件详情。\n注意:此字段可能返回 null,表示取不到有效值。",
7866
- "example": "",
7885
+ "example": "[{\"FileName\": \"shenji_andy\", \"CreateTime\": \"2024-03-20 17:09:13\",\"Status\": success}]",
7867
7886
  "member": "AuditLogFile",
7868
7887
  "name": "Items",
7869
- "required": true,
7888
+ "output_required": true,
7870
7889
  "type": "list",
7871
7890
  "value_allowed_null": true
7872
7891
  },
@@ -8040,7 +8059,7 @@
8040
8059
  {
8041
8060
  "disabled": false,
8042
8061
  "document": "审计规则 ID。可使用该审计规则 ID 查询到其关联的审计策略。\n注意,参数 RuleId,InstanceId,PolicyId,PolicyName 必须至少传一个。",
8043
- "example": "test",
8062
+ "example": "cdbrule-asdfqwer",
8044
8063
  "member": "string",
8045
8064
  "name": "RuleId",
8046
8065
  "required": false,
@@ -8074,7 +8093,7 @@
8074
8093
  {
8075
8094
  "disabled": false,
8076
8095
  "document": "审计策略详情。\n注意:此字段可能返回 null,表示取不到有效值。",
8077
- "example": "",
8096
+ "example": "[{\"PolicyId\": \"cdbpolicy-asdfqwer\",\"Status\": \"running\",\"InstanceId\": \"cdb-qwerasdf\",\"InstanceName\": \"andy1\",\"CreateTime\": \"2019-03-20 17:09:13\",\"ModifyTime\": \"2019-03-20 17:09:13\",\"PolicyName\": \"audit_policy_1\",\"RuleId\": \"cdbrule-asdfqwer\",\"RuleName\": \"audit1\"}]",
8078
8097
  "member": "AuditPolicy",
8079
8098
  "name": "Items",
8080
8099
  "output_required": true,
@@ -8155,23 +8174,23 @@
8155
8174
  "members": [
8156
8175
  {
8157
8176
  "disabled": false,
8158
- "document": "总的条数。\n注意:此字段可能返回 null,表示取不到有效值。",
8159
- "example": "",
8177
+ "document": "总的条数。",
8178
+ "example": "10",
8160
8179
  "member": "int64",
8161
8180
  "name": "TotalCount",
8162
8181
  "output_required": false,
8163
8182
  "type": "int",
8164
- "value_allowed_null": true
8183
+ "value_allowed_null": false
8165
8184
  },
8166
8185
  {
8167
8186
  "disabled": false,
8168
- "document": "变更详情。\n注意:此字段可能返回 null,表示取不到有效值。",
8169
- "example": "",
8187
+ "document": "变更详情。",
8188
+ "example": "[\"TaskId\": 1997098,\"ModifyBeforeInfo\": {\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"wy_1\",\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"DROP\"]}],\"AlarmLevel\": 1,\"AlarmPolicy\": 0,\"Description\": \"\"},\"ModifyAfterInfo\": {\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"wy_1\",\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"DROP\",\"DELETE\"]}],\"AlarmLevel\": 2,\"AlarmPolicy\": 0,\"Description\": \"\"},\"AffectedInstances\": [\"cdb-nzg4gv35\",\"cdb-12y4cjjd\"],\"Operator\": \"700000579947\",\"UpdateTime\": \"2023-07-26 00:09:00\"}]",
8170
8189
  "member": "RuleTemplateRecordInfo",
8171
8190
  "name": "Items",
8172
8191
  "output_required": false,
8173
8192
  "type": "list",
8174
- "value_allowed_null": true
8193
+ "value_allowed_null": false
8175
8194
  },
8176
8195
  {
8177
8196
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -8248,7 +8267,7 @@
8248
8267
  {
8249
8268
  "disabled": false,
8250
8269
  "document": "符合查询条件的实例总数。",
8251
- "example": "",
8270
+ "example": "2",
8252
8271
  "member": "uint64",
8253
8272
  "name": "TotalCount",
8254
8273
  "output_required": true,
@@ -8258,7 +8277,7 @@
8258
8277
  {
8259
8278
  "disabled": false,
8260
8279
  "document": "规则模板详细信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
8261
- "example": "",
8280
+ "example": "[\"CreateAt\": \"2022-12-06 00:54:01\",\"Description\": \"all_template_des\",\"RuleFilters\": [{\"Compare\": \"INC\",\"Type\": \"sqlType\",\"Value\": [\"ALTER\"]},{\"Compare\": \"EQS\",\"Type\": \"host\",\"Value\": [\"10.0.0.2\"]},{\"Compare\": \"NEQ\",\"Type\": \"user\",\"Value\": [\"lue\"},{\"Compare\": \"INC\",\"Type\": \"dbName\",\"Value\": [\"lue\"]}],\"RuleTemplateId\": \"cdb-art-lcpm4as3\",\"RuleTemplateName\": \"template_1\"}]",
8262
8281
  "member": "AuditRuleTemplateInfo",
8263
8282
  "name": "Items",
8264
8283
  "output_required": true,
@@ -8552,7 +8571,7 @@
8552
8571
  {
8553
8572
  "disabled": false,
8554
8573
  "document": "实例ID,格式如:cdb-XXXX。与云数据库控制台页面中显示的实例 ID 相同。",
8555
- "example": "cdb-XXXX",
8574
+ "example": "cdb-fybaegd8",
8556
8575
  "member": "string",
8557
8576
  "name": "InstanceId",
8558
8577
  "required": true,
@@ -8561,7 +8580,7 @@
8561
8580
  {
8562
8581
  "disabled": false,
8563
8582
  "document": "实例的备份ID,可通过DescribeBackups接口查询备份的ID。",
8564
- "example": "12345",
8583
+ "example": "12445233",
8565
8584
  "member": "int64",
8566
8585
  "name": "BackupId",
8567
8586
  "required": true,
@@ -8585,7 +8604,7 @@
8585
8604
  {
8586
8605
  "disabled": false,
8587
8606
  "document": "备份文件解密密钥。",
8588
- "example": "XXXX",
8607
+ "example": "your_key",
8589
8608
  "member": "string",
8590
8609
  "name": "DecryptionKey",
8591
8610
  "output_required": true,
@@ -9070,7 +9089,7 @@
9070
9089
  {
9071
9090
  "disabled": false,
9072
9091
  "document": "偏移量,最小值为0。",
9073
- "example": "0",
9092
+ "example": "10",
9074
9093
  "member": "int64",
9075
9094
  "name": "Offset",
9076
9095
  "required": false,
@@ -9079,7 +9098,7 @@
9079
9098
  {
9080
9099
  "disabled": false,
9081
9100
  "document": "分页大小,默认值为20,最小值为1,最大值为100。",
9082
- "example": "0",
9101
+ "example": "20",
9083
9102
  "member": "int64",
9084
9103
  "name": "Limit",
9085
9104
  "required": false,
@@ -9106,7 +9125,7 @@
9106
9125
  {
9107
9126
  "disabled": false,
9108
9127
  "document": "返回binlog列表是否包含MinStartTime起始节点,默认为否",
9109
- "example": "",
9128
+ "example": "false",
9110
9129
  "member": "bool",
9111
9130
  "name": "ContainsMinStartTime",
9112
9131
  "required": false,
@@ -9187,7 +9206,7 @@
9187
9206
  {
9188
9207
  "disabled": false,
9189
9208
  "document": "代理组信息\n注意:此字段可能返回 null,表示取不到有效值。",
9190
- "example": "",
9209
+ "example": "[{\"ConnectionPoolLimit\": 5,\"ProxyAddress\": [{\"AutoAddRo\": true,\"ConnectionPool\": false,\"Desc\": \"\",\"FailOver\": true,\"IsKickOut\": false,\"MaxDelay\": 0,\"MinCount\": 0,\"ProxyAddressId\": \"proxyaddr-kti9m7d6\",\"AccessMode\": \"balance\",\"ProxyAllocation\": [{\"ProxyInstance\": [{\"InstanceId\": \"cdb-nuxj5ndd\",\"InstanceName\": \"andydb\",\"InstanceType\": \"1\",\"Region\": \"ap-nanjing\",\"Status\": 1,\"Weight\": 0,\"Zone\": \"ap-nanjing-1\"}],\"Region\": \"ap-nanjing\",\"Zone\": \"ap-nanjing-1\"}],\"ReadOnly\": false,\"TransSplit\": false,\"UniqSubnetId\": \"subnet-ijehnd\",\"UniqVpcId\": \"vpc-jnhekd\",\"VPort\": 3306,\"Vip\": \"10.0.0.0\",\"WeightMode\": \"custom\"}],\"ProxyGroupId\": \"proxy-mfxftest\",\"ProxyNode\": [{\"Cpu\": 2,\"Mem\": 4000,\"ProxyId\": \"proxynode-2u0c1tv1\",\"Region\": \"ap-nanjing\",\"Status\": \"online\",\"Zone\": \"ap-nanjing-1\",\"Connection\": 1}],\"ProxyVersion\": \"1.3.7\",\"Status\": \"online\",\"SupportCreateProxyAddress\": false,\"SupportUpgradeProxyMysqlVersion\": \"20211030\",\"SupportUpgradeProxyVersion\": \"1.3.7\",\"TaskStatus\": \"ProxyModifyAddress\"}]",
9191
9210
  "member": "ProxyGroupInfo",
9192
9211
  "name": "ProxyInfos",
9193
9212
  "output_required": true,
@@ -9272,15 +9291,17 @@
9272
9291
  "example": "2",
9273
9292
  "member": "int64",
9274
9293
  "name": "TotalCount",
9294
+ "output_required": true,
9275
9295
  "type": "int",
9276
9296
  "value_allowed_null": false
9277
9297
  },
9278
9298
  {
9279
9299
  "disabled": false,
9280
9300
  "document": "克隆任务列表。",
9281
- "example": "",
9301
+ "example": "[\"SrcInstanceId\": \"cdb-4bblpca3\",\"RollbackTargetTime\": \"2019-11-15 12:34:56\",\"CloneJobId\": 80,\"SrcRegionId\": 0,\"TaskStatus\": \"initial\",\"NewRegionId\":8,\"RollbackStrategy\": \"timepoint\",\"StartTime\": \"2019-12-26 18:05:42\",\"DstInstanceId\": \"cdb-9ubfzt6x\",\"EndTime\": \"\"},{\"SrcInstanceId\": \"cdb-4bblpca3\",\"RollbackTargetTime\": \"2019-11-15 16:13:31\",\"CloneJobId\": 81,\"SrcRegionId\": 4,\"TaskStatus\": \"initial\", \"StartTime\": \"2019-12-26 17:16:58\",\"RollbackStrategy\": \"backupset\",\"NewRegionId\": 0,\"DstInstanceId\": \"cdb-awbsatzq\", \"EndTime\": \"\"}]",
9282
9302
  "member": "CloneItem",
9283
9303
  "name": "Items",
9304
+ "output_required": true,
9284
9305
  "type": "list",
9285
9306
  "value_allowed_null": false
9286
9307
  },
@@ -9911,23 +9932,23 @@
9911
9932
  "members": [
9912
9933
  {
9913
9934
  "disabled": false,
9914
- "document": "错误日志投递CLS配置\n注意:此字段可能返回 null,表示取不到有效值。",
9935
+ "document": "错误日志投递CLS配置",
9915
9936
  "example": "{\"Status\": \"ON\",\"LogSetId\":\"xxx\",\"LogTopicId\":\"xxx\"}",
9916
9937
  "member": "LogToCLSConfig",
9917
9938
  "name": "ErrorLog",
9918
9939
  "output_required": false,
9919
9940
  "type": "object",
9920
- "value_allowed_null": true
9941
+ "value_allowed_null": false
9921
9942
  },
9922
9943
  {
9923
9944
  "disabled": false,
9924
- "document": "慢日志投递CLS配置\n注意:此字段可能返回 null,表示取不到有效值。",
9945
+ "document": "慢日志投递CLS配置",
9925
9946
  "example": "{\"Status\": \"ON\",\"LogSetId\":\"xxx\",\"LogTopicId\":\"xxx\"}",
9926
9947
  "member": "LogToCLSConfig",
9927
9948
  "name": "SlowLog",
9928
9949
  "output_required": false,
9929
9950
  "type": "object",
9930
- "value_allowed_null": true
9951
+ "value_allowed_null": false
9931
9952
  },
9932
9953
  {
9933
9954
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
@@ -10821,7 +10842,7 @@
10821
10842
  {
10822
10843
  "disabled": false,
10823
10844
  "document": "匹配数据库库名的正则表达式。",
10824
- "example": "test",
10845
+ "example": "^database.*",
10825
10846
  "member": "string",
10826
10847
  "name": "DatabaseRegexp",
10827
10848
  "required": false,
@@ -10839,7 +10860,7 @@
10839
10860
  "example": "7",
10840
10861
  "member": "int64",
10841
10862
  "name": "TotalCount",
10842
- "required": true,
10863
+ "output_required": true,
10843
10864
  "type": "int",
10844
10865
  "value_allowed_null": false
10845
10866
  },
@@ -10849,17 +10870,17 @@
10849
10870
  "example": "[ \"information_schema\", \"mysql\", ",
10850
10871
  "member": "string",
10851
10872
  "name": "Items",
10852
- "required": true,
10873
+ "output_required": true,
10853
10874
  "type": "list",
10854
10875
  "value_allowed_null": false
10855
10876
  },
10856
10877
  {
10857
10878
  "disabled": false,
10858
10879
  "document": "数据库名以及字符集",
10859
- "example": "[]",
10880
+ "example": "[{\"CharacterSet\":\"UTF8\",\"DatabaseName\":\"database\"}]",
10860
10881
  "member": "DatabasesWithCharacterLists",
10861
10882
  "name": "DatabaseList",
10862
- "required": true,
10883
+ "output_required": true,
10863
10884
  "type": "list",
10864
10885
  "value_allowed_null": false
10865
10886
  },
@@ -11289,7 +11310,7 @@
11289
11310
  {
11290
11311
  "disabled": false,
11291
11312
  "document": "事件信息。查询不到信息时,Items为null。\n注意:此字段可能返回 null,表示取不到有效值。",
11292
- "example": "",
11313
+ "example": "[{\"EventName\": \"PlannedSwitch\",\"EventStatus\": \"1\",\"InstanceId\": \"cdb-fbd5agyt\",\"NodeId\": \"\",\"OccurTime\": \"2024-11-25 14:46:42\"}]",
11293
11314
  "member": "InstEventInfo",
11294
11315
  "name": "Items",
11295
11316
  "output_required": false,
@@ -11699,15 +11720,17 @@
11699
11720
  "example": "233",
11700
11721
  "member": "int64",
11701
11722
  "name": "TemplateId",
11723
+ "output_required": true,
11702
11724
  "type": "int",
11703
11725
  "value_allowed_null": false
11704
11726
  },
11705
11727
  {
11706
11728
  "disabled": false,
11707
11729
  "document": "参数模板名称。",
11708
- "example": "***",
11730
+ "example": "andy",
11709
11731
  "member": "string",
11710
11732
  "name": "Name",
11733
+ "output_required": true,
11711
11734
  "type": "string",
11712
11735
  "value_allowed_null": false
11713
11736
  },
@@ -11717,6 +11740,7 @@
11717
11740
  "example": "5.6",
11718
11741
  "member": "string",
11719
11742
  "name": "EngineVersion",
11743
+ "output_required": true,
11720
11744
  "type": "string",
11721
11745
  "value_allowed_null": false
11722
11746
  },
@@ -11726,6 +11750,7 @@
11726
11750
  "example": "1",
11727
11751
  "member": "int64",
11728
11752
  "name": "TotalCount",
11753
+ "output_required": true,
11729
11754
  "type": "int",
11730
11755
  "value_allowed_null": false
11731
11756
  },
@@ -11735,6 +11760,7 @@
11735
11760
  "example": "[]",
11736
11761
  "member": "ParameterDetail",
11737
11762
  "name": "Items",
11763
+ "output_required": true,
11738
11764
  "type": "list",
11739
11765
  "value_allowed_null": false
11740
11766
  },
@@ -11744,6 +11770,7 @@
11744
11770
  "example": "your_description",
11745
11771
  "member": "string",
11746
11772
  "name": "Description",
11773
+ "output_required": true,
11747
11774
  "type": "string",
11748
11775
  "value_allowed_null": false
11749
11776
  },
@@ -11753,6 +11780,7 @@
11753
11780
  "example": "HIGH_STABILITY",
11754
11781
  "member": "string",
11755
11782
  "name": "TemplateType",
11783
+ "output_required": true,
11756
11784
  "type": "string",
11757
11785
  "value_allowed_null": false
11758
11786
  },
@@ -11762,6 +11790,7 @@
11762
11790
  "example": "InnoDB",
11763
11791
  "member": "string",
11764
11792
  "name": "EngineType",
11793
+ "output_required": true,
11765
11794
  "type": "string",
11766
11795
  "value_allowed_null": true
11767
11796
  },
@@ -12476,7 +12505,7 @@
12476
12505
  },
12477
12506
  {
12478
12507
  "disabled": false,
12479
- "document": "开始时间戳。例如 1585142640",
12508
+ "document": "开始时间戳。例如 1585142640。\n说明:此参数单位为秒的时间戳。",
12480
12509
  "example": "1585142640",
12481
12510
  "member": "uint64",
12482
12511
  "name": "StartTime",
@@ -12485,7 +12514,7 @@
12485
12514
  },
12486
12515
  {
12487
12516
  "disabled": false,
12488
- "document": "结束时间戳。例如 1585142640",
12517
+ "document": "结束时间戳。例如 1585142640。\n说明:此参数单位为秒的时间戳。",
12489
12518
  "example": "1585142640",
12490
12519
  "member": "uint64",
12491
12520
  "name": "EndTime",
@@ -12592,7 +12621,7 @@
12592
12621
  {
12593
12622
  "disabled": false,
12594
12623
  "document": "查询到的记录。\n注意:此字段可能返回 null,表示取不到有效值。",
12595
- "example": "",
12624
+ "example": "[{\"Database\": \"1231231\",\"LockTime\": 1,\"Md5\": \"23123123\",\"QueryTime\": 100,\"RowsExamined\": 0,\"RowsSent\": 0,\"SqlTemplate\": \"show master status111111\",\"SqlText\": \"update order_logistics set logistics_status = 205 where logistics_id in ( select `logistics_id` from `order_info` where order_no in('15706082880074381752','15706082880074381751'))\",\"Timestamp\": 1585**2640,\"UserHost\": \"localhost\",\"UserName\": \"march\"}]",
12596
12625
  "member": "SlowLogItem",
12597
12626
  "name": "Items",
12598
12627
  "output_required": true,
@@ -12782,7 +12811,7 @@
12782
12811
  {
12783
12812
  "disabled": false,
12784
12813
  "document": "匹配数据库表名的正则表达式,规则同 MySQL 官网",
12785
- "example": "test",
12814
+ "example": "^table.*",
12786
12815
  "member": "string",
12787
12816
  "name": "TableRegexp",
12788
12817
  "required": false,
@@ -12800,7 +12829,7 @@
12800
12829
  "example": "10",
12801
12830
  "member": "int64",
12802
12831
  "name": "TotalCount",
12803
- "required": true,
12832
+ "output_required": true,
12804
12833
  "type": "int",
12805
12834
  "value_allowed_null": false
12806
12835
  },
@@ -12810,7 +12839,7 @@
12810
12839
  "example": ":[ \"CHARACTER_SETS\", \"COLLATIONS\", ",
12811
12840
  "member": "string",
12812
12841
  "name": "Items",
12813
- "required": true,
12842
+ "output_required": true,
12814
12843
  "type": "list",
12815
12844
  "value_allowed_null": false
12816
12845
  },
@@ -12882,7 +12911,7 @@
12882
12911
  {
12883
12912
  "disabled": false,
12884
12913
  "document": "实例标签信息。",
12885
- "example": "",
12914
+ "example": " [{\"InstanceId\": \"cdb-uns231ns\",\"Tags\": [{\"TagKey\": \"name\",\"TagValue\": \"zhang\"}]}]",
12886
12915
  "member": "TagsInfoOfInstance",
12887
12916
  "name": "Rows",
12888
12917
  "output_required": true,
@@ -13181,25 +13210,25 @@
13181
13210
  "type": "object"
13182
13211
  },
13183
13212
  "DeviceCpuInfo": {
13184
- "document": " CPU负载",
13213
+ "document": "CPU负载",
13185
13214
  "members": [
13186
13215
  {
13187
13216
  "disabled": false,
13188
13217
  "document": "实例CPU平均使用率",
13189
- "example": "",
13218
+ "example": "[{\"CpuCore\": \"2\",\"Rate\": \"50\"}]",
13190
13219
  "member": "DeviceCpuRateInfo",
13191
13220
  "name": "Rate",
13192
- "required": true,
13221
+ "output_required": true,
13193
13222
  "type": "list",
13194
13223
  "value_allowed_null": false
13195
13224
  },
13196
13225
  {
13197
13226
  "disabled": false,
13198
13227
  "document": "实例CPU监控数据",
13199
- "example": "",
13228
+ "example": "",
13200
13229
  "member": "int64",
13201
13230
  "name": "Load",
13202
- "required": true,
13231
+ "output_required": true,
13203
13232
  "type": "list",
13204
13233
  "value_allowed_null": false
13205
13234
  }
@@ -13212,20 +13241,20 @@
13212
13241
  {
13213
13242
  "disabled": false,
13214
13243
  "document": "Cpu核编号",
13215
- "example": "",
13244
+ "example": "2",
13216
13245
  "member": "int64",
13217
13246
  "name": "CpuCore",
13218
- "required": true,
13247
+ "output_required": true,
13219
13248
  "type": "int",
13220
13249
  "value_allowed_null": false
13221
13250
  },
13222
13251
  {
13223
13252
  "disabled": false,
13224
13253
  "document": "Cpu使用率",
13225
- "example": "",
13254
+ "example": "50",
13226
13255
  "member": "int64",
13227
13256
  "name": "Rate",
13228
- "required": true,
13257
+ "output_required": true,
13229
13258
  "type": "list",
13230
13259
  "value_allowed_null": false
13231
13260
  }
@@ -13238,50 +13267,50 @@
13238
13267
  {
13239
13268
  "disabled": false,
13240
13269
  "document": "平均每秒有百分之几的时间用于IO操作",
13241
- "example": "",
13270
+ "example": "[0,0]",
13242
13271
  "member": "int64",
13243
13272
  "name": "IoRatioPerSec",
13244
- "required": true,
13273
+ "output_required": true,
13245
13274
  "type": "list",
13246
13275
  "value_allowed_null": false
13247
13276
  },
13248
13277
  {
13249
13278
  "disabled": false,
13250
13279
  "document": "平均每次设备I/O操作的等待时间*100,单位为毫秒。例如:该值为201,表示平均每次I/O操作等待时间为:201/100=2.1毫秒",
13251
- "example": "",
13280
+ "example": "[61,65]",
13252
13281
  "member": "int64",
13253
13282
  "name": "IoWaitTime",
13254
- "required": true,
13283
+ "output_required": true,
13255
13284
  "type": "list",
13256
13285
  "value_allowed_null": false
13257
13286
  },
13258
13287
  {
13259
13288
  "disabled": false,
13260
13289
  "document": "磁盘平均每秒完成的读操作次数总和*100。例如:该值为2002,表示磁盘平均每秒完成读操作为:2002/100=20.2次",
13261
- "example": "",
13290
+ "example": "[2002,2000]",
13262
13291
  "member": "int64",
13263
13292
  "name": "Read",
13264
- "required": true,
13293
+ "output_required": true,
13265
13294
  "type": "list",
13266
13295
  "value_allowed_null": false
13267
13296
  },
13268
13297
  {
13269
13298
  "disabled": false,
13270
13299
  "document": "磁盘平均每秒完成的写操作次数总和*100。例如:该值为30001,表示磁盘平均每秒完成写操作为:30001/100=300.01次",
13271
- "example": "",
13300
+ "example": "[740,797]",
13272
13301
  "member": "int64",
13273
13302
  "name": "Write",
13274
- "required": true,
13303
+ "output_required": true,
13275
13304
  "type": "list",
13276
13305
  "value_allowed_null": false
13277
13306
  },
13278
13307
  {
13279
13308
  "disabled": false,
13280
13309
  "document": "磁盘空间容量,每两个一组,第一个为已使用容量,第二个为磁盘总容量",
13281
- "example": "",
13310
+ "example": "[5433344,49153024,0,40931328,1024,40946688,272384,40945664,0,40945664,123813888,195940352,12439552,587817984]",
13282
13311
  "member": "int64",
13283
13312
  "name": "CapacityRatio",
13284
- "required": true,
13313
+ "output_required": true,
13285
13314
  "type": "list",
13286
13315
  "value_allowed_null": false
13287
13316
  }
@@ -13294,20 +13323,20 @@
13294
13323
  {
13295
13324
  "disabled": false,
13296
13325
  "document": "总内存大小。free命令中Mem:一行total的值,单位:KB",
13297
- "example": "",
13326
+ "example": "[1024,2048]",
13298
13327
  "member": "int64",
13299
13328
  "name": "Total",
13300
- "required": true,
13329
+ "output_required": true,
13301
13330
  "type": "list",
13302
13331
  "value_allowed_null": false
13303
13332
  },
13304
13333
  {
13305
13334
  "disabled": false,
13306
13335
  "document": "已使用内存。free命令中Mem:一行used的值,单位:KB",
13307
- "example": "",
13336
+ "example": "[200,500]",
13308
13337
  "member": "int64",
13309
13338
  "name": "Used",
13310
- "required": true,
13339
+ "output_required": true,
13311
13340
  "type": "list",
13312
13341
  "value_allowed_null": false
13313
13342
  }
@@ -13320,50 +13349,50 @@
13320
13349
  {
13321
13350
  "disabled": false,
13322
13351
  "document": "tcp连接数",
13323
- "example": "",
13352
+ "example": "[133,130]",
13324
13353
  "member": "int64",
13325
13354
  "name": "Conn",
13326
- "required": true,
13355
+ "output_required": true,
13327
13356
  "type": "list",
13328
13357
  "value_allowed_null": false
13329
13358
  },
13330
13359
  {
13331
13360
  "disabled": false,
13332
13361
  "document": "网卡入包量,单位:个/秒",
13333
- "example": "",
13362
+ "example": "[960,960]",
13334
13363
  "member": "int64",
13335
13364
  "name": "PackageIn",
13336
- "required": true,
13365
+ "output_required": true,
13337
13366
  "type": "list",
13338
13367
  "value_allowed_null": false
13339
13368
  },
13340
13369
  {
13341
13370
  "disabled": false,
13342
13371
  "document": "网卡出包量,单位:个/秒",
13343
- "example": "",
13372
+ "example": "[960,960]",
13344
13373
  "member": "int64",
13345
13374
  "name": "PackageOut",
13346
- "required": true,
13375
+ "output_required": true,
13347
13376
  "type": "list",
13348
13377
  "value_allowed_null": false
13349
13378
  },
13350
13379
  {
13351
13380
  "disabled": false,
13352
13381
  "document": "入流量,单位:kbps",
13353
- "example": "",
13382
+ "example": "[150,112]",
13354
13383
  "member": "int64",
13355
13384
  "name": "FlowIn",
13356
- "required": true,
13385
+ "output_required": true,
13357
13386
  "type": "list",
13358
13387
  "value_allowed_null": false
13359
13388
  },
13360
13389
  {
13361
13390
  "disabled": false,
13362
13391
  "document": "出流量,单位:kbps",
13363
- "example": "",
13392
+ "example": "[1342,1260]",
13364
13393
  "member": "int64",
13365
13394
  "name": "FlowOut",
13366
- "required": true,
13395
+ "output_required": true,
13367
13396
  "type": "list",
13368
13397
  "value_allowed_null": false
13369
13398
  }
@@ -13522,120 +13551,133 @@
13522
13551
  "members": [
13523
13552
  {
13524
13553
  "disabled": false,
13525
- "document": "状态值",
13526
- "example": "",
13554
+ "document": "状态值\n注意:此字段可能返回 null,表示取不到有效值。",
13555
+ "example": "3",
13527
13556
  "member": "int64",
13528
13557
  "name": "Status",
13529
- "required": true,
13530
- "type": "int"
13558
+ "output_required": true,
13559
+ "type": "int",
13560
+ "value_allowed_null": true
13531
13561
  },
13532
13562
  {
13533
13563
  "disabled": false,
13534
- "document": "状态值",
13535
- "example": "",
13564
+ "document": "状态值\n注意:此字段可能返回 null,表示取不到有效值。",
13565
+ "example": "1",
13536
13566
  "member": "int64",
13537
13567
  "name": "Code",
13538
- "required": true,
13539
- "type": "int"
13568
+ "output_required": true,
13569
+ "type": "int",
13570
+ "value_allowed_null": true
13540
13571
  },
13541
13572
  {
13542
13573
  "disabled": false,
13543
- "document": "执行时间",
13544
- "example": "",
13574
+ "document": "执行时间\n注意:此字段可能返回 null,表示取不到有效值。",
13575
+ "example": "0",
13545
13576
  "member": "int64",
13546
13577
  "name": "CostTime",
13547
- "required": true,
13548
- "type": "int"
13578
+ "output_required": true,
13579
+ "type": "int",
13580
+ "value_allowed_null": true
13549
13581
  },
13550
13582
  {
13551
13583
  "disabled": false,
13552
- "document": "实例ID",
13553
- "example": "",
13584
+ "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。",
13585
+ "example": "cdb-c1nl9rpv",
13554
13586
  "member": "string",
13555
13587
  "name": "InstanceId",
13556
- "required": true,
13557
- "type": "string"
13588
+ "output_required": true,
13589
+ "type": "string",
13590
+ "value_allowed_null": true
13558
13591
  },
13559
13592
  {
13560
13593
  "disabled": false,
13561
- "document": "后端任务ID",
13562
- "example": "",
13594
+ "document": "后端任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
13595
+ "example": "1649290",
13563
13596
  "member": "string",
13564
13597
  "name": "WorkId",
13565
- "required": true,
13566
- "type": "string"
13598
+ "output_required": true,
13599
+ "type": "string",
13600
+ "value_allowed_null": true
13567
13601
  },
13568
13602
  {
13569
13603
  "disabled": false,
13570
- "document": "导入文件名",
13571
- "example": "",
13604
+ "document": "导入文件名\n注意:此字段可能返回 null,表示取不到有效值。",
13605
+ "example": "monkey_1501490864.sql",
13572
13606
  "member": "string",
13573
13607
  "name": "FileName",
13574
- "required": true,
13575
- "type": "string"
13608
+ "output_required": true,
13609
+ "type": "string",
13610
+ "value_allowed_null": true
13576
13611
  },
13577
13612
  {
13578
13613
  "disabled": false,
13579
- "document": "执行进度",
13580
- "example": "",
13614
+ "document": "执行进度\n注意:此字段可能返回 null,表示取不到有效值。",
13615
+ "example": "5",
13581
13616
  "member": "int64",
13582
13617
  "name": "Process",
13583
- "required": true,
13584
- "type": "int"
13618
+ "output_required": true,
13619
+ "type": "int",
13620
+ "value_allowed_null": true
13585
13621
  },
13586
13622
  {
13587
13623
  "disabled": false,
13588
- "document": "任务创建时间",
13589
- "example": "",
13624
+ "document": "任务创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
13625
+ "example": "2017-11-09 14:26:31",
13590
13626
  "member": "datetime",
13591
13627
  "name": "CreateTime",
13592
- "required": true,
13593
- "type": "string"
13628
+ "output_required": true,
13629
+ "type": "string",
13630
+ "value_allowed_null": true
13594
13631
  },
13595
13632
  {
13596
13633
  "disabled": false,
13597
- "document": "文件大小",
13598
- "example": "",
13634
+ "document": "文件大小\n注意:此字段可能返回 null,表示取不到有效值。",
13635
+ "example": "12",
13599
13636
  "member": "string",
13600
13637
  "name": "FileSize",
13601
- "required": true,
13602
- "type": "string"
13638
+ "output_required": true,
13639
+ "type": "string",
13640
+ "value_allowed_null": true
13603
13641
  },
13604
13642
  {
13605
13643
  "disabled": false,
13606
- "document": "任务执行信息",
13607
- "example": "",
13644
+ "document": "任务执行信息\n注意:此字段可能返回 null,表示取不到有效值。",
13645
+ "example": "lock_inst.cgi: 某些实例id不存在对应的实例记录",
13608
13646
  "member": "string",
13609
13647
  "name": "Message",
13610
- "required": true,
13611
- "type": "string"
13648
+ "output_required": true,
13649
+ "type": "string",
13650
+ "value_allowed_null": true
13612
13651
  },
13613
13652
  {
13614
13653
  "disabled": false,
13615
- "document": "任务ID",
13616
- "example": "",
13654
+ "document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
13655
+ "example": "16242",
13617
13656
  "member": "int64",
13618
13657
  "name": "JobId",
13619
- "required": true,
13620
- "type": "int"
13658
+ "output_required": true,
13659
+ "type": "int",
13660
+ "value_allowed_null": true
13621
13661
  },
13622
13662
  {
13623
13663
  "disabled": false,
13624
- "document": "导入库表名",
13625
- "example": "",
13664
+ "document": "导入库表名\n注意:此字段可能返回 null,表示取不到有效值。",
13665
+ "example": "abdy_table",
13626
13666
  "member": "string",
13627
13667
  "name": "DbName",
13628
- "required": true,
13629
- "type": "string"
13668
+ "output_required": true,
13669
+ "type": "string",
13670
+ "value_allowed_null": true
13630
13671
  },
13631
13672
  {
13632
13673
  "disabled": false,
13633
- "document": "异步任务的请求ID",
13634
- "example": "",
13674
+ "document": "异步任务的请求ID\n注意:此字段可能返回 null,表示取不到有效值。",
13675
+ "example": "a4788d0a-df23758a-ac961e5a-af414d33",
13635
13676
  "member": "string",
13636
13677
  "name": "AsyncRequestId",
13637
- "required": true,
13638
- "type": "string"
13678
+ "output_required": true,
13679
+ "type": "string",
13680
+ "value_allowed_null": true
13639
13681
  }
13640
13682
  ],
13641
13683
  "usage": "out"
@@ -14022,7 +14064,7 @@
14022
14064
  {
14023
14065
  "disabled": false,
14024
14066
  "document": "实例相关信息\n注意:此字段可能返回 null,表示取不到有效值。",
14025
- "example": "",
14067
+ "example": "[{\"ProjectId\": \"23414\",\"TagList\": [{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}],\"DbType\": \"MYSQL\",\"DbVersion\": \"5.7\"}]",
14026
14068
  "member": "AuditInstanceInfo",
14027
14069
  "name": "InstanceInfo",
14028
14070
  "output_required": true,
@@ -14051,13 +14093,13 @@
14051
14093
  },
14052
14094
  {
14053
14095
  "disabled": false,
14054
- "document": "实例所应用的规则模板。\n注意:此字段可能返回 null,表示取不到有效值。",
14055
- "example": "",
14096
+ "document": "实例所应用的规则模板。",
14097
+ "example": "[\"cdb-art-8qx2kcr7\"]",
14056
14098
  "member": "string",
14057
14099
  "name": "RuleTemplateIds",
14058
14100
  "output_required": false,
14059
14101
  "type": "list",
14060
- "value_allowed_null": true
14102
+ "value_allowed_null": false
14061
14103
  }
14062
14104
  ],
14063
14105
  "usage": "out"
@@ -14579,39 +14621,43 @@
14579
14621
  "members": [
14580
14622
  {
14581
14623
  "disabled": false,
14582
- "document": "查询数据库错误码",
14583
- "example": "",
14624
+ "document": "查询数据库错误码\n注意:此字段可能返回 null,表示取不到有效值。",
14625
+ "example": "0",
14584
14626
  "member": "int64",
14585
14627
  "name": "Code",
14586
- "required": true,
14587
- "type": "int"
14628
+ "output_required": true,
14629
+ "type": "int",
14630
+ "value_allowed_null": true
14588
14631
  },
14589
14632
  {
14590
14633
  "disabled": false,
14591
- "document": "查询数据库错误信息",
14592
- "example": "",
14634
+ "document": "查询数据库错误信息\n注意:此字段可能返回 null,表示取不到有效值。",
14635
+ "example": "ok",
14593
14636
  "member": "string",
14594
14637
  "name": "Message",
14595
- "required": true,
14596
- "type": "string"
14638
+ "output_required": true,
14639
+ "type": "string",
14640
+ "value_allowed_null": true
14597
14641
  },
14598
14642
  {
14599
14643
  "disabled": false,
14600
- "document": "实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同",
14601
- "example": "",
14644
+ "document": "实例ID列表,单个实例Id的格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同\n注意:此字段可能返回 null,表示取不到有效值。",
14645
+ "example": "cdb-fix44sxh",
14602
14646
  "member": "string",
14603
14647
  "name": "InstanceId",
14604
- "required": true,
14605
- "type": "string"
14648
+ "output_required": true,
14649
+ "type": "string",
14650
+ "value_allowed_null": true
14606
14651
  },
14607
14652
  {
14608
14653
  "disabled": false,
14609
- "document": "可回档时间范围",
14610
- "example": "",
14654
+ "document": "可回档时间范围\n注意:此字段可能返回 null,表示取不到有效值。",
14655
+ "example": "[{\"Begin\": \"2024-08-21 02:06:20\",\"End\": \"2024-08-25 17:52:05\"}]",
14611
14656
  "member": "RollbackTimeRange",
14612
14657
  "name": "Times",
14613
- "required": true,
14614
- "type": "list"
14658
+ "output_required": true,
14659
+ "type": "list",
14660
+ "value_allowed_null": true
14615
14661
  }
14616
14662
  ],
14617
14663
  "usage": "out"
@@ -14756,43 +14802,43 @@
14756
14802
  "members": [
14757
14803
  {
14758
14804
  "disabled": false,
14759
- "document": "投递状态打开或者关闭\n注意:此字段可能返回 null,表示取不到有效值。",
14805
+ "document": "投递状态打开或者关闭",
14760
14806
  "example": "ON/OFF",
14761
14807
  "member": "string",
14762
14808
  "name": "Status",
14763
14809
  "output_required": false,
14764
14810
  "type": "string",
14765
- "value_allowed_null": true
14811
+ "value_allowed_null": false
14766
14812
  },
14767
14813
  {
14768
14814
  "disabled": false,
14769
- "document": "CLS日志集ID\n注意:此字段可能返回 null,表示取不到有效值。",
14815
+ "document": "CLS日志集ID",
14770
14816
  "example": "8dff8d62-fa10-4d6c-bee0-6e31a0ade975",
14771
14817
  "member": "string",
14772
14818
  "name": "LogSetId",
14773
14819
  "output_required": false,
14774
14820
  "type": "string",
14775
- "value_allowed_null": true
14821
+ "value_allowed_null": false
14776
14822
  },
14777
14823
  {
14778
14824
  "disabled": false,
14779
- "document": "日志主题ID\n注意:此字段可能返回 null,表示取不到有效值。",
14825
+ "document": "日志主题ID",
14780
14826
  "example": "09c3c2d1-ac46-4e4e-b688-b73950e64682",
14781
14827
  "member": "string",
14782
14828
  "name": "LogTopicId",
14783
14829
  "output_required": false,
14784
14830
  "type": "string",
14785
- "value_allowed_null": true
14831
+ "value_allowed_null": false
14786
14832
  },
14787
14833
  {
14788
14834
  "disabled": false,
14789
- "document": "CLS服务所在地域\n注意:此字段可能返回 null,表示取不到有效值。",
14835
+ "document": "CLS服务所在地域",
14790
14836
  "example": "ap-guangzhou",
14791
14837
  "member": "string",
14792
14838
  "name": "ClsRegion",
14793
14839
  "output_required": false,
14794
14840
  "type": "string",
14795
- "value_allowed_null": true
14841
+ "value_allowed_null": false
14796
14842
  }
14797
14843
  ],
14798
14844
  "usage": "out"
@@ -14806,7 +14852,7 @@
14806
14852
  "example": "ap-guangzhou",
14807
14853
  "member": "string",
14808
14854
  "name": "Region",
14809
- "required": true,
14855
+ "output_required": true,
14810
14856
  "type": "string",
14811
14857
  "value_allowed_null": false
14812
14858
  },
@@ -14816,7 +14862,7 @@
14816
14862
  "example": "1",
14817
14863
  "member": "int64",
14818
14864
  "name": "RegionId",
14819
- "required": true,
14865
+ "output_required": true,
14820
14866
  "type": "int",
14821
14867
  "value_allowed_null": false
14822
14868
  },
@@ -14826,7 +14872,7 @@
14826
14872
  "example": "100003",
14827
14873
  "member": "int64",
14828
14874
  "name": "ZoneId",
14829
- "required": true,
14875
+ "output_required": true,
14830
14876
  "type": "int",
14831
14877
  "value_allowed_null": false
14832
14878
  },
@@ -14836,7 +14882,7 @@
14836
14882
  "example": "ap-guangzhou-3",
14837
14883
  "member": "string",
14838
14884
  "name": "Zone",
14839
- "required": true,
14885
+ "output_required": true,
14840
14886
  "type": "string",
14841
14887
  "value_allowed_null": false
14842
14888
  },
@@ -14846,7 +14892,7 @@
14846
14892
  "example": "cdb-***",
14847
14893
  "member": "string",
14848
14894
  "name": "InstanceId",
14849
- "required": true,
14895
+ "output_required": true,
14850
14896
  "type": "string",
14851
14897
  "value_allowed_null": false
14852
14898
  },
@@ -14856,7 +14902,7 @@
14856
14902
  "example": "''",
14857
14903
  "member": "string",
14858
14904
  "name": "ResourceId",
14859
- "required": true,
14905
+ "output_required": true,
14860
14906
  "type": "string",
14861
14907
  "value_allowed_null": false
14862
14908
  },
@@ -14866,7 +14912,7 @@
14866
14912
  "example": "1",
14867
14913
  "member": "int64",
14868
14914
  "name": "Status",
14869
- "required": true,
14915
+ "output_required": true,
14870
14916
  "type": "int",
14871
14917
  "value_allowed_null": false
14872
14918
  },
@@ -14876,7 +14922,7 @@
14876
14922
  "example": "***",
14877
14923
  "member": "string",
14878
14924
  "name": "InstanceName",
14879
- "required": true,
14925
+ "output_required": true,
14880
14926
  "type": "string",
14881
14927
  "value_allowed_null": false
14882
14928
  },
@@ -14886,7 +14932,7 @@
14886
14932
  "example": "1",
14887
14933
  "member": "int64",
14888
14934
  "name": "InstanceType",
14889
- "required": true,
14935
+ "output_required": true,
14890
14936
  "type": "int",
14891
14937
  "value_allowed_null": false
14892
14938
  },
@@ -14896,7 +14942,7 @@
14896
14942
  "example": "0",
14897
14943
  "member": "int64",
14898
14944
  "name": "TaskStatus",
14899
- "required": true,
14945
+ "output_required": true,
14900
14946
  "type": "int",
14901
14947
  "value_allowed_null": false
14902
14948
  },
@@ -14906,7 +14952,7 @@
14906
14952
  "example": "1000",
14907
14953
  "member": "int64",
14908
14954
  "name": "Memory",
14909
- "required": true,
14955
+ "output_required": true,
14910
14956
  "type": "int",
14911
14957
  "value_allowed_null": false
14912
14958
  },
@@ -14916,7 +14962,7 @@
14916
14962
  "example": "50",
14917
14963
  "member": "int64",
14918
14964
  "name": "Volume",
14919
- "required": true,
14965
+ "output_required": true,
14920
14966
  "type": "int",
14921
14967
  "value_allowed_null": false
14922
14968
  },
@@ -14926,7 +14972,7 @@
14926
14972
  "example": "UNIVERSAL",
14927
14973
  "member": "string",
14928
14974
  "name": "DeviceType",
14929
- "required": true,
14975
+ "output_required": true,
14930
14976
  "type": "string",
14931
14977
  "value_allowed_null": false
14932
14978
  },
@@ -14936,7 +14982,7 @@
14936
14982
  "example": "1000",
14937
14983
  "member": "int64",
14938
14984
  "name": "Qps",
14939
- "required": true,
14985
+ "output_required": true,
14940
14986
  "type": "int",
14941
14987
  "value_allowed_null": false
14942
14988
  },
@@ -14946,7 +14992,7 @@
14946
14992
  "example": "1533",
14947
14993
  "member": "int64",
14948
14994
  "name": "VpcId",
14949
- "required": true,
14995
+ "output_required": true,
14950
14996
  "type": "int",
14951
14997
  "value_allowed_null": false
14952
14998
  },
@@ -14956,7 +15002,7 @@
14956
15002
  "example": "12364",
14957
15003
  "member": "int64",
14958
15004
  "name": "SubnetId",
14959
- "required": true,
15005
+ "output_required": true,
14960
15006
  "type": "int",
14961
15007
  "value_allowed_null": false
14962
15008
  },
@@ -14966,17 +15012,17 @@
14966
15012
  "example": "''",
14967
15013
  "member": "string",
14968
15014
  "name": "ExClusterId",
14969
- "required": true,
15015
+ "output_required": true,
14970
15016
  "type": "string",
14971
15017
  "value_allowed_null": false
14972
15018
  },
14973
15019
  {
14974
15020
  "disabled": false,
14975
15021
  "document": "独享集群名称",
14976
- "example": "''",
15022
+ "example": "andy",
14977
15023
  "member": "string",
14978
15024
  "name": "ExClusterName",
14979
- "required": true,
15025
+ "output_required": true,
14980
15026
  "type": "string",
14981
15027
  "value_allowed_null": false
14982
15028
  }
@@ -15061,7 +15107,7 @@
15061
15107
  {
15062
15108
  "disabled": false,
15063
15109
  "document": "实例当前告警策略id数组",
15064
- "example": "",
15110
+ "example": "[\"policy-u4c8n51d\"]",
15065
15111
  "member": "int64",
15066
15112
  "name": "SrcAlarmPolicyList",
15067
15113
  "required": false,
@@ -15085,7 +15131,7 @@
15085
15131
  {
15086
15132
  "disabled": false,
15087
15133
  "document": "云数据库账号。",
15088
- "example": "",
15134
+ "example": "andy",
15089
15135
  "member": "Account",
15090
15136
  "name": "Accounts",
15091
15137
  "required": true,
@@ -15112,7 +15158,7 @@
15112
15158
  "example": "256117ed-efa08b54-61784d44-91781bbd",
15113
15159
  "member": "string",
15114
15160
  "name": "AsyncRequestId",
15115
- "required": true,
15161
+ "output_required": true,
15116
15162
  "type": "string",
15117
15163
  "value_allowed_null": false
15118
15164
  },
@@ -16531,7 +16577,7 @@
16531
16577
  {
16532
16578
  "disabled": false,
16533
16579
  "document": "要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名,CurrentValue 是要修改成的值。",
16534
- "example": "",
16580
+ "example": "[{\"CurrentValue\": \"1\", \"Name\": \"auto_increment_increment\"}]",
16535
16581
  "member": "Parameter",
16536
16582
  "name": "ParamList",
16537
16583
  "required": false,
@@ -16585,7 +16631,7 @@
16585
16631
  "example": "38265324-dd030463-3d46a793-4a0420b1",
16586
16632
  "member": "string",
16587
16633
  "name": "AsyncRequestId",
16588
- "required": true,
16634
+ "output_required": true,
16589
16635
  "type": "string",
16590
16636
  "value_allowed_null": false
16591
16637
  },
@@ -16604,7 +16650,7 @@
16604
16650
  {
16605
16651
  "disabled": false,
16606
16652
  "document": "实例短 ID 列表。",
16607
- "example": "[\"cdb-atjl8gns\\r\\n\"]",
16653
+ "example": "[\"cdb-93hvfe1d\" ]",
16608
16654
  "member": "string",
16609
16655
  "name": "InstanceIds",
16610
16656
  "required": true,
@@ -16613,7 +16659,7 @@
16613
16659
  {
16614
16660
  "disabled": false,
16615
16661
  "document": "要修改的参数列表。每一个元素是Name和CurrentValue的组合。Name是参数名,CurrentValue是要修改成的值。8.0版本Name支持范围:[\"validate_password.policy\",\"validate_password.length\",\"validate_password.mixed_case_count\",\"validate_password.number_count\",\"validate_password.special_char_count\"],5.6和5.7版本支持范围:[\"validate_password_policy\",\"validate_password_length\",\"validate_password_mixed_case_count\",\"validate_password_number_count\",\"validate_password_special_char_count\"]",
16616
- "example": "",
16662
+ "example": "[{\"Name\": \"validate_password.length\",\"CurrentValue\": \"10\"}]",
16617
16663
  "member": "Parameter",
16618
16664
  "name": "ParamList",
16619
16665
  "required": false,
@@ -16631,7 +16677,7 @@
16631
16677
  "example": "38265324-dd030463-3d46a793-4a0420b1",
16632
16678
  "member": "string",
16633
16679
  "name": "AsyncRequestId",
16634
- "required": true,
16680
+ "output_required": true,
16635
16681
  "type": "string",
16636
16682
  "value_allowed_null": false
16637
16683
  },
@@ -16838,7 +16884,7 @@
16838
16884
  "members": [
16839
16885
  {
16840
16886
  "disabled": false,
16841
- "document": "",
16887
+ "document": "数据复制方式,默认为 0,支持值包括:0 - 表示异步复制,1 - 表示半同步复制,2 - 表示强同步复制。",
16842
16888
  "example": "1",
16843
16889
  "member": "int64",
16844
16890
  "name": "ProtectMode",
@@ -16947,7 +16993,7 @@
16947
16993
  {
16948
16994
  "disabled": false,
16949
16995
  "document": "RO 组的详细信息。",
16950
- "example": "",
16996
+ "example": "{\"RoOfflineDelay\": \"1\",\"MinRoInGroup\": \"1\",\"RoMaxDelayTime\": \"10\"}",
16951
16997
  "member": "RoGroupAttr",
16952
16998
  "name": "RoGroupInfo",
16953
16999
  "required": false,
@@ -16956,7 +17002,7 @@
16956
17002
  {
16957
17003
  "disabled": false,
16958
17004
  "document": "RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。",
16959
- "example": "",
17005
+ "example": " [{\"InstanceId\": \"cdbr0-test1234\",\"Weight\": \"70\"},{\"InstanceId\": \"cdbr0-iup41a4t\",\"Weight\": \"30\"}]",
16960
17006
  "member": "RoWeightValue",
16961
17007
  "name": "RoWeightValues",
16962
17008
  "required": false,
@@ -16992,7 +17038,7 @@
16992
17038
  "example": "dadaddasda-23adcasdasd-asdaasc",
16993
17039
  "member": "string",
16994
17040
  "name": "AsyncRequestId",
16995
- "required": true,
17041
+ "output_required": true,
16996
17042
  "type": "string",
16997
17043
  "value_allowed_null": true
16998
17044
  },
@@ -17474,7 +17520,7 @@
17474
17520
  {
17475
17521
  "disabled": false,
17476
17522
  "document": "实例ID",
17477
- "example": "\"\"",
17523
+ "example": "cdb-gbpmgsss",
17478
17524
  "member": "string",
17479
17525
  "name": "InstanceId",
17480
17526
  "output_required": true,
@@ -17484,7 +17530,7 @@
17484
17530
  {
17485
17531
  "disabled": false,
17486
17532
  "document": "参数名称",
17487
- "example": "\"\"",
17533
+ "example": "auto_increment_increment",
17488
17534
  "member": "string",
17489
17535
  "name": "ParamName",
17490
17536
  "output_required": true,
@@ -17494,7 +17540,7 @@
17494
17540
  {
17495
17541
  "disabled": false,
17496
17542
  "document": "参数修改前的值",
17497
- "example": "\"\"",
17543
+ "example": "2",
17498
17544
  "member": "string",
17499
17545
  "name": "OldValue",
17500
17546
  "output_required": true,
@@ -17504,7 +17550,7 @@
17504
17550
  {
17505
17551
  "disabled": false,
17506
17552
  "document": "参数修改后的值",
17507
- "example": "\"\"",
17553
+ "example": "1",
17508
17554
  "member": "string",
17509
17555
  "name": "NewValue",
17510
17556
  "output_required": true,
@@ -17524,7 +17570,7 @@
17524
17570
  {
17525
17571
  "disabled": false,
17526
17572
  "document": "修改时间",
17527
- "example": "\"\"",
17573
+ "example": "2020-09-09 16:40:30",
17528
17574
  "member": "string",
17529
17575
  "name": "ModifyTime",
17530
17576
  "output_required": true,
@@ -17553,27 +17599,27 @@
17553
17599
  "example": "1",
17554
17600
  "member": "int64",
17555
17601
  "name": "TemplateId",
17556
- "required": true,
17602
+ "output_required": true,
17557
17603
  "type": "int",
17558
17604
  "value_allowed_null": false
17559
17605
  },
17560
17606
  {
17561
17607
  "disabled": false,
17562
17608
  "document": "参数模板名称",
17563
- "example": "test",
17609
+ "example": "andy5.7",
17564
17610
  "member": "string",
17565
17611
  "name": "Name",
17566
- "required": true,
17612
+ "output_required": true,
17567
17613
  "type": "string",
17568
17614
  "value_allowed_null": false
17569
17615
  },
17570
17616
  {
17571
17617
  "disabled": false,
17572
17618
  "document": "参数模板描述",
17573
- "example": "test",
17619
+ "example": "一区参数",
17574
17620
  "member": "string",
17575
17621
  "name": "Description",
17576
- "required": true,
17622
+ "output_required": true,
17577
17623
  "type": "string",
17578
17624
  "value_allowed_null": false
17579
17625
  },
@@ -17583,7 +17629,7 @@
17583
17629
  "example": "5.7",
17584
17630
  "member": "string",
17585
17631
  "name": "EngineVersion",
17586
- "required": true,
17632
+ "output_required": true,
17587
17633
  "type": "string",
17588
17634
  "value_allowed_null": false
17589
17635
  },
@@ -17593,7 +17639,7 @@
17593
17639
  "example": "HIGH_STABILITY",
17594
17640
  "member": "string",
17595
17641
  "name": "TemplateType",
17596
- "required": true,
17642
+ "output_required": true,
17597
17643
  "type": "string",
17598
17644
  "value_allowed_null": false
17599
17645
  },
@@ -17603,7 +17649,7 @@
17603
17649
  "example": "InnoDB",
17604
17650
  "member": "string",
17605
17651
  "name": "EngineType",
17606
- "required": false,
17652
+ "output_required": true,
17607
17653
  "type": "string",
17608
17654
  "value_allowed_null": true
17609
17655
  }
@@ -17640,10 +17686,10 @@
17640
17686
  {
17641
17687
  "disabled": false,
17642
17688
  "document": "参数名称",
17643
- "example": "test",
17689
+ "example": "auto_increment_increment",
17644
17690
  "member": "string",
17645
17691
  "name": "Name",
17646
- "required": true,
17692
+ "output_required": true,
17647
17693
  "type": "string",
17648
17694
  "value_allowed_null": false
17649
17695
  },
@@ -17653,7 +17699,7 @@
17653
17699
  "example": "string",
17654
17700
  "member": "string",
17655
17701
  "name": "ParamType",
17656
- "required": true,
17702
+ "output_required": true,
17657
17703
  "type": "string",
17658
17704
  "value_allowed_null": false
17659
17705
  },
@@ -17663,7 +17709,7 @@
17663
17709
  "example": "OFF",
17664
17710
  "member": "string",
17665
17711
  "name": "Default",
17666
- "required": true,
17712
+ "output_required": true,
17667
17713
  "type": "string",
17668
17714
  "value_allowed_null": false
17669
17715
  },
@@ -17673,7 +17719,7 @@
17673
17719
  "example": "Controls the sensitivity of linear read-ahead that InnoDB uses t",
17674
17720
  "member": "string",
17675
17721
  "name": "Description",
17676
- "required": true,
17722
+ "output_required": true,
17677
17723
  "type": "string",
17678
17724
  "value_allowed_null": false
17679
17725
  },
@@ -17683,7 +17729,7 @@
17683
17729
  "example": "56",
17684
17730
  "member": "string",
17685
17731
  "name": "CurrentValue",
17686
- "required": true,
17732
+ "output_required": true,
17687
17733
  "type": "string",
17688
17734
  "value_allowed_null": false
17689
17735
  },
@@ -17693,7 +17739,7 @@
17693
17739
  "example": "1",
17694
17740
  "member": "int64",
17695
17741
  "name": "NeedReboot",
17696
- "required": true,
17742
+ "output_required": true,
17697
17743
  "type": "int",
17698
17744
  "value_allowed_null": false
17699
17745
  },
@@ -17703,7 +17749,7 @@
17703
17749
  "example": "64",
17704
17750
  "member": "int64",
17705
17751
  "name": "Max",
17706
- "required": true,
17752
+ "output_required": true,
17707
17753
  "type": "int",
17708
17754
  "value_allowed_null": false
17709
17755
  },
@@ -17713,7 +17759,7 @@
17713
17759
  "example": "1",
17714
17760
  "member": "int64",
17715
17761
  "name": "Min",
17716
- "required": true,
17762
+ "output_required": true,
17717
17763
  "type": "int",
17718
17764
  "value_allowed_null": false
17719
17765
  },
@@ -17723,7 +17769,7 @@
17723
17769
  "example": "[]",
17724
17770
  "member": "string",
17725
17771
  "name": "EnumValue",
17726
- "required": true,
17772
+ "output_required": true,
17727
17773
  "type": "list",
17728
17774
  "value_allowed_null": false
17729
17775
  },
@@ -17733,7 +17779,7 @@
17733
17779
  "example": "64",
17734
17780
  "member": "string",
17735
17781
  "name": "MaxFunc",
17736
- "required": true,
17782
+ "output_required": true,
17737
17783
  "type": "string",
17738
17784
  "value_allowed_null": false
17739
17785
  },
@@ -17743,7 +17789,7 @@
17743
17789
  "example": "1",
17744
17790
  "member": "string",
17745
17791
  "name": "MinFunc",
17746
- "required": true,
17792
+ "output_required": true,
17747
17793
  "type": "string",
17748
17794
  "value_allowed_null": false
17749
17795
  },
@@ -17753,7 +17799,7 @@
17753
17799
  "example": "false",
17754
17800
  "member": "bool",
17755
17801
  "name": "IsNotSupportEdit",
17756
- "required": false,
17802
+ "output_required": true,
17757
17803
  "type": "bool",
17758
17804
  "value_allowed_null": true
17759
17805
  }
@@ -17906,7 +17952,7 @@
17906
17952
  {
17907
17953
  "disabled": false,
17908
17954
  "document": "描述\n注意:此字段可能返回 null,表示取不到有效值。",
17909
- "example": "test",
17955
+ "example": "代理一区",
17910
17956
  "member": "string",
17911
17957
  "name": "Desc",
17912
17958
  "output_required": true,
@@ -17916,7 +17962,7 @@
17916
17962
  {
17917
17963
  "disabled": false,
17918
17964
  "document": "实例读权重分配\n注意:此字段可能返回 null,表示取不到有效值。",
17919
- "example": "",
17965
+ "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\",\"InstanceName\": \"cdb37262\",\"InstanceType\": \"1\",\"Status\": \"1\",\"Weight\": \"100\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"InstNodeId\": \"cbn-ehjshe\",\"InstNodeRole\": \"master\"}]}]",
17920
17966
  "member": "ProxyAllocation",
17921
17967
  "name": "ProxyAllocation",
17922
17968
  "output_required": true,
@@ -17925,23 +17971,23 @@
17925
17971
  },
17926
17972
  {
17927
17973
  "disabled": false,
17928
- "document": "接入模式\n注意:此字段可能返回 null,表示取不到有效值。",
17974
+ "document": "接入模式",
17929
17975
  "example": "balance",
17930
17976
  "member": "string",
17931
17977
  "name": "AccessMode",
17932
17978
  "output_required": false,
17933
17979
  "type": "string",
17934
- "value_allowed_null": true
17980
+ "value_allowed_null": false
17935
17981
  },
17936
17982
  {
17937
17983
  "disabled": false,
17938
- "document": "是否开启自动负载均衡\n注意:此字段可能返回 null,表示取不到有效值。",
17984
+ "document": "是否开启自动负载均衡",
17939
17985
  "example": "false",
17940
17986
  "member": "bool",
17941
17987
  "name": "AutoLoadBalance",
17942
17988
  "output_required": false,
17943
17989
  "type": "bool",
17944
- "value_allowed_null": true
17990
+ "value_allowed_null": false
17945
17991
  }
17946
17992
  ],
17947
17993
  "usage": "out"
@@ -17994,7 +18040,7 @@
17994
18040
  "example": "proxy-ixw3ll2d",
17995
18041
  "member": "string",
17996
18042
  "name": "ProxyGroupId",
17997
- "required": true,
18043
+ "output_required": true,
17998
18044
  "type": "string",
17999
18045
  "value_allowed_null": false
18000
18046
  },
@@ -18004,7 +18050,7 @@
18004
18050
  "example": "1.2.1",
18005
18051
  "member": "string",
18006
18052
  "name": "ProxyVersion",
18007
- "required": true,
18053
+ "output_required": true,
18008
18054
  "type": "string",
18009
18055
  "value_allowed_null": true
18010
18056
  },
@@ -18014,7 +18060,7 @@
18014
18060
  "example": "1.3.1",
18015
18061
  "member": "string",
18016
18062
  "name": "SupportUpgradeProxyVersion",
18017
- "required": true,
18063
+ "output_required": true,
18018
18064
  "type": "string",
18019
18065
  "value_allowed_null": true
18020
18066
  },
@@ -18024,7 +18070,7 @@
18024
18070
  "example": "online",
18025
18071
  "member": "string",
18026
18072
  "name": "Status",
18027
- "required": true,
18073
+ "output_required": true,
18028
18074
  "type": "string",
18029
18075
  "value_allowed_null": true
18030
18076
  },
@@ -18034,17 +18080,17 @@
18034
18080
  "example": "upgrade",
18035
18081
  "member": "string",
18036
18082
  "name": "TaskStatus",
18037
- "required": true,
18083
+ "output_required": true,
18038
18084
  "type": "string",
18039
18085
  "value_allowed_null": true
18040
18086
  },
18041
18087
  {
18042
18088
  "disabled": false,
18043
18089
  "document": "代理组节点信息\n注意:此字段可能返回 null,表示取不到有效值。",
18044
- "example": "",
18090
+ "example": "[{\"ProxyId\": \"proxynode-ehnjshe\",\"Cpu\": \"2\",\"Mem\": \"4000\",\"Status\": \"online\",\"Zone\": \"ap-guangzhou-1\",\"Region\": \"ap-guangzhou\",\"Connection\": \"100\"}]",
18045
18091
  "member": "ProxyNode",
18046
18092
  "name": "ProxyNode",
18047
- "required": true,
18093
+ "output_required": true,
18048
18094
  "type": "list",
18049
18095
  "value_allowed_null": true
18050
18096
  },
@@ -18054,7 +18100,7 @@
18054
18100
  "example": "无",
18055
18101
  "member": "ProxyAddress",
18056
18102
  "name": "ProxyAddress",
18057
- "required": true,
18103
+ "output_required": true,
18058
18104
  "type": "list",
18059
18105
  "value_allowed_null": true
18060
18106
  },
@@ -18064,7 +18110,7 @@
18064
18110
  "example": "10",
18065
18111
  "member": "uint64",
18066
18112
  "name": "ConnectionPoolLimit",
18067
- "required": true,
18113
+ "output_required": true,
18068
18114
  "type": "int",
18069
18115
  "value_allowed_null": true
18070
18116
  },
@@ -18074,7 +18120,7 @@
18074
18120
  "example": "true",
18075
18121
  "member": "bool",
18076
18122
  "name": "SupportCreateProxyAddress",
18077
- "required": true,
18123
+ "output_required": true,
18078
18124
  "type": "bool",
18079
18125
  "value_allowed_null": true
18080
18126
  },
@@ -18084,7 +18130,7 @@
18084
18130
  "example": "20210330",
18085
18131
  "member": "string",
18086
18132
  "name": "SupportUpgradeProxyMysqlVersion",
18087
- "required": true,
18133
+ "output_required": true,
18088
18134
  "type": "string",
18089
18135
  "value_allowed_null": true
18090
18136
  }
@@ -19245,48 +19291,53 @@
19245
19291
  "members": [
19246
19292
  {
19247
19293
  "disabled": false,
19248
- "document": "只读vip状态",
19249
- "example": "",
19294
+ "document": "只读vip状态\n注意:此字段可能返回 null,表示取不到有效值。",
19295
+ "example": "",
19250
19296
  "member": "int64",
19251
19297
  "name": "RoVipStatus",
19252
- "required": true,
19253
- "type": "int"
19298
+ "output_required": true,
19299
+ "type": "int",
19300
+ "value_allowed_null": true
19254
19301
  },
19255
19302
  {
19256
19303
  "disabled": false,
19257
- "document": "只读vip的子网",
19258
- "example": "",
19304
+ "document": "只读vip的子网\n注意:此字段可能返回 null,表示取不到有效值。",
19305
+ "example": "subnet-8i2pdj11",
19259
19306
  "member": "int64",
19260
19307
  "name": "RoSubnetId",
19261
- "required": true,
19262
- "type": "int"
19308
+ "output_required": true,
19309
+ "type": "int",
19310
+ "value_allowed_null": true
19263
19311
  },
19264
19312
  {
19265
19313
  "disabled": false,
19266
- "document": "只读vip的私有网络",
19267
- "example": "",
19314
+ "document": "只读vip的私有网络\n注意:此字段可能返回 null,表示取不到有效值。",
19315
+ "example": "vpc-1dhhbc11",
19268
19316
  "member": "int64",
19269
19317
  "name": "RoVpcId",
19270
- "required": true,
19271
- "type": "int"
19318
+ "output_required": true,
19319
+ "type": "int",
19320
+ "value_allowed_null": true
19272
19321
  },
19273
19322
  {
19274
19323
  "disabled": false,
19275
- "document": "只读vip的端口号",
19276
- "example": "",
19324
+ "document": "只读vip的端口号\n注意:此字段可能返回 null,表示取不到有效值。",
19325
+ "example": "3306",
19277
19326
  "member": "int64",
19278
19327
  "name": "RoVport",
19279
- "required": true,
19280
- "type": "int"
19328
+ "output_required": true,
19329
+ "type": "int",
19330
+ "value_allowed_null": true
19281
19331
  },
19282
19332
  {
19283
19333
  "disabled": false,
19284
- "document": "只读vip",
19285
- "example": "",
19334
+ "document": "只读vip\n注意:此字段可能返回 null,表示取不到有效值。",
19335
+ "example": "10.1.1.1",
19286
19336
  "member": "string",
19287
19337
  "name": "RoVip",
19288
- "required": true,
19289
- "type": "string"
19338
+ "output_required": true,
19339
+ "type": "string",
19340
+ "value_allowed_null": true
19290
19341
  }
19291
19342
  ],
19292
19343
  "usage": "out"
@@ -19297,22 +19348,20 @@
19297
19348
  {
19298
19349
  "disabled": false,
19299
19350
  "document": "RO 实例 ID。",
19300
- "example": "",
19351
+ "example": "cdbro-khe2c111",
19301
19352
  "member": "string",
19302
19353
  "name": "InstanceId",
19303
19354
  "required": true,
19304
- "type": "string",
19305
- "value_allowed_null": false
19355
+ "type": "string"
19306
19356
  },
19307
19357
  {
19308
19358
  "disabled": false,
19309
19359
  "document": "权重值。取值范围为 [0, 100]。",
19310
- "example": "",
19360
+ "example": "5",
19311
19361
  "member": "int64",
19312
19362
  "name": "Weight",
19313
19363
  "required": true,
19314
- "type": "int",
19315
- "value_allowed_null": false
19364
+ "type": "int"
19316
19365
  }
19317
19366
  ],
19318
19367
  "usage": "in"
@@ -19323,9 +19372,10 @@
19323
19372
  {
19324
19373
  "disabled": false,
19325
19374
  "document": "回档前的原数据库名\n注意:此字段可能返回 null,表示取不到有效值。",
19326
- "example": "",
19375
+ "example": "db1",
19327
19376
  "member": "string",
19328
19377
  "name": "DatabaseName",
19378
+ "output_required": true,
19329
19379
  "required": true,
19330
19380
  "type": "string",
19331
19381
  "value_allowed_null": true
@@ -19333,9 +19383,10 @@
19333
19383
  {
19334
19384
  "disabled": false,
19335
19385
  "document": "回档后的新数据库名\n注意:此字段可能返回 null,表示取不到有效值。",
19336
- "example": "",
19386
+ "example": "dbnew",
19337
19387
  "member": "string",
19338
19388
  "name": "NewDatabaseName",
19389
+ "output_required": true,
19339
19390
  "required": true,
19340
19391
  "type": "string",
19341
19392
  "value_allowed_null": true
@@ -19349,9 +19400,10 @@
19349
19400
  {
19350
19401
  "disabled": false,
19351
19402
  "document": "云数据库实例ID\n注意:此字段可能返回 null,表示取不到有效值。",
19352
- "example": "cdb_xxx",
19403
+ "example": "cdb-aeti0q11",
19353
19404
  "member": "string",
19354
19405
  "name": "InstanceId",
19406
+ "output_required": true,
19355
19407
  "required": true,
19356
19408
  "type": "string",
19357
19409
  "value_allowed_null": true
@@ -19359,9 +19411,10 @@
19359
19411
  {
19360
19412
  "disabled": false,
19361
19413
  "document": "回档策略。可选值为:table、db、full;默认值为full。table - 极速回档模式,仅导入所选中表级别的备份和binlog,如有跨表操作,且关联表未被同时选中,将会导致回档失败,该模式下参数Databases必须为空;db - 快速模式,仅导入所选中库级别的备份和binlog,如有跨库操作,且关联库未被同时选中,将会导致回档失败;full - 普通回档模式,将导入整个实例的备份和binlog,速度较慢。",
19362
- "example": "\"\"",
19414
+ "example": "db",
19363
19415
  "member": "string",
19364
19416
  "name": "Strategy",
19417
+ "output_required": true,
19365
19418
  "required": true,
19366
19419
  "type": "string",
19367
19420
  "value_allowed_null": false
@@ -19369,9 +19422,10 @@
19369
19422
  {
19370
19423
  "disabled": false,
19371
19424
  "document": "数据库回档时间,时间格式为:yyyy-mm-dd hh:mm:ss",
19372
- "example": "\"\"",
19425
+ "example": "2024-09-09 16:40:30",
19373
19426
  "member": "string",
19374
19427
  "name": "RollbackTime",
19428
+ "output_required": true,
19375
19429
  "required": true,
19376
19430
  "type": "string",
19377
19431
  "value_allowed_null": false
@@ -19379,9 +19433,10 @@
19379
19433
  {
19380
19434
  "disabled": false,
19381
19435
  "document": "待回档的数据库信息,表示整库回档\n注意:此字段可能返回 null,表示取不到有效值。",
19382
- "example": "",
19436
+ "example": "[{\"DatabaseName\": \"db1\",\"NewDatabaseName\": \"db2\"}]",
19383
19437
  "member": "RollbackDBName",
19384
19438
  "name": "Databases",
19439
+ "output_required": true,
19385
19440
  "required": false,
19386
19441
  "type": "list",
19387
19442
  "value_allowed_null": true
@@ -19389,9 +19444,10 @@
19389
19444
  {
19390
19445
  "disabled": false,
19391
19446
  "document": "待回档的数据库表信息,表示按表回档\n注意:此字段可能返回 null,表示取不到有效值。",
19392
- "example": "",
19447
+ "example": "[{\"Database\": \"db1\",\"Table\": [{\"TableName\": \"andytable1\",\"NewTableName\": \"andytable2\"}]}]",
19393
19448
  "member": "RollbackTables",
19394
19449
  "name": "Tables",
19450
+ "output_required": true,
19395
19451
  "required": false,
19396
19452
  "type": "list",
19397
19453
  "value_allowed_null": true
@@ -19405,9 +19461,10 @@
19405
19461
  {
19406
19462
  "disabled": false,
19407
19463
  "document": "回档前的原数据库表名\n注意:此字段可能返回 null,表示取不到有效值。",
19408
- "example": "",
19464
+ "example": "table1",
19409
19465
  "member": "string",
19410
19466
  "name": "TableName",
19467
+ "output_required": true,
19411
19468
  "required": true,
19412
19469
  "type": "string",
19413
19470
  "value_allowed_null": true
@@ -19415,9 +19472,10 @@
19415
19472
  {
19416
19473
  "disabled": false,
19417
19474
  "document": "回档后的新数据库表名\n注意:此字段可能返回 null,表示取不到有效值。",
19418
- "example": "",
19475
+ "example": "table2",
19419
19476
  "member": "string",
19420
19477
  "name": "NewTableName",
19478
+ "output_required": true,
19421
19479
  "required": true,
19422
19480
  "type": "string",
19423
19481
  "value_allowed_null": true
@@ -19431,9 +19489,10 @@
19431
19489
  {
19432
19490
  "disabled": false,
19433
19491
  "document": "数据库名\n注意:此字段可能返回 null,表示取不到有效值。",
19434
- "example": "",
19492
+ "example": "db1",
19435
19493
  "member": "string",
19436
19494
  "name": "Database",
19495
+ "output_required": true,
19437
19496
  "required": true,
19438
19497
  "type": "string",
19439
19498
  "value_allowed_null": true
@@ -19441,9 +19500,10 @@
19441
19500
  {
19442
19501
  "disabled": false,
19443
19502
  "document": "数据库表详情\n注意:此字段可能返回 null,表示取不到有效值。",
19444
- "example": "",
19503
+ "example": "[{\"TableName\": \"table1\",\"NewTableName\": \"table2\"}]",
19445
19504
  "member": "RollbackTableName",
19446
19505
  "name": "Table",
19506
+ "output_required": true,
19447
19507
  "required": true,
19448
19508
  "type": "list",
19449
19509
  "value_allowed_null": true
@@ -19457,60 +19517,60 @@
19457
19517
  {
19458
19518
  "disabled": false,
19459
19519
  "document": "任务执行信息描述。",
19460
- "example": "",
19520
+ "example": "batch rollback success",
19461
19521
  "member": "string",
19462
19522
  "name": "Info",
19463
- "required": true,
19523
+ "output_required": true,
19464
19524
  "type": "string",
19465
19525
  "value_allowed_null": false
19466
19526
  },
19467
19527
  {
19468
19528
  "disabled": false,
19469
19529
  "document": "任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。",
19470
- "example": "",
19530
+ "example": "SUCCESS",
19471
19531
  "member": "string",
19472
19532
  "name": "Status",
19473
- "required": true,
19533
+ "output_required": true,
19474
19534
  "type": "string",
19475
19535
  "value_allowed_null": false
19476
19536
  },
19477
19537
  {
19478
19538
  "disabled": false,
19479
19539
  "document": "任务执行进度。取值范围为[0, 100]。",
19480
- "example": "",
19540
+ "example": "100",
19481
19541
  "member": "int64",
19482
19542
  "name": "Progress",
19483
- "required": true,
19543
+ "output_required": true,
19484
19544
  "type": "int",
19485
19545
  "value_allowed_null": false
19486
19546
  },
19487
19547
  {
19488
19548
  "disabled": false,
19489
19549
  "document": "任务开始时间。",
19490
- "example": "",
19550
+ "example": "2024-04-22 10:01:23",
19491
19551
  "member": "string",
19492
19552
  "name": "StartTime",
19493
- "required": true,
19553
+ "output_required": true,
19494
19554
  "type": "string",
19495
19555
  "value_allowed_null": false
19496
19556
  },
19497
19557
  {
19498
19558
  "disabled": false,
19499
19559
  "document": "任务结束时间。",
19500
- "example": "",
19560
+ "example": "2024-04-22 10:06:25",
19501
19561
  "member": "string",
19502
19562
  "name": "EndTime",
19503
- "required": true,
19563
+ "output_required": true,
19504
19564
  "type": "string",
19505
19565
  "value_allowed_null": false
19506
19566
  },
19507
19567
  {
19508
19568
  "disabled": false,
19509
19569
  "document": "回档任务详情。\n注意:此字段可能返回 null,表示取不到有效值。",
19510
- "example": "",
19570
+ "example": "[{\"InstanceId\": \"cdb-qwer1234\",\"Strategy\": \"full\",\"RollbackTime\": \"2020-04-22 10:00:57\",\"Databases\": [],\"Tables\": [{\"Table\": [{\"TableName\": \"sbtest1\",\"NewTableName\": \"sbtest1_bak\"},{\"TableName\": \"sbtest2\",\"NewTableName\": \"sbtest2_bak\"}],\"Database\": \"dbtest_bak\"}]}]",
19511
19571
  "member": "RollbackInstancesInfo",
19512
19572
  "name": "Detail",
19513
- "required": true,
19573
+ "output_required": true,
19514
19574
  "type": "list",
19515
19575
  "value_allowed_null": true
19516
19576
  }
@@ -19522,21 +19582,23 @@
19522
19582
  "members": [
19523
19583
  {
19524
19584
  "disabled": false,
19525
- "document": "实例可回档开始时间,时间格式:2016-10-29 01:06:04",
19526
- "example": "",
19585
+ "document": "实例可回档开始时间,时间格式:2016-10-29 01:06:04\n注意:此字段可能返回 null,表示取不到有效值。",
19586
+ "example": "2024-10-29 01:06:04",
19527
19587
  "member": "string",
19528
19588
  "name": "Begin",
19529
- "required": true,
19530
- "type": "string"
19589
+ "output_required": true,
19590
+ "type": "string",
19591
+ "value_allowed_null": true
19531
19592
  },
19532
19593
  {
19533
19594
  "disabled": false,
19534
- "document": "实例可回档结束时间,时间格式:2016-11-02 11:44:47",
19535
- "example": "",
19595
+ "document": "实例可回档结束时间,时间格式:2016-11-02 11:44:47\n注意:此字段可能返回 null,表示取不到有效值。",
19596
+ "example": "2024-10-30 01:06:04",
19536
19597
  "member": "string",
19537
19598
  "name": "End",
19538
- "required": true,
19539
- "type": "string"
19599
+ "output_required": true,
19600
+ "type": "string",
19601
+ "value_allowed_null": true
19540
19602
  }
19541
19603
  ],
19542
19604
  "usage": "out"
@@ -19608,63 +19670,63 @@
19608
19670
  "members": [
19609
19671
  {
19610
19672
  "disabled": false,
19611
- "document": "规则模板ID。\n注意:此字段可能返回 null,表示取不到有效值。",
19673
+ "document": "规则模板ID",
19612
19674
  "example": "cdb-art-8qx2kcr7",
19613
19675
  "member": "string",
19614
19676
  "name": "RuleTemplateId",
19615
19677
  "output_required": false,
19616
19678
  "type": "string",
19617
- "value_allowed_null": true
19679
+ "value_allowed_null": false
19618
19680
  },
19619
19681
  {
19620
19682
  "disabled": false,
19621
- "document": "规则模板名称。\n注意:此字段可能返回 null,表示取不到有效值。",
19622
- "example": "test",
19683
+ "document": "规则模板名称。",
19684
+ "example": "andy",
19623
19685
  "member": "string",
19624
19686
  "name": "RuleTemplateName",
19625
19687
  "output_required": false,
19626
19688
  "type": "string",
19627
- "value_allowed_null": true
19689
+ "value_allowed_null": false
19628
19690
  },
19629
19691
  {
19630
19692
  "disabled": false,
19631
- "document": "规则内容。\n注意:此字段可能返回 null,表示取不到有效值。",
19693
+ "document": "规则内容。",
19632
19694
  "example": "[{\"Type\":\"host\",\"Compare\":\"INC\",\"Value\":[\"100.122.76.176\"]}]",
19633
19695
  "member": "RuleFilters",
19634
19696
  "name": "RuleFilters",
19635
19697
  "output_required": false,
19636
19698
  "type": "list",
19637
- "value_allowed_null": true
19699
+ "value_allowed_null": false
19638
19700
  },
19639
19701
  {
19640
19702
  "disabled": false,
19641
- "document": "告警等级。1-低风险,2-中风险,3-高风险。\n注意:此字段可能返回 null,表示取不到有效值。",
19703
+ "document": "告警等级。1-低风险,2-中风险,3-高风险。",
19642
19704
  "example": "1",
19643
19705
  "member": "int64",
19644
19706
  "name": "AlarmLevel",
19645
19707
  "output_required": false,
19646
19708
  "type": "int",
19647
- "value_allowed_null": true
19709
+ "value_allowed_null": false
19648
19710
  },
19649
19711
  {
19650
19712
  "disabled": false,
19651
- "document": "告警策略。0-不告警,1-告警。\n注意:此字段可能返回 null,表示取不到有效值。",
19713
+ "document": "告警策略。0-不告警,1-告警。",
19652
19714
  "example": "0",
19653
19715
  "member": "int64",
19654
19716
  "name": "AlarmPolicy",
19655
19717
  "output_required": false,
19656
19718
  "type": "int",
19657
- "value_allowed_null": true
19719
+ "value_allowed_null": false
19658
19720
  },
19659
19721
  {
19660
19722
  "disabled": false,
19661
- "document": "规则描述。\n注意:此字段可能返回 null,表示取不到有效值。",
19723
+ "document": "规则描述。",
19662
19724
  "example": "这不单单是一个的描述",
19663
19725
  "member": "string",
19664
19726
  "name": "Description",
19665
19727
  "output_required": false,
19666
19728
  "type": "string",
19667
- "value_allowed_null": true
19729
+ "value_allowed_null": false
19668
19730
  }
19669
19731
  ],
19670
19732
  "usage": "out"
@@ -19674,63 +19736,63 @@
19674
19736
  "members": [
19675
19737
  {
19676
19738
  "disabled": false,
19677
- "document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
19678
- "example": "",
19739
+ "document": "任务ID",
19740
+ "example": "172",
19679
19741
  "member": "int64",
19680
19742
  "name": "TaskId",
19681
19743
  "output_required": false,
19682
19744
  "type": "int",
19683
- "value_allowed_null": true
19745
+ "value_allowed_null": false
19684
19746
  },
19685
19747
  {
19686
19748
  "disabled": false,
19687
- "document": "修改前规则模板的详情。\n注意:此字段可能返回 null,表示取不到有效值。",
19688
- "example": "",
19749
+ "document": "修改前规则模板的详情。",
19750
+ "example": "[{\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"andy\",\"RuleFilters\": [{\"Type\": \"sqltype\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}],\"AlarmLevel\": \"1\",\"AlarmPolicy\": \"1\",\"Description\": \"触发推送报告\"}]",
19689
19751
  "member": "RuleTemplateInfo",
19690
19752
  "name": "ModifyBeforeInfo",
19691
19753
  "output_required": false,
19692
19754
  "type": "object",
19693
- "value_allowed_null": true
19755
+ "value_allowed_null": false
19694
19756
  },
19695
19757
  {
19696
19758
  "disabled": false,
19697
- "document": "修改后规则模板的详情。\n注意:此字段可能返回 null,表示取不到有效值。",
19698
- "example": "",
19759
+ "document": "修改后规则模板的详情。",
19760
+ "example": "[{\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"andy\",\"RuleFilters\": [{\"Type\": \"sqltype\",\"Compare\": \"INC\",\"Value\": \"logout\"}],\"AlarmLevel\": \"1\",\"AlarmPolicy\": \"1\",\"Description\": \"触发推送报告\"}]",
19699
19761
  "member": "RuleTemplateInfo",
19700
19762
  "name": "ModifyAfterInfo",
19701
19763
  "output_required": false,
19702
19764
  "type": "object",
19703
- "value_allowed_null": true
19765
+ "value_allowed_null": false
19704
19766
  },
19705
19767
  {
19706
19768
  "disabled": false,
19707
- "document": "影响的实例。\n注意:此字段可能返回 null,表示取不到有效值。",
19708
- "example": "",
19769
+ "document": "影响的实例。",
19770
+ "example": "[\"cdb-3gj2ya11\",\"cdb-3gj2ya22\"]",
19709
19771
  "member": "string",
19710
19772
  "name": "AffectedInstances",
19711
19773
  "output_required": false,
19712
19774
  "type": "list",
19713
- "value_allowed_null": true
19775
+ "value_allowed_null": false
19714
19776
  },
19715
19777
  {
19716
19778
  "disabled": false,
19717
- "document": "操作人,账号uin。\n注意:此字段可能返回 null,表示取不到有效值。",
19718
- "example": "",
19779
+ "document": "操作人,账号uin",
19780
+ "example": "1000***3726",
19719
19781
  "member": "string",
19720
19782
  "name": "Operator",
19721
19783
  "output_required": false,
19722
19784
  "type": "string",
19723
- "value_allowed_null": true
19785
+ "value_allowed_null": false
19724
19786
  },
19725
19787
  {
19726
19788
  "disabled": false,
19727
- "document": "变更的时间。\n注意:此字段可能返回 null,表示取不到有效值。",
19728
- "example": "",
19789
+ "document": "变更的时间。",
19790
+ "example": "2024-03-17 02:10:37",
19729
19791
  "member": "string",
19730
19792
  "name": "UpdateTime",
19731
19793
  "output_required": false,
19732
19794
  "type": "string",
19733
- "value_allowed_null": true
19795
+ "value_allowed_null": false
19734
19796
  }
19735
19797
  ],
19736
19798
  "usage": "out"
@@ -19740,66 +19802,73 @@
19740
19802
  "members": [
19741
19803
  {
19742
19804
  "disabled": false,
19743
- "document": "项目ID",
19744
- "example": "",
19805
+ "document": "项目ID\n注意:此字段可能返回 null,表示取不到有效值。",
19806
+ "example": "0",
19745
19807
  "member": "int64",
19746
19808
  "name": "ProjectId",
19747
- "required": true,
19748
- "type": "int"
19809
+ "output_required": true,
19810
+ "type": "int",
19811
+ "value_allowed_null": true
19749
19812
  },
19750
19813
  {
19751
19814
  "disabled": false,
19752
- "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss",
19753
- "example": "",
19815
+ "document": "创建时间,时间格式:yyyy-mm-dd hh:mm:ss\n注意:此字段可能返回 null,表示取不到有效值。",
19816
+ "example": "2024-04-13 15:00:06",
19754
19817
  "member": "string",
19755
19818
  "name": "CreateTime",
19756
- "required": true,
19757
- "type": "string"
19819
+ "output_required": true,
19820
+ "type": "string",
19821
+ "value_allowed_null": true
19758
19822
  },
19759
19823
  {
19760
19824
  "disabled": false,
19761
- "document": "入站规则",
19762
- "example": "",
19825
+ "document": "入站规则\n注意:此字段可能返回 null,表示取不到有效值。",
19826
+ "example": "[]",
19763
19827
  "member": "Inbound",
19764
19828
  "name": "Inbound",
19765
- "required": true,
19766
- "type": "list"
19829
+ "output_required": true,
19830
+ "type": "list",
19831
+ "value_allowed_null": true
19767
19832
  },
19768
19833
  {
19769
19834
  "disabled": false,
19770
- "document": "出站规则",
19771
- "example": "",
19835
+ "document": "出站规则\n注意:此字段可能返回 null,表示取不到有效值。",
19836
+ "example": "[]",
19772
19837
  "member": "Outbound",
19773
19838
  "name": "Outbound",
19774
- "required": true,
19775
- "type": "list"
19839
+ "output_required": true,
19840
+ "type": "list",
19841
+ "value_allowed_null": true
19776
19842
  },
19777
19843
  {
19778
19844
  "disabled": false,
19779
- "document": "安全组ID",
19780
- "example": "",
19845
+ "document": "安全组ID\n注意:此字段可能返回 null,表示取不到有效值。",
19846
+ "example": "sg-**",
19781
19847
  "member": "string",
19782
19848
  "name": "SecurityGroupId",
19783
- "required": true,
19784
- "type": "string"
19849
+ "output_required": true,
19850
+ "type": "string",
19851
+ "value_allowed_null": true
19785
19852
  },
19786
19853
  {
19787
19854
  "disabled": false,
19788
- "document": "安全组名称",
19789
- "example": "",
19855
+ "document": "安全组名称\n注意:此字段可能返回 null,表示取不到有效值。",
19856
+ "example": "cdb",
19790
19857
  "member": "string",
19791
19858
  "name": "SecurityGroupName",
19792
- "required": true,
19793
- "type": "string"
19859
+ "output_required": true,
19860
+ "type": "string",
19861
+ "value_allowed_null": true
19794
19862
  },
19795
19863
  {
19796
19864
  "disabled": false,
19797
- "document": "安全组备注",
19798
- "example": "",
19865
+ "document": "安全组备注\n注意:此字段可能返回 null,表示取不到有效值。",
19866
+ "example": "cdb安全组",
19799
19867
  "member": "string",
19800
19868
  "name": "SecurityGroupRemark",
19801
- "required": true,
19802
- "type": "string"
19869
+ "output_required": true,
19870
+ "type": "string",
19871
+ "value_allowed_null": true
19803
19872
  }
19804
19873
  ],
19805
19874
  "usage": "out"
@@ -19809,21 +19878,23 @@
19809
19878
  "members": [
19810
19879
  {
19811
19880
  "disabled": false,
19812
- "document": "从库复制方式,可能的返回值:aysnc-异步,semisync-半同步",
19813
- "example": "",
19881
+ "document": "从库复制方式,可能的返回值:aysnc-异步,semisync-半同步\n注意:此字段可能返回 null,表示取不到有效值。",
19882
+ "example": "aysnc",
19814
19883
  "member": "string",
19815
19884
  "name": "ReplicationMode",
19816
- "required": true,
19817
- "type": "string"
19885
+ "output_required": true,
19886
+ "type": "string",
19887
+ "value_allowed_null": true
19818
19888
  },
19819
19889
  {
19820
19890
  "disabled": false,
19821
- "document": "从库可用区的正式名称,如ap-shanghai-1",
19822
- "example": "",
19891
+ "document": "从库可用区的正式名称,如ap-shanghai-1\n注意:此字段可能返回 null,表示取不到有效值。",
19892
+ "example": "ap-shanghai-1",
19823
19893
  "member": "string",
19824
19894
  "name": "Zone",
19825
- "required": true,
19826
- "type": "string"
19895
+ "output_required": true,
19896
+ "type": "string",
19897
+ "value_allowed_null": true
19827
19898
  }
19828
19899
  ],
19829
19900
  "usage": "out"
@@ -19834,20 +19905,20 @@
19834
19905
  {
19835
19906
  "disabled": false,
19836
19907
  "document": "第一备机信息",
19837
- "example": "",
19908
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.1.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
19838
19909
  "member": "SlaveInstanceInfo",
19839
19910
  "name": "First",
19840
- "required": true,
19911
+ "output_required": true,
19841
19912
  "type": "object",
19842
19913
  "value_allowed_null": false
19843
19914
  },
19844
19915
  {
19845
19916
  "disabled": false,
19846
19917
  "document": "第二备机信息\n注意:此字段可能返回 null,表示取不到有效值。",
19847
- "example": "",
19918
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.0.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
19848
19919
  "member": "SlaveInstanceInfo",
19849
19920
  "name": "Second",
19850
- "required": false,
19921
+ "output_required": true,
19851
19922
  "type": "object",
19852
19923
  "value_allowed_null": true
19853
19924
  }
@@ -19906,60 +19977,60 @@
19906
19977
  {
19907
19978
  "disabled": false,
19908
19979
  "document": "备份文件名",
19909
- "example": "",
19980
+ "example": "ivansqwutestdr_slowlog_20170425.log",
19910
19981
  "member": "string",
19911
19982
  "name": "Name",
19912
- "required": true,
19983
+ "output_required": true,
19913
19984
  "type": "string",
19914
19985
  "value_allowed_null": false
19915
19986
  },
19916
19987
  {
19917
19988
  "disabled": false,
19918
19989
  "document": "备份文件大小,单位:Byte",
19919
- "example": "",
19990
+ "example": "1",
19920
19991
  "member": "int64",
19921
19992
  "name": "Size",
19922
- "required": true,
19993
+ "output_required": true,
19923
19994
  "type": "int",
19924
19995
  "value_allowed_null": false
19925
19996
  },
19926
19997
  {
19927
19998
  "disabled": false,
19928
19999
  "document": "备份快照时间,时间格式:2016-03-17 02:10:37",
19929
- "example": "",
20000
+ "example": "2024-04-26 00:00:08",
19930
20001
  "member": "string",
19931
20002
  "name": "Date",
19932
- "required": true,
20003
+ "output_required": true,
19933
20004
  "type": "string",
19934
20005
  "value_allowed_null": false
19935
20006
  },
19936
20007
  {
19937
20008
  "disabled": false,
19938
20009
  "document": "内网下载地址",
19939
- "example": "",
20010
+ "example": "http://gz.***",
19940
20011
  "member": "string",
19941
20012
  "name": "IntranetUrl",
19942
- "required": true,
20013
+ "output_required": true,
19943
20014
  "type": "string",
19944
20015
  "value_allowed_null": false
19945
20016
  },
19946
20017
  {
19947
20018
  "disabled": false,
19948
20019
  "document": "外网下载地址",
19949
- "example": "",
20020
+ "example": "http://gz.***",
19950
20021
  "member": "string",
19951
20022
  "name": "InternetUrl",
19952
- "required": true,
20023
+ "output_required": true,
19953
20024
  "type": "string",
19954
20025
  "value_allowed_null": false
19955
20026
  },
19956
20027
  {
19957
20028
  "disabled": false,
19958
20029
  "document": "日志具体类型,可能的值:slowlog - 慢日志",
19959
- "example": "",
20030
+ "example": "slowlog",
19960
20031
  "member": "string",
19961
20032
  "name": "Type",
19962
- "required": true,
20033
+ "output_required": true,
19963
20034
  "type": "string",
19964
20035
  "value_allowed_null": false
19965
20036
  }
@@ -19975,7 +20046,7 @@
19975
20046
  "example": "1637894492",
19976
20047
  "member": "uint64",
19977
20048
  "name": "Timestamp",
19978
- "required": true,
20049
+ "output_required": true,
19979
20050
  "type": "int",
19980
20051
  "value_allowed_null": true
19981
20052
  },
@@ -19985,7 +20056,7 @@
19985
20056
  "example": "0.1",
19986
20057
  "member": "float",
19987
20058
  "name": "QueryTime",
19988
- "required": true,
20059
+ "output_required": true,
19989
20060
  "type": "float",
19990
20061
  "value_allowed_null": true
19991
20062
  },
@@ -19995,7 +20066,7 @@
19995
20066
  "example": "select * from test",
19996
20067
  "member": "string",
19997
20068
  "name": "SqlText",
19998
- "required": true,
20069
+ "output_required": true,
19999
20070
  "type": "string",
20000
20071
  "value_allowed_null": true
20001
20072
  },
@@ -20005,7 +20076,7 @@
20005
20076
  "example": "127.0.0.1",
20006
20077
  "member": "string",
20007
20078
  "name": "UserHost",
20008
- "required": true,
20079
+ "output_required": true,
20009
20080
  "type": "string",
20010
20081
  "value_allowed_null": true
20011
20082
  },
@@ -20015,7 +20086,7 @@
20015
20086
  "example": "test_user",
20016
20087
  "member": "string",
20017
20088
  "name": "UserName",
20018
- "required": true,
20089
+ "output_required": true,
20019
20090
  "type": "string",
20020
20091
  "value_allowed_null": true
20021
20092
  },
@@ -20025,7 +20096,7 @@
20025
20096
  "example": "test_db",
20026
20097
  "member": "string",
20027
20098
  "name": "Database",
20028
- "required": true,
20099
+ "output_required": true,
20029
20100
  "type": "string",
20030
20101
  "value_allowed_null": true
20031
20102
  },
@@ -20035,17 +20106,17 @@
20035
20106
  "example": "0.11",
20036
20107
  "member": "float",
20037
20108
  "name": "LockTime",
20038
- "required": true,
20109
+ "output_required": true,
20039
20110
  "type": "float",
20040
20111
  "value_allowed_null": true
20041
20112
  },
20042
20113
  {
20043
20114
  "disabled": false,
20044
20115
  "document": "扫描行数。\n注意:此字段可能返回 null,表示取不到有效值。",
20045
- "example": "12",
20116
+ "example": "100",
20046
20117
  "member": "int64",
20047
20118
  "name": "RowsExamined",
20048
- "required": true,
20119
+ "output_required": true,
20049
20120
  "type": "int",
20050
20121
  "value_allowed_null": true
20051
20122
  },
@@ -20055,7 +20126,7 @@
20055
20126
  "example": "1",
20056
20127
  "member": "int64",
20057
20128
  "name": "RowsSent",
20058
- "required": true,
20129
+ "output_required": true,
20059
20130
  "type": "int",
20060
20131
  "value_allowed_null": true
20061
20132
  },
@@ -20065,7 +20136,7 @@
20065
20136
  "example": "select * from test",
20066
20137
  "member": "string",
20067
20138
  "name": "SqlTemplate",
20068
- "required": true,
20139
+ "output_required": true,
20069
20140
  "type": "string",
20070
20141
  "value_allowed_null": true
20071
20142
  },
@@ -20075,7 +20146,7 @@
20075
20146
  "example": "2casbjhk1ty",
20076
20147
  "member": "string",
20077
20148
  "name": "Md5",
20078
- "required": true,
20149
+ "output_required": true,
20079
20150
  "type": "string",
20080
20151
  "value_allowed_null": true
20081
20152
  }
@@ -20088,60 +20159,60 @@
20088
20159
  {
20089
20160
  "disabled": false,
20090
20161
  "document": "上传时间",
20091
- "example": "",
20162
+ "example": "2024-11-28 15:16:13",
20092
20163
  "member": "datetime",
20093
20164
  "name": "UploadTime",
20094
- "required": true,
20165
+ "output_required": true,
20095
20166
  "type": "string",
20096
20167
  "value_allowed_null": false
20097
20168
  },
20098
20169
  {
20099
20170
  "disabled": false,
20100
20171
  "document": "上传进度",
20101
- "example": "",
20172
+ "example": "{\"AllSliceNum\": 5,\"CompleteNum\": 3}",
20102
20173
  "member": "UploadInfo",
20103
20174
  "name": "UploadInfo",
20104
- "required": true,
20175
+ "output_required": true,
20105
20176
  "type": "object",
20106
20177
  "value_allowed_null": false
20107
20178
  },
20108
20179
  {
20109
20180
  "disabled": false,
20110
20181
  "document": "文件名",
20111
- "example": "",
20182
+ "example": "andy.sql",
20112
20183
  "member": "string",
20113
20184
  "name": "FileName",
20114
- "required": true,
20185
+ "output_required": true,
20115
20186
  "type": "string",
20116
20187
  "value_allowed_null": false
20117
20188
  },
20118
20189
  {
20119
20190
  "disabled": false,
20120
20191
  "document": "文件大小,单位为Bytes",
20121
- "example": "",
20192
+ "example": "8581633",
20122
20193
  "member": "int64",
20123
20194
  "name": "FileSize",
20124
- "required": true,
20195
+ "output_required": true,
20125
20196
  "type": "int",
20126
20197
  "value_allowed_null": false
20127
20198
  },
20128
20199
  {
20129
20200
  "disabled": false,
20130
20201
  "document": "上传是否完成标志,可选值:0 - 未完成,1 - 已完成",
20131
- "example": "",
20202
+ "example": "0",
20132
20203
  "member": "int64",
20133
20204
  "name": "IsUploadFinished",
20134
- "required": true,
20205
+ "output_required": true,
20135
20206
  "type": "int",
20136
20207
  "value_allowed_null": false
20137
20208
  },
20138
20209
  {
20139
20210
  "disabled": false,
20140
20211
  "document": "文件ID",
20141
- "example": "",
20212
+ "example": "5596d7433fe211da4b487228db4e7c57",
20142
20213
  "member": "string",
20143
20214
  "name": "FileId",
20144
- "required": true,
20215
+ "output_required": true,
20145
20216
  "type": "string",
20146
20217
  "value_allowed_null": false
20147
20218
  }
@@ -20770,20 +20841,20 @@
20770
20841
  {
20771
20842
  "disabled": false,
20772
20843
  "document": "标签键",
20773
- "example": "",
20844
+ "example": "created-by",
20774
20845
  "member": "string",
20775
20846
  "name": "TagKey",
20776
- "required": true,
20847
+ "output_required": true,
20777
20848
  "type": "string",
20778
20849
  "value_allowed_null": false
20779
20850
  },
20780
20851
  {
20781
20852
  "disabled": false,
20782
20853
  "document": "标签值",
20783
- "example": "",
20854
+ "example": "andy",
20784
20855
  "member": "string",
20785
20856
  "name": "TagValue",
20786
- "required": true,
20857
+ "output_required": true,
20787
20858
  "type": "string",
20788
20859
  "value_allowed_null": false
20789
20860
  }
@@ -20796,20 +20867,20 @@
20796
20867
  {
20797
20868
  "disabled": false,
20798
20869
  "document": "实例Id",
20799
- "example": "",
20870
+ "example": "cdb-uns231ns",
20800
20871
  "member": "string",
20801
20872
  "name": "InstanceId",
20802
- "required": true,
20873
+ "output_required": true,
20803
20874
  "type": "string",
20804
20875
  "value_allowed_null": false
20805
20876
  },
20806
20877
  {
20807
20878
  "disabled": false,
20808
20879
  "document": "标签信息",
20809
- "example": "",
20880
+ "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]",
20810
20881
  "member": "TagInfoUnit",
20811
20882
  "name": "Tags",
20812
- "required": true,
20883
+ "output_required": true,
20813
20884
  "type": "list",
20814
20885
  "value_allowed_null": false
20815
20886
  }
@@ -21336,25 +21407,25 @@
21336
21407
  "members": [
21337
21408
  {
21338
21409
  "disabled": false,
21339
- "document": "参数名称\n注意:此字段可能返回 null,表示取不到有效值。",
21410
+ "document": "参数名称",
21340
21411
  "example": "default_collation_for_utf8mb4",
21341
21412
  "member": "string",
21342
21413
  "name": "Name",
21343
21414
  "output_required": false,
21344
21415
  "required": false,
21345
21416
  "type": "string",
21346
- "value_allowed_null": true
21417
+ "value_allowed_null": false
21347
21418
  },
21348
21419
  {
21349
21420
  "disabled": false,
21350
- "document": "参数值\n注意:此字段可能返回 null,表示取不到有效值。",
21421
+ "document": "参数值",
21351
21422
  "example": "utf8mb4_0900_ai_ci",
21352
21423
  "member": "string",
21353
21424
  "name": "Value",
21354
21425
  "output_required": false,
21355
21426
  "required": false,
21356
21427
  "type": "string",
21357
- "value_allowed_null": true
21428
+ "value_allowed_null": false
21358
21429
  }
21359
21430
  ],
21360
21431
  "usage": "both"
@@ -21364,21 +21435,23 @@
21364
21435
  "members": [
21365
21436
  {
21366
21437
  "disabled": false,
21367
- "document": "文件所有分片数",
21368
- "example": "",
21438
+ "document": "文件所有分片数\n注意:此字段可能返回 null,表示取不到有效值。",
21439
+ "example": "100",
21369
21440
  "member": "int64",
21370
21441
  "name": "AllSliceNum",
21371
- "required": true,
21372
- "type": "int"
21442
+ "output_required": true,
21443
+ "type": "int",
21444
+ "value_allowed_null": true
21373
21445
  },
21374
21446
  {
21375
21447
  "disabled": false,
21376
- "document": "已完成分片数",
21377
- "example": "",
21448
+ "document": "已完成分片数\n注意:此字段可能返回 null,表示取不到有效值。",
21449
+ "example": "50",
21378
21450
  "member": "int64",
21379
21451
  "name": "CompleteNum",
21380
- "required": true,
21381
- "type": "int"
21452
+ "output_required": true,
21453
+ "type": "int",
21454
+ "value_allowed_null": true
21382
21455
  }
21383
21456
  ],
21384
21457
  "usage": "out"
@@ -21434,39 +21507,47 @@
21434
21507
  "members": [
21435
21508
  {
21436
21509
  "disabled": false,
21437
- "document": "可用区部署方式,可能的值为:0-单可用区;1-多可用区",
21438
- "example": "",
21510
+ "document": "可用区部署方式,可能的值为:0-单可用区;1-多可用区\n注意:此字段可能返回 null,表示取不到有效值。",
21511
+ "example": "[0,1]",
21439
21512
  "member": "int64",
21440
21513
  "name": "DeployMode",
21514
+ "output_required": true,
21441
21515
  "required": true,
21442
- "type": "list"
21516
+ "type": "list",
21517
+ "value_allowed_null": true
21443
21518
  },
21444
21519
  {
21445
21520
  "disabled": false,
21446
- "document": "主实例所在的可用区",
21447
- "example": "",
21521
+ "document": "主实例所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。",
21522
+ "example": "[\"ap-shanghai-1\"]",
21448
21523
  "member": "string",
21449
21524
  "name": "MasterZone",
21525
+ "output_required": true,
21450
21526
  "required": true,
21451
- "type": "list"
21527
+ "type": "list",
21528
+ "value_allowed_null": true
21452
21529
  },
21453
21530
  {
21454
21531
  "disabled": false,
21455
- "document": "实例为多可用区部署时,备库1所在的可用区",
21456
- "example": "",
21532
+ "document": "实例为多可用区部署时,备库1所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。",
21533
+ "example": "[\"ap-shanghai-2\"]",
21457
21534
  "member": "string",
21458
21535
  "name": "SlaveZone",
21536
+ "output_required": true,
21459
21537
  "required": true,
21460
- "type": "list"
21538
+ "type": "list",
21539
+ "value_allowed_null": true
21461
21540
  },
21462
21541
  {
21463
21542
  "disabled": false,
21464
- "document": "实例为多可用区部署时,备库2所在的可用区",
21465
- "example": "",
21543
+ "document": "实例为多可用区部署时,备库2所在的可用区\n注意:此字段可能返回 null,表示取不到有效值。",
21544
+ "example": "[\"ap-shanghai-2\"]",
21466
21545
  "member": "string",
21467
21546
  "name": "BackupZone",
21547
+ "output_required": true,
21468
21548
  "required": true,
21469
- "type": "list"
21549
+ "type": "list",
21550
+ "value_allowed_null": true
21470
21551
  }
21471
21552
  ],
21472
21553
  "usage": "both"