tccli-intl-en 3.1.13.1__py2.py3-none-any.whl → 3.1.39.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/advisor/advisor_client.py +56 -0
  4. tccli/services/advisor/v20200721/api.json +34 -0
  5. tccli/services/advisor/v20200721/examples.json +8 -0
  6. tccli/services/autoscaling/v20180419/api.json +41 -13
  7. tccli/services/billing/billing_client.py +172 -4
  8. tccli/services/billing/v20180709/api.json +332 -1
  9. tccli/services/billing/v20180709/examples.json +24 -0
  10. tccli/services/ccc/v20200210/api.json +71 -26
  11. tccli/services/cdb/cdb_client.py +1128 -288
  12. tccli/services/cdb/v20170320/api.json +2166 -335
  13. tccli/services/cdb/v20170320/examples.json +126 -6
  14. tccli/services/cdn/v20180606/api.json +22 -22
  15. tccli/services/cdn/v20180606/examples.json +1 -1
  16. tccli/services/ckafka/ckafka_client.py +120 -8
  17. tccli/services/ckafka/v20190819/api.json +525 -180
  18. tccli/services/ckafka/v20190819/examples.json +30 -20
  19. tccli/services/clb/v20180317/api.json +87 -87
  20. tccli/services/csip/csip_client.py +392 -0
  21. tccli/services/csip/v20221121/api.json +2050 -284
  22. tccli/services/csip/v20221121/examples.json +56 -0
  23. tccli/services/cvm/v20170312/api.json +20 -20
  24. tccli/services/cvm/v20170312/examples.json +8 -8
  25. tccli/services/emr/v20190103/api.json +6 -6
  26. tccli/services/faceid/v20180301/api.json +102 -52
  27. tccli/services/faceid/v20180301/examples.json +3 -9
  28. tccli/services/hunyuan/hunyuan_client.py +448 -0
  29. tccli/services/hunyuan/v20230901/api.json +879 -18
  30. tccli/services/hunyuan/v20230901/examples.json +64 -0
  31. tccli/services/lighthouse/lighthouse_client.py +360 -24
  32. tccli/services/lighthouse/v20200324/api.json +488 -0
  33. tccli/services/lighthouse/v20200324/examples.json +54 -0
  34. tccli/services/lkeap/v20240522/api.json +36 -0
  35. tccli/services/lkeap/v20240522/examples.json +1 -1
  36. tccli/services/mdl/v20200326/api.json +309 -38
  37. tccli/services/mdp/v20200527/api.json +191 -28
  38. tccli/services/mongodb/v20190725/api.json +39 -39
  39. tccli/services/monitor/v20180724/api.json +5 -5
  40. tccli/services/mps/mps_client.py +341 -61
  41. tccli/services/mps/v20190612/api.json +890 -31
  42. tccli/services/mps/v20190612/examples.json +40 -0
  43. tccli/services/mqtt/__init__.py +4 -0
  44. tccli/services/mqtt/mqtt_client.py +1610 -0
  45. tccli/services/mqtt/v20240516/api.json +3057 -0
  46. tccli/services/mqtt/v20240516/examples.json +213 -0
  47. tccli/services/ocr/v20181119/api.json +23 -3
  48. tccli/services/ocr/v20181119/examples.json +6 -6
  49. tccli/services/redis/v20180412/api.json +12 -12
  50. tccli/services/ses/ses_client.py +348 -12
  51. tccli/services/ses/v20201002/api.json +1197 -256
  52. tccli/services/ses/v20201002/examples.json +78 -24
  53. tccli/services/tcsas/tcsas_client.py +2281 -209
  54. tccli/services/tcsas/v20250106/api.json +8410 -3423
  55. tccli/services/tcsas/v20250106/examples.json +308 -12
  56. tccli/services/tdmq/v20200217/api.json +4 -4
  57. tccli/services/teo/v20220901/api.json +10 -10
  58. tccli/services/tke/tke_client.py +168 -0
  59. tccli/services/tke/v20180525/api.json +227 -0
  60. tccli/services/tke/v20180525/examples.json +24 -0
  61. tccli/services/trocket/v20230308/api.json +96 -96
  62. tccli/services/trtc/v20190722/api.json +212 -144
  63. tccli/services/trtc/v20190722/examples.json +7 -7
  64. tccli/services/vod/v20180717/api.json +2929 -296
  65. tccli/services/vod/v20180717/examples.json +40 -6
  66. tccli/services/vod/vod_client.py +280 -0
  67. tccli/services/vpc/v20170312/api.json +80 -13
  68. tccli/services/vpc/v20170312/examples.json +17 -9
  69. tccli/services/vpc/vpc_client.py +64 -8
  70. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/METADATA +2 -2
  71. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/RECORD +75 -71
  72. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/WHEEL +1 -1
  73. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/LICENSE +0 -0
  74. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/entry_points.txt +0 -0
  75. {tccli_intl_en-3.1.13.1.dist-info → tccli_intl_en-3.1.39.1.dist-info}/top_level.txt +0 -0
@@ -42,6 +42,13 @@
42
42
  "output": "BalanceRoGroupLoadResponse",
43
43
  "status": "online"
44
44
  },
45
+ "CloseAuditService": {
46
+ "document": "This API is used to disable the audit service for an instance.",
47
+ "input": "CloseAuditServiceRequest",
48
+ "name": "Disables the audit service for an instance",
49
+ "output": "CloseAuditServiceResponse",
50
+ "status": "online"
51
+ },
45
52
  "CloseCDBProxy": {
46
53
  "document": "This API is used to disable database proxy.",
47
54
  "input": "CloseCDBProxyRequest",
@@ -70,6 +77,13 @@
70
77
  "output": "CreateAccountsResponse",
71
78
  "status": "online"
72
79
  },
80
+ "CreateAuditLogFile": {
81
+ "document": "This API is used to create an audit log file for a TencentDB instance.",
82
+ "input": "CreateAuditLogFileRequest",
83
+ "name": "Creates an audit log file",
84
+ "output": "CreateAuditLogFileResponse",
85
+ "status": "online"
86
+ },
73
87
  "CreateAuditPolicy": {
74
88
  "document": "This API is used to create an audit policy for a TencentDB instance by associating an audit rule with the TencentDB instance.",
75
89
  "input": "CreateAuditPolicyRequest",
@@ -77,6 +91,13 @@
77
91
  "output": "CreateAuditPolicyResponse",
78
92
  "status": "online"
79
93
  },
94
+ "CreateAuditRuleTemplate": {
95
+ "document": "This API is used to create an audit rule template.",
96
+ "input": "CreateAuditRuleTemplateRequest",
97
+ "name": "Creates an audit rule template",
98
+ "output": "CreateAuditRuleTemplateResponse",
99
+ "status": "online"
100
+ },
80
101
  "CreateBackup": {
81
102
  "document": "This API (CreateBackup) is used to create a TencentDB instance backup.",
82
103
  "input": "CreateBackupRequest",
@@ -147,6 +168,13 @@
147
168
  "output": "CreateRoInstanceIpResponse",
148
169
  "status": "online"
149
170
  },
171
+ "CreateRotationPassword": {
172
+ "document": "This API is used to enable password rotation.",
173
+ "input": "CreateRotationPasswordRequest",
174
+ "name": "Enabling Password Rotation",
175
+ "output": "CreateRotationPasswordResponse",
176
+ "status": "online"
177
+ },
150
178
  "DeleteAccounts": {
151
179
  "document": "This API (DeleteAccounts) is used to delete TencentDB accounts.",
152
180
  "input": "DeleteAccountsRequest",
@@ -154,6 +182,27 @@
154
182
  "output": "DeleteAccountsResponse",
155
183
  "status": "online"
156
184
  },
185
+ "DeleteAuditLogFile": {
186
+ "document": "This API is used to delete an audit log file of a TencentDB instance.",
187
+ "input": "DeleteAuditLogFileRequest",
188
+ "name": "Deletes an audit log file",
189
+ "output": "DeleteAuditLogFileResponse",
190
+ "status": "online"
191
+ },
192
+ "DeleteAuditPolicy": {
193
+ "document": "This API is used to delete an audit policy.",
194
+ "input": "DeleteAuditPolicyRequest",
195
+ "name": "Deletes an audit policy",
196
+ "output": "DeleteAuditPolicyResponse",
197
+ "status": "online"
198
+ },
199
+ "DeleteAuditRuleTemplates": {
200
+ "document": "This API is used to delete audit rule templates.",
201
+ "input": "DeleteAuditRuleTemplatesRequest",
202
+ "name": "Deletes audit rule templates",
203
+ "output": "DeleteAuditRuleTemplatesResponse",
204
+ "status": "online"
205
+ },
157
206
  "DeleteBackup": {
158
207
  "document": "This API is used to delete a database backup. It can only delete manually initiated backups.",
159
208
  "input": "DeleteBackupRequest",
@@ -196,6 +245,27 @@
196
245
  "output": "DescribeAsyncRequestInfoResponse",
197
246
  "status": "online"
198
247
  },
248
+ "DescribeAuditConfig": {
249
+ "document": "This API is used to query the service configurations for a TencentDB audit policy, including the audit log retention period.",
250
+ "input": "DescribeAuditConfigRequest",
251
+ "name": "Queries audit service configurations",
252
+ "output": "DescribeAuditConfigResponse",
253
+ "status": "online"
254
+ },
255
+ "DescribeAuditInstanceList": {
256
+ "document": "This API is used to obtain the list of audit instances.",
257
+ "input": "DescribeAuditInstanceListRequest",
258
+ "name": "Obtains the list of audit instances",
259
+ "output": "DescribeAuditInstanceListResponse",
260
+ "status": "online"
261
+ },
262
+ "DescribeAuditLogFiles": {
263
+ "document": "This API is used to query the audit log files of a TencentDB instance.",
264
+ "input": "DescribeAuditLogFilesRequest",
265
+ "name": "Queries audit log files",
266
+ "output": "DescribeAuditLogFilesResponse",
267
+ "status": "online"
268
+ },
199
269
  "DescribeAuditLogs": {
200
270
  "document": "This API is used to query a database audit log.",
201
271
  "input": "DescribeAuditLogsRequest",
@@ -210,6 +280,20 @@
210
280
  "output": "DescribeAuditPoliciesResponse",
211
281
  "status": "online"
212
282
  },
283
+ "DescribeAuditRuleTemplateModifyHistory": {
284
+ "document": "This API is used to query the change history of rule templates.",
285
+ "input": "DescribeAuditRuleTemplateModifyHistoryRequest",
286
+ "name": "Queries the change history of rule templates",
287
+ "output": "DescribeAuditRuleTemplateModifyHistoryResponse",
288
+ "status": "online"
289
+ },
290
+ "DescribeAuditRuleTemplates": {
291
+ "document": "This API is used to query the information of audit rule templates.",
292
+ "input": "DescribeAuditRuleTemplatesRequest",
293
+ "name": "Queries audit rule templates",
294
+ "output": "DescribeAuditRuleTemplatesResponse",
295
+ "status": "online"
296
+ },
213
297
  "DescribeAuditRules": {
214
298
  "document": "This API is used to query the audit rules in the current region.",
215
299
  "input": "DescribeAuditRulesRequest",
@@ -365,7 +449,7 @@
365
449
  "status": "online"
366
450
  },
367
451
  "DescribeDBInstances": {
368
- "document": "This API (DescribeDBInstances) is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, access address, and instance status.",
452
+ "document": "This API is used to query the list of TencentDB for MySQL instances. It supports filtering instances by conditions such as project ID, instance ID, access address, and instance status. It also supports querying the list of information about primary instances, disaster recovery instances, and read-only instances.\nThis API is used to return the availability zone (AZ) status during purchase, which does not change along with the proactive HA switch. If you want to know the AZ status in real time, query through the [DescribeDBInstanceConfig](https://www.tencentcloud.com/document/product/236/17491?from_cn_redirect=1) API.",
369
453
  "input": "DescribeDBInstancesRequest",
370
454
  "name": "Queries the list of instances",
371
455
  "output": "DescribeDBInstancesResponse",
@@ -616,6 +700,27 @@
616
700
  "output": "ModifyAccountPrivilegesResponse",
617
701
  "status": "online"
618
702
  },
703
+ "ModifyAuditConfig": {
704
+ "document": "This API is used to modify the service configurations for a TencentDB audit policy, including the audit log retention period.",
705
+ "input": "ModifyAuditConfigRequest",
706
+ "name": "Modifies audit service configurations",
707
+ "output": "ModifyAuditConfigResponse",
708
+ "status": "online"
709
+ },
710
+ "ModifyAuditRuleTemplates": {
711
+ "document": "This API is used to modify audit rule templates.",
712
+ "input": "ModifyAuditRuleTemplatesRequest",
713
+ "name": "Modifies audit rule templates",
714
+ "output": "ModifyAuditRuleTemplatesResponse",
715
+ "status": "online"
716
+ },
717
+ "ModifyAuditService": {
718
+ "document": "This API is used to modify the service configurations for a TencentDB instance, including the audit log retention period and the audit rules.",
719
+ "input": "ModifyAuditServiceRequest",
720
+ "name": "Modifies the audit service for an instance",
721
+ "output": "ModifyAuditServiceResponse",
722
+ "status": "online"
723
+ },
619
724
  "ModifyAutoRenewFlag": {
620
725
  "document": "This API is used to modify the auto-renewal flag of a TencentDB instance.",
621
726
  "input": "ModifyAutoRenewFlagRequest",
@@ -944,24 +1049,24 @@
944
1049
  {
945
1050
  "disabled": false,
946
1051
  "document": "New account name",
947
- "example": "",
1052
+ "example": "andy",
948
1053
  "member": "string",
949
1054
  "name": "User",
950
1055
  "output_required": false,
951
1056
  "required": true,
952
1057
  "type": "string",
953
- "value_allowed_null": true
1058
+ "value_allowed_null": false
954
1059
  },
955
1060
  {
956
1061
  "disabled": false,
957
1062
  "document": "New account domain name",
958
- "example": "",
1063
+ "example": "172.1.1.1",
959
1064
  "member": "string",
960
1065
  "name": "Host",
961
1066
  "output_required": false,
962
1067
  "required": true,
963
1068
  "type": "string",
964
- "value_allowed_null": true
1069
+ "value_allowed_null": false
965
1070
  }
966
1071
  ],
967
1072
  "usage": "both"
@@ -1404,6 +1509,92 @@
1404
1509
  ],
1405
1510
  "usage": "in"
1406
1511
  },
1512
+ "AnalysisNodeInfo": {
1513
+ "document": "Analysis engine node information.",
1514
+ "members": [
1515
+ {
1516
+ "disabled": false,
1517
+ "document": "Node ID.",
1518
+ "example": "libradbn-0",
1519
+ "member": "string",
1520
+ "name": "NodeId",
1521
+ "output_required": true,
1522
+ "type": "string",
1523
+ "value_allowed_null": false
1524
+ },
1525
+ {
1526
+ "disabled": false,
1527
+ "document": "Node status.",
1528
+ "example": "例如:\"applying\"、\"normal\"、\"deleting\"",
1529
+ "member": "string",
1530
+ "name": "Status",
1531
+ "output_required": false,
1532
+ "type": "string",
1533
+ "value_allowed_null": false
1534
+ },
1535
+ {
1536
+ "disabled": false,
1537
+ "document": "Data loading status.",
1538
+ "example": "例如:\"Created\"、\"Running\"、\"Paused\"、\"Stopped\"、\"Removed\"、\"Error\"",
1539
+ "member": "string",
1540
+ "name": "DataStatus",
1541
+ "output_required": false,
1542
+ "type": "string",
1543
+ "value_allowed_null": false
1544
+ },
1545
+ {
1546
+ "disabled": false,
1547
+ "document": "Number of CPU cores, in cores.",
1548
+ "example": "4",
1549
+ "member": "uint64",
1550
+ "name": "Cpu",
1551
+ "output_required": false,
1552
+ "type": "int",
1553
+ "value_allowed_null": false
1554
+ },
1555
+ {
1556
+ "disabled": false,
1557
+ "document": "Memory size, in MB.",
1558
+ "example": "16",
1559
+ "member": "uint64",
1560
+ "name": "Memory",
1561
+ "output_required": false,
1562
+ "type": "int",
1563
+ "value_allowed_null": false
1564
+ },
1565
+ {
1566
+ "disabled": false,
1567
+ "document": "Disk size, in GB.",
1568
+ "example": "100",
1569
+ "member": "uint64",
1570
+ "name": "Storage",
1571
+ "output_required": false,
1572
+ "type": "int",
1573
+ "value_allowed_null": false
1574
+ },
1575
+ {
1576
+ "disabled": false,
1577
+ "document": "Node AZ.",
1578
+ "example": "ap-guangzhou-7",
1579
+ "member": "string",
1580
+ "name": "Zone",
1581
+ "output_required": false,
1582
+ "type": "string",
1583
+ "value_allowed_null": false
1584
+ },
1585
+ {
1586
+ "disabled": false,
1587
+ "document": "Data synchronization error message.",
1588
+ "example": "Paused by Command",
1589
+ "member": "string",
1590
+ "name": "Message",
1591
+ "output_required": false,
1592
+ "type": "string",
1593
+ "value_allowed_null": false
1594
+ }
1595
+ ],
1596
+ "usage": "out"
1597
+ },
1407
1598
  "AnalyzeAuditLogsRequest": {
1408
1599
  "document": "AnalyzeAuditLogs request structure.",
1409
1600
  "members": [
@@ -1577,6 +1768,88 @@
1577
1768
  ],
1578
1769
  "usage": "both"
1579
1770
  },
1771
+ "AuditInstanceFilters": {
1772
+ "document": "Filter conditions for querying audit instances.",
1773
+ "members": [
1774
+ {
1775
+ "disabled": false,
1776
+ "document": "Filter condition name. Valid values: InstanceId - Instance ID, InstanceName - Instance name, ProjectId - Project ID, TagKey - Tag key, Tag - Tag (using a vertical bar as separator, for example: TagKey|Tagvalue).",
1777
+ "example": "InstanceId",
1778
+ "member": "string",
1779
+ "name": "Name",
1780
+ "required": true,
1781
+ "type": "string",
1782
+ "value_allowed_null": true
1783
+ },
1784
+ {
1785
+ "disabled": false,
1786
+ "document": "true indicates exact matching; false indicates fuzzy matching.",
1787
+ "example": "true",
1788
+ "member": "bool",
1789
+ "name": "ExactMatch",
1790
+ "required": true,
1791
+ "type": "bool",
1792
+ "value_allowed_null": true
1793
+ },
1794
+ {
1795
+ "disabled": false,
1796
+ "document": "Filter value.",
1797
+ "example": "cdb-euu5fkcj",
1798
+ "member": "string",
1799
+ "name": "Values",
1800
+ "required": true,
1801
+ "type": "list",
1802
+ "value_allowed_null": true
1803
+ }
1804
+ ],
1805
+ "usage": "in"
1806
+ },
1807
+ "AuditInstanceInfo": {
1808
+ "document": "Audit instance details.",
1809
+ "members": [
1810
+ {
1811
+ "disabled": false,
1812
+ "document": "Project ID.",
1813
+ "example": "23414",
1814
+ "member": "int64",
1815
+ "name": "ProjectId",
1816
+ "output_required": true,
1817
+ "type": "int",
1818
+ "value_allowed_null": false
1819
+ },
1820
+ {
1821
+ "disabled": false,
1822
+ "document": "Tag information.",
1823
+ "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]",
1824
+ "member": "TagInfoUnit",
1825
+ "name": "TagList",
1826
+ "output_required": true,
1827
+ "type": "list",
1828
+ "value_allowed_null": false
1829
+ },
1830
+ {
1831
+ "disabled": false,
1832
+ "document": "Database engine type.",
1833
+ "example": "MYSQL",
1834
+ "member": "string",
1835
+ "name": "DbType",
1836
+ "output_required": true,
1837
+ "type": "string",
1838
+ "value_allowed_null": false
1839
+ },
1840
+ {
1841
+ "disabled": false,
1842
+ "document": "Database engine version.",
1843
+ "example": "5.7",
1844
+ "member": "string",
1845
+ "name": "DbVersion",
1846
+ "output_required": true,
1847
+ "type": "string",
1848
+ "value_allowed_null": false
1849
+ }
1850
+ ],
1851
+ "usage": "out"
1852
+ },
1580
1853
  "AuditLog": {
1581
1854
  "document": "Audit log details",
1582
1855
  "members": [
@@ -1799,88 +2072,146 @@
1799
2072
  ],
1800
2073
  "usage": "out"
1801
2074
  },
2075
+ "AuditLogFile": {
2076
+ "document": "Audit log file.",
2077
+ "members": [
2078
+ {
2079
+ "disabled": false,
2080
+ "document": "Audit log file name.",
2081
+ "example": "1308***106_cdb-3gj***th_1730***660_373***68.csv",
2082
+ "member": "string",
2083
+ "name": "FileName",
2084
+ "output_required": true,
2085
+ "type": "string",
2086
+ "value_allowed_null": false
2087
+ },
2088
+ {
2089
+ "disabled": false,
2090
+ "document": "Creation time of the audit log file, in the format: \"2019-03-20 17:09:13\".",
2091
+ "example": "2024-03-20 17:09:13",
2092
+ "member": "string",
2093
+ "name": "CreateTime",
2094
+ "output_required": true,
2095
+ "type": "string",
2096
+ "value_allowed_null": false
2097
+ },
2098
+ {
2099
+ "disabled": false,
2100
+ "document": "File status. Possible return values:\"creating\" - Generating;\"failed\" - Creation failed;\"success\" - Generated.",
2101
+ "example": "success",
2102
+ "member": "string",
2103
+ "name": "Status",
2104
+ "output_required": true,
2105
+ "type": "string",
2106
+ "value_allowed_null": false
2107
+ },
2108
+ {
2109
+ "disabled": false,
2110
+ "document": "File size in KB.",
2111
+ "example": "1",
2112
+ "member": "int64",
2113
+ "name": "FileSize",
2114
+ "output_required": true,
2115
+ "type": "int",
2116
+ "value_allowed_null": false
2117
+ },
2118
+ {
2119
+ "disabled": false,
2120
+ "document": "Download URL for the audit log.",
2121
+ "example": "https://gz-audit-125****829.cos.ap-guangzhou.myqcloud.com/130****106_cdb-3_37****68.csv?q-sign-algorithm=sh***",
2122
+ "member": "string",
2123
+ "name": "DownloadUrl",
2124
+ "output_required": true,
2125
+ "type": "string",
2126
+ "value_allowed_null": false
2127
+ },
2128
+ {
2129
+ "disabled": false,
2130
+ "document": "Error message.",
2131
+ "example": "error msg",
2132
+ "member": "string",
2133
+ "name": "ErrMsg",
2134
+ "output_required": true,
2135
+ "type": "string",
2136
+ "value_allowed_null": false
2137
+ }
2138
+ ],
2139
+ "usage": "out"
2140
+ },
1802
2141
  "AuditLogFilter": {
1803
2142
  "document": "Filter condition for an audit log, which is used by users to filter the returned audit logs when querying them.",
1804
2143
  "members": [
1805
2144
  {
1806
2145
  "disabled": false,
1807
2146
  "document": "Client address",
1808
- "example": "",
2147
+ "example": "[\"172.1.1.1\",\"182.1.1.1\"]",
1809
2148
  "member": "string",
1810
2149
  "name": "Host",
1811
2150
  "required": false,
1812
- "type": "list",
1813
- "value_allowed_null": false
2151
+ "type": "list"
1814
2152
  },
1815
2153
  {
1816
2154
  "disabled": false,
1817
2155
  "document": "Username",
1818
- "example": "",
2156
+ "example": "[\"root\",\"andy\"]",
1819
2157
  "member": "string",
1820
2158
  "name": "User",
1821
2159
  "required": false,
1822
- "type": "list",
1823
- "value_allowed_null": false
2160
+ "type": "list"
1824
2161
  },
1825
2162
  {
1826
2163
  "disabled": false,
1827
2164
  "document": "",
1828
- "example": "",
2165
+ "example": "[\"db1\",\"db2\"]",
1829
2166
  "member": "string",
1830
2167
  "name": "DBName",
1831
2168
  "required": false,
1832
- "type": "list",
1833
- "value_allowed_null": false
2169
+ "type": "list"
1834
2170
  },
1835
2171
  {
1836
2172
  "disabled": false,
1837
2173
  "document": "Table name",
1838
- "example": "",
2174
+ "example": "[\"andy_table1\",\"andy_table2\"]",
1839
2175
  "member": "string",
1840
2176
  "name": "TableName",
1841
2177
  "required": false,
1842
- "type": "list",
1843
- "value_allowed_null": false
2178
+ "type": "list"
1844
2179
  },
1845
2180
  {
1846
2181
  "disabled": false,
1847
2182
  "document": "Audit policy name",
1848
- "example": "",
2183
+ "example": "[\"Policy1\",\"Policy2\"]",
1849
2184
  "member": "string",
1850
2185
  "name": "PolicyName",
1851
2186
  "required": false,
1852
- "type": "list",
1853
- "value_allowed_null": false
2187
+ "type": "list"
1854
2188
  },
1855
2189
  {
1856
2190
  "disabled": false,
1857
2191
  "document": "",
1858
- "example": "“”",
2192
+ "example": "CREATE TABLE employees",
1859
2193
  "member": "string",
1860
2194
  "name": "Sql",
1861
2195
  "required": false,
1862
- "type": "string",
1863
- "value_allowed_null": false
2196
+ "type": "string"
1864
2197
  },
1865
2198
  {
1866
2199
  "disabled": false,
1867
2200
  "document": "",
1868
- "example": "",
2201
+ "example": "SELECT",
1869
2202
  "member": "string",
1870
2203
  "name": "SqlType",
1871
2204
  "required": false,
1872
- "type": "string",
1873
- "value_allowed_null": false
2205
+ "type": "string"
1874
2206
  },
1875
2207
  {
1876
2208
  "disabled": false,
1877
2209
  "document": "Execution time in ms, which is used to filter the audit log with execution time greater than this value.",
1878
- "example": "1",
2210
+ "example": "10",
1879
2211
  "member": "int64",
1880
2212
  "name": "ExecTime",
1881
2213
  "required": false,
1882
- "type": "int",
1883
- "value_allowed_null": false
2214
+ "type": "int"
1884
2215
  },
1885
2216
  {
1886
2217
  "disabled": false,
@@ -1889,98 +2220,88 @@
1889
2220
  "member": "int64",
1890
2221
  "name": "AffectRows",
1891
2222
  "required": false,
1892
- "type": "int",
1893
- "value_allowed_null": false
2223
+ "type": "int"
1894
2224
  },
1895
2225
  {
1896
2226
  "disabled": false,
1897
2227
  "document": "SQL type (Multiple types can be queried at same time). Valid values: `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `ALTER`, `SET`, `REPLACE`, `EXECUTE`.",
1898
- "example": "",
2228
+ "example": "[\"SELECT\", \"INSERT\"]",
1899
2229
  "member": "string",
1900
2230
  "name": "SqlTypes",
1901
2231
  "required": false,
1902
- "type": "list",
1903
- "value_allowed_null": false
2232
+ "type": "list"
1904
2233
  },
1905
2234
  {
1906
2235
  "disabled": false,
1907
2236
  "document": "SQL statement. Multiple SQL statements can be passed in.",
1908
- "example": "",
2237
+ "example": "[\"CREATE TABLE employees\",\"SELECT * FROM employees\"]",
1909
2238
  "member": "string",
1910
2239
  "name": "Sqls",
1911
2240
  "required": false,
1912
- "type": "list",
1913
- "value_allowed_null": false
2241
+ "type": "list"
1914
2242
  },
1915
2243
  {
1916
2244
  "disabled": false,
1917
2245
  "document": "Number of rows affected in the format of M-N, such as 10-200.",
1918
- "example": "",
2246
+ "example": "10-200",
1919
2247
  "member": "string",
1920
2248
  "name": "AffectRowsSection",
1921
2249
  "required": false,
1922
- "type": "string",
1923
- "value_allowed_null": false
2250
+ "type": "string"
1924
2251
  },
1925
2252
  {
1926
2253
  "disabled": false,
1927
2254
  "document": "Number of rows returned in the format of M-N, such as 10-200.",
1928
- "example": "",
2255
+ "example": "10-200",
1929
2256
  "member": "string",
1930
2257
  "name": "SentRowsSection",
1931
2258
  "required": false,
1932
- "type": "string",
1933
- "value_allowed_null": false
2259
+ "type": "string"
1934
2260
  },
1935
2261
  {
1936
2262
  "disabled": false,
1937
2263
  "document": "Execution time in the format of M-N, such as 10-200.",
1938
- "example": "",
2264
+ "example": "10-200",
1939
2265
  "member": "string",
1940
2266
  "name": "ExecTimeSection",
1941
2267
  "required": false,
1942
- "type": "string",
1943
- "value_allowed_null": false
2268
+ "type": "string"
1944
2269
  },
1945
2270
  {
1946
2271
  "disabled": false,
1947
2272
  "document": "Lock wait time in the format of M-N, such as 10-200.",
1948
- "example": "",
2273
+ "example": "10-200",
1949
2274
  "member": "string",
1950
2275
  "name": "LockWaitTimeSection",
1951
2276
  "required": false,
1952
- "type": "string",
1953
- "value_allowed_null": false
2277
+ "type": "string"
1954
2278
  },
1955
2279
  {
1956
2280
  "disabled": false,
1957
2281
  "document": "IO wait time in the format of M-N, such as 10-200.",
1958
- "example": "",
2282
+ "example": "10-200",
1959
2283
  "member": "string",
1960
2284
  "name": "IoWaitTimeSection",
1961
2285
  "required": false,
1962
- "type": "string",
1963
- "value_allowed_null": false
2286
+ "type": "string"
1964
2287
  },
1965
2288
  {
1966
2289
  "disabled": false,
1967
2290
  "document": "Transaction duration in the format of M-N, such as 10-200.",
1968
- "example": "",
2291
+ "example": "10-200",
1969
2292
  "member": "string",
1970
2293
  "name": "TransactionLivingTimeSection",
1971
2294
  "required": false,
1972
- "type": "string",
1973
- "value_allowed_null": false
2295
+ "type": "string"
1974
2296
  },
1975
2297
  {
1976
2298
  "disabled": false,
1977
2299
  "document": "Thread ID",
1978
- "example": "",
2300
+ "example": "[\"1015\",\"1016\"]",
1979
2301
  "member": "string",
1980
2302
  "name": "ThreadId",
1981
2303
  "required": false,
1982
- "type": "list",
1983
- "value_allowed_null": true
2304
+ "type": "list"
1984
2305
  },
1985
2306
  {
1986
2307
  "disabled": false,
@@ -1989,18 +2310,16 @@
1989
2310
  "member": "int64",
1990
2311
  "name": "SentRows",
1991
2312
  "required": false,
1992
- "type": "int",
1993
- "value_allowed_null": true
2313
+ "type": "int"
1994
2314
  },
1995
2315
  {
1996
2316
  "disabled": false,
1997
2317
  "document": "MySQL error codes",
1998
- "example": "",
2318
+ "example": "0",
1999
2319
  "member": "int64",
2000
2320
  "name": "ErrCode",
2001
2321
  "required": false,
2002
- "type": "list",
2003
- "value_allowed_null": true
2322
+ "type": "list"
2004
2323
  }
2005
2324
  ],
2006
2325
  "usage": "in"
@@ -2182,17 +2501,124 @@
2182
2501
  "members": [
2183
2502
  {
2184
2503
  "disabled": false,
2185
- "document": "Audit rule \nNote: This field may return null, indicating that no valid values can be obtained.",
2186
- "example": "",
2504
+ "document": "A single audit rule.",
2505
+ "example": "[{\"Type\": \"sqlType\",\"INC\": \"employees\",\"Value\": [\"employees\"]}]",
2187
2506
  "member": "RuleFilters",
2188
2507
  "name": "RuleFilters",
2508
+ "output_required": true,
2189
2509
  "required": false,
2190
2510
  "type": "list",
2191
- "value_allowed_null": true
2511
+ "value_allowed_null": false
2192
2512
  }
2193
2513
  ],
2194
2514
  "usage": "both"
2195
2515
  },
2516
+ "AuditRuleTemplateInfo": {
2517
+ "document": "Details of an audit rule template.",
2518
+ "members": [
2519
+ {
2520
+ "disabled": false,
2521
+ "document": "Rule template ID.",
2522
+ "example": "cdb-art-dnpg9p3r",
2523
+ "member": "string",
2524
+ "name": "RuleTemplateId",
2525
+ "output_required": true,
2526
+ "type": "string",
2527
+ "value_allowed_null": false
2528
+ },
2529
+ {
2530
+ "disabled": false,
2531
+ "document": "Rule template name.",
2532
+ "example": "andy",
2533
+ "member": "string",
2534
+ "name": "RuleTemplateName",
2535
+ "output_required": true,
2536
+ "type": "string",
2537
+ "value_allowed_null": false
2538
+ },
2539
+ {
2540
+ "disabled": false,
2541
+ "document": "Filter conditions of the rule template.",
2542
+ "example": "[{\"Type\": \"sqlType\",\"INC\": \"employees\",\"Value\": [\"employees\"]}]",
2543
+ "member": "RuleFilters",
2544
+ "name": "RuleFilters",
2545
+ "output_required": true,
2546
+ "type": "list",
2547
+ "value_allowed_null": false
2548
+ },
2549
+ {
2550
+ "disabled": false,
2551
+ "document": "Rule template description.",
2552
+ "example": "dd_yif",
2553
+ "member": "string",
2554
+ "name": "Description",
2555
+ "output_required": true,
2556
+ "type": "string",
2557
+ "value_allowed_null": false
2558
+ },
2559
+ {
2560
+ "disabled": false,
2561
+ "document": "Rule template creation time.",
2562
+ "example": "2022-11-15 11:11:11",
2563
+ "member": "string",
2564
+ "name": "CreateAt",
2565
+ "output_required": true,
2566
+ "type": "string",
2567
+ "value_allowed_null": false
2568
+ },
2569
+ {
2570
+ "disabled": false,
2571
+ "document": "Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk.",
2572
+ "example": "3",
2573
+ "member": "uint64",
2574
+ "name": "AlarmLevel",
2575
+ "output_required": false,
2576
+ "type": "int",
2577
+ "value_allowed_null": false
2578
+ },
2579
+ {
2580
+ "disabled": false,
2581
+ "document": "Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled.",
2582
+ "example": "1",
2583
+ "member": "uint64",
2584
+ "name": "AlarmPolicy",
2585
+ "output_required": false,
2586
+ "type": "int",
2587
+ "value_allowed_null": false
2588
+ },
2589
+ {
2590
+ "disabled": false,
2591
+ "document": "Instances to which this rule template is applied.",
2592
+ "example": "[\"cdb-gbpmgksv\",\"cdb-geyhwksv\"]",
2593
+ "member": "string",
2594
+ "name": "AffectedInstances",
2595
+ "output_required": false,
2596
+ "type": "list",
2597
+ "value_allowed_null": false
2598
+ },
2599
+ {
2600
+ "disabled": false,
2601
+ "document": "Template status. Valid values: 0 - No task, 1 - modifying.",
2602
+ "example": "0",
2603
+ "member": "uint64",
2604
+ "name": "Status",
2605
+ "output_required": false,
2606
+ "type": "int",
2607
+ "value_allowed_null": false
2608
+ },
2609
+ {
2610
+ "disabled": false,
2611
+ "document": "Template update time.",
2612
+ "example": "2023-11-08 15:34:57",
2613
+ "member": "string",
2614
+ "name": "UpdateAt",
2615
+ "output_required": false,
2616
+ "type": "string",
2617
+ "value_allowed_null": false
2618
+ }
2619
+ ],
2620
+ "usage": "out"
2621
+ },
2196
2622
  "AutoStrategy": {
2197
2623
  "document": "Automatic scale-out policy for elastic CPU scale-out.",
2198
2624
  "members": [
@@ -2241,40 +2667,40 @@
2241
2667
  {
2242
2668
  "disabled": false,
2243
2669
  "document": "Replication mode of secondary database 2. Value range: async, semi-sync",
2244
- "example": "",
2670
+ "example": "async",
2245
2671
  "member": "string",
2246
2672
  "name": "ReplicationMode",
2247
- "required": true,
2673
+ "output_required": true,
2248
2674
  "type": "string",
2249
2675
  "value_allowed_null": false
2250
2676
  },
2251
2677
  {
2252
2678
  "disabled": false,
2253
- "document": "Name of the AZ of secondary database 2, such as ap-shanghai-1",
2254
- "example": "",
2679
+ "document": "Name of the AZ of secondary database 2, such as ap-shanghai-2",
2680
+ "example": "ap-shanghai-2",
2255
2681
  "member": "string",
2256
2682
  "name": "Zone",
2257
- "required": true,
2683
+ "output_required": true,
2258
2684
  "type": "string",
2259
2685
  "value_allowed_null": false
2260
2686
  },
2261
2687
  {
2262
2688
  "disabled": false,
2263
2689
  "document": "Private IP address of secondary database 2",
2264
- "example": "",
2690
+ "example": "172.1.1.1",
2265
2691
  "member": "string",
2266
2692
  "name": "Vip",
2267
- "required": true,
2693
+ "output_required": true,
2268
2694
  "type": "string",
2269
2695
  "value_allowed_null": false
2270
2696
  },
2271
2697
  {
2272
2698
  "disabled": false,
2273
2699
  "document": "Access port of secondary database 2",
2274
- "example": "",
2700
+ "example": "3306",
2275
2701
  "member": "uint64",
2276
2702
  "name": "Vport",
2277
- "required": true,
2703
+ "output_required": true,
2278
2704
  "type": "int",
2279
2705
  "value_allowed_null": false
2280
2706
  }
@@ -3015,7 +3441,7 @@
3015
3441
  "example": "Z3",
3016
3442
  "member": "string",
3017
3443
  "name": "TypeName",
3018
- "required": true,
3444
+ "output_required": true,
3019
3445
  "type": "string",
3020
3446
  "value_allowed_null": false
3021
3447
  },
@@ -3025,7 +3451,7 @@
3025
3451
  "example": "[\"5.6\",\"5.7\"]",
3026
3452
  "member": "string",
3027
3453
  "name": "EngineVersion",
3028
- "required": true,
3454
+ "output_required": true,
3029
3455
  "type": "list",
3030
3456
  "value_allowed_null": false
3031
3457
  },
@@ -3035,7 +3461,7 @@
3035
3461
  "example": "[1,2,3]",
3036
3462
  "member": "int64",
3037
3463
  "name": "ConfigIds",
3038
- "required": true,
3464
+ "output_required": true,
3039
3465
  "type": "list",
3040
3466
  "value_allowed_null": false
3041
3467
  }
@@ -3084,7 +3510,7 @@
3084
3510
  {
3085
3511
  "disabled": false,
3086
3512
  "document": "AZ name",
3087
- "example": "广州二区",
3513
+ "example": "广州三区",
3088
3514
  "member": "string",
3089
3515
  "name": "ZoneName",
3090
3516
  "output_required": true,
@@ -3174,7 +3600,7 @@
3174
3600
  {
3175
3601
  "disabled": false,
3176
3602
  "document": "AZ name",
3177
- "example": "ap-guangzhou-2",
3603
+ "example": "ap-guangzhou-3",
3178
3604
  "member": "string",
3179
3605
  "name": "Zone",
3180
3606
  "output_required": true,
@@ -3184,7 +3610,7 @@
3184
3610
  {
3185
3611
  "disabled": false,
3186
3612
  "document": "Multi-AZ information",
3187
- "example": "{\"BackupZone\": [\"ap-guangzhou-7\", \"ap-guangzhou-5\", \"ap-guangzhou-4\", \"ap-guangzhou-3\" ], \"DeployMode\": [0, 1 ], \"MasterZone\": [], \"SlaveZone\": [\"ap-guangzhou-7\", \"ap-guangzhou-5\", \"ap-guangzhou-4\", \"ap-guangzhou-3\" ] }",
3613
+ "example": "",
3188
3614
  "member": "ZoneConf",
3189
3615
  "name": "ZoneConf",
3190
3616
  "output_required": true,
@@ -3194,7 +3620,7 @@
3194
3620
  {
3195
3621
  "disabled": false,
3196
3622
  "document": "Information of supported disaster recovery AZs",
3197
- "example": "[\"ap-guangzhou-2\"]",
3623
+ "example": "[\"ap-guangzhou-3\"]",
3198
3624
  "member": "string",
3199
3625
  "name": "DrZone",
3200
3626
  "output_required": true,
@@ -3214,7 +3640,7 @@
3214
3640
  {
3215
3641
  "disabled": false,
3216
3642
  "document": "Information of supported cross-AZ read-only zone",
3217
- "example": "[\"ap-guangzhou-2\"]",
3643
+ "example": "[\"ap-guangzhou-3\"]",
3218
3644
  "member": "string",
3219
3645
  "name": "RemoteRoZone",
3220
3646
  "output_required": true,
@@ -3234,7 +3660,7 @@
3234
3660
  {
3235
3661
  "disabled": false,
3236
3662
  "document": "Information of cross-AZ read-only zones supported by a dedicated instance",
3237
- "example": "[\"ap-guangzhou-2\"]",
3663
+ "example": "[\"ap-guangzhou-3\"]",
3238
3664
  "member": "string",
3239
3665
  "name": "ExClusterRemoteRoZone",
3240
3666
  "output_required": true,
@@ -3244,7 +3670,7 @@
3244
3670
  {
3245
3671
  "disabled": false,
3246
3672
  "document": "AZ information of a multi-AZ deployed dedicated instance.",
3247
- "example": "{\"BackupZone\": [\"ap-guangzhou-7\", \"ap-guangzhou-5\", \"ap-guangzhou-4\", \"ap-guangzhou-3\" ], \"DeployMode\": [0, 1 ], \"MasterZone\": [], \"SlaveZone\": [\"ap-guangzhou-7\", \"ap-guangzhou-5\", \"ap-guangzhou-4\", \"ap-guangzhou-3\" ] }",
3673
+ "example": "",
3248
3674
  "member": "ZoneConf",
3249
3675
  "name": "ExClusterZoneConf",
3250
3676
  "output_required": true,
@@ -3254,7 +3680,7 @@
3254
3680
  {
3255
3681
  "disabled": false,
3256
3682
  "document": "Array of purchasable instance types. The value of `configIds` and `configs` have a one-to-one correspondence.",
3257
- "example": "{\"ConfigIds\": [187 ], \"EngineVersion\": [\"5.7\", \"8.0\" ], \"TypeName\": \"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" }",
3683
+ "example": "",
3258
3684
  "member": "CdbSellType",
3259
3685
  "name": "SellType",
3260
3686
  "output_required": true,
@@ -3264,7 +3690,7 @@
3264
3690
  {
3265
3691
  "disabled": false,
3266
3692
  "document": "AZ ID",
3267
- "example": "200001",
3693
+ "example": "200002",
3268
3694
  "member": "int64",
3269
3695
  "name": "ZoneId",
3270
3696
  "output_required": true,
@@ -3274,7 +3700,7 @@
3274
3700
  {
3275
3701
  "disabled": false,
3276
3702
  "document": "Whether IPv6 is supported",
3277
- "example": "fasle",
3703
+ "example": "false",
3278
3704
  "member": "bool",
3279
3705
  "name": "IsSupportIpv6",
3280
3706
  "output_required": true,
@@ -3400,6 +3826,33 @@
3400
3826
  ],
3401
3827
  "usage": "out"
3402
3828
  },
3829
+ "CloseAuditServiceRequest": {
3830
+ "document": "CloseAuditService request structure.",
3831
+ "members": [
3832
+ {
3833
+ "disabled": false,
3834
+ "document": "Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/236/15872?from_cn_redirect=1) API.",
3835
+ "example": "cdb-22dhn3e3",
3836
+ "member": "string",
3837
+ "name": "InstanceId",
3838
+ "required": true,
3839
+ "type": "string"
3840
+ }
3841
+ ],
3842
+ "type": "object"
3843
+ },
3844
+ "CloseAuditServiceResponse": {
3845
+ "document": "CloseAuditService response structure.",
3846
+ "members": [
3847
+ {
3848
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
3849
+ "member": "string",
3850
+ "name": "RequestId",
3851
+ "type": "string"
3852
+ }
3853
+ ],
3854
+ "type": "object"
3855
+ },
3403
3856
  "CloseCDBProxyRequest": {
3404
3857
  "document": "CloseCDBProxy request structure.",
3405
3858
  "members": [
@@ -3518,6 +3971,45 @@
3518
3971
  ],
3519
3972
  "type": "object"
3520
3973
  },
3974
+ "ClusterInfo": {
3975
+ "document": "Cluster Edition node information.",
3976
+ "members": [
3977
+ {
3978
+ "disabled": false,
3979
+ "document": "Node ID.",
3980
+ "example": "\"dbn-ipffzoum\"",
3981
+ "member": "string",
3982
+ "name": "NodeId",
3983
+ "output_required": false,
3984
+ "required": false,
3985
+ "type": "string",
3986
+ "value_allowed_null": false
3987
+ },
3988
+ {
3989
+ "disabled": false,
3990
+ "document": "Node type: primary node and secondary node.",
3991
+ "example": "\"master\"",
3992
+ "member": "string",
3993
+ "name": "Role",
3994
+ "output_required": false,
3995
+ "required": false,
3996
+ "type": "string",
3997
+ "value_allowed_null": false
3998
+ },
3999
+ {
4000
+ "disabled": false,
4001
+ "document": "Region.",
4002
+ "example": "\"ap-guangzhou\"",
4003
+ "member": "string",
4004
+ "name": "Zone",
4005
+ "output_required": false,
4006
+ "required": false,
4007
+ "type": "string",
4008
+ "value_allowed_null": false
4009
+ }
4010
+ ],
4011
+ "usage": "both"
4012
+ },
3521
4013
  "ColumnPrivilege": {
3522
4014
  "document": "Column permission information",
3523
4015
  "members": [
@@ -3739,50 +4231,150 @@
3739
4231
  ],
3740
4232
  "type": "object"
3741
4233
  },
3742
- "CreateAuditPolicyRequest": {
3743
- "document": "CreateAuditPolicy request structure.",
4234
+ "CreateAuditLogFileRequest": {
4235
+ "document": "CreateAuditLogFile request structure.",
3744
4236
  "members": [
3745
4237
  {
3746
4238
  "disabled": false,
3747
- "document": "Audit policy name.",
3748
- "example": "audit_policy_1",
4239
+ "document": "Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/236/15872?from_cn_redirect=1) API.",
4240
+ "example": "cdb-cdtkp3hr",
3749
4241
  "member": "string",
3750
- "name": "Name",
4242
+ "name": "InstanceId",
3751
4243
  "required": true,
3752
4244
  "type": "string"
3753
4245
  },
3754
4246
  {
3755
4247
  "disabled": false,
3756
- "document": "Audit rule ID.",
3757
- "example": "cdbrule-asdfghjk",
4248
+ "document": "Start time. We recommend that the interval between start and end time does not exceed 7 days.",
4249
+ "example": "2023-06-07 15:59:45",
3758
4250
  "member": "string",
3759
- "name": "RuleId",
4251
+ "name": "StartTime",
3760
4252
  "required": true,
3761
4253
  "type": "string"
3762
4254
  },
3763
4255
  {
3764
4256
  "disabled": false,
3765
- "document": "Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.",
3766
- "example": "cdb-qwerasdf",
4257
+ "document": "End time. We recommend that the interval between start and end time does not exceed 7 days.",
4258
+ "example": "2023-06-16 14:27:00",
3767
4259
  "member": "string",
3768
- "name": "InstanceId",
4260
+ "name": "EndTime",
3769
4261
  "required": true,
3770
4262
  "type": "string"
3771
4263
  },
3772
4264
  {
3773
4265
  "disabled": false,
3774
- "document": "Retention period of audit logs. Valid values:\n7: seven days (a week);\n30: 30 days (a month);\n180: 180 days (six months);\n365: 365 days (a year);\n1095: 1095 days (three years);\n1825: 1825 days (five years).\nThis parameter specifies the retention period (30 days by default) of audit logs, which is valid when you create the first audit policy for an instance. If the instance already has audit policies, this parameter is invalid, but you can use the `ModifyAuditConfig` API to modify the retention period.",
3775
- "example": "7",
3776
- "member": "int64",
3777
- "name": "LogExpireDay",
4266
+ "document": "Sort order. Valid values: \"ASC\" - Ascending order, \"DESC\" - Descending order. Default value: \"DESC\".",
4267
+ "example": "DESC",
4268
+ "member": "string",
4269
+ "name": "Order",
3778
4270
  "required": false,
3779
- "type": "int"
4271
+ "type": "string"
4272
+ },
4273
+ {
4274
+ "disabled": false,
4275
+ "document": "Field to sort by. Valid values: \"timestamp\" - Timestamp; \"affectRows\" - Number of affected rows; \"execTime\" - Execution time. Default value: \"timestamp\".",
4276
+ "example": "timestamp",
4277
+ "member": "string",
4278
+ "name": "OrderBy",
4279
+ "required": false,
4280
+ "type": "string"
4281
+ },
4282
+ {
4283
+ "disabled": true,
4284
+ "document": "Deprecated.",
4285
+ "example": "{\"SqlTypes\": [\"CREATE\"]}",
4286
+ "member": "AuditLogFilter",
4287
+ "name": "Filter",
4288
+ "required": false,
4289
+ "type": "object"
4290
+ },
4291
+ {
4292
+ "disabled": false,
4293
+ "document": "Filter conditions. You can filter logs based on these conditions.",
4294
+ "example": "[{\"Type\": \"host\", \"Compare\": \"EXC\",\"Value\": \"10.0.\"}]",
4295
+ "member": "InstanceAuditLogFilters",
4296
+ "name": "LogFilter",
4297
+ "required": false,
4298
+ "type": "list"
4299
+ },
4300
+ {
4301
+ "disabled": false,
4302
+ "document": "Columns to include in the download.",
4303
+ "example": "{\"ColumnFilter\": [\"AffectRows\", \"ErrCode\", \"SqlType\", \"TableName\", \"DBName\", \"Sql\", \"Host\", \"User\", \"ExecTime\", \"CheckRows\", \"SentRows\", \"ThreadId\", \"NsTime\", \"IoWaitTime\", \"TrxLivingTime\", \"Timestamp\", \"Result\",\"RiskLevel\",\"TrxId\"]}",
4304
+ "member": "string",
4305
+ "name": "ColumnFilter",
4306
+ "required": false,
4307
+ "type": "list"
3780
4308
  }
3781
4309
  ],
3782
4310
  "type": "object"
3783
4311
  },
3784
- "CreateAuditPolicyResponse": {
3785
- "document": "CreateAuditPolicy response structure.",
4312
+ "CreateAuditLogFileResponse": {
4313
+ "document": "CreateAuditLogFile response structure.",
4314
+ "members": [
4315
+ {
4316
+ "disabled": false,
4317
+ "document": "Audit log file name.",
4318
+ "example": "shenji.csv",
4319
+ "member": "string",
4320
+ "name": "FileName",
4321
+ "output_required": true,
4322
+ "type": "string",
4323
+ "value_allowed_null": false
4324
+ },
4325
+ {
4326
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
4327
+ "member": "string",
4328
+ "name": "RequestId",
4329
+ "type": "string"
4330
+ }
4331
+ ],
4332
+ "type": "object"
4333
+ },
4334
+ "CreateAuditPolicyRequest": {
4335
+ "document": "CreateAuditPolicy request structure.",
4336
+ "members": [
4337
+ {
4338
+ "disabled": false,
4339
+ "document": "Audit policy name.",
4340
+ "example": "audit_policy_1",
4341
+ "member": "string",
4342
+ "name": "Name",
4343
+ "required": true,
4344
+ "type": "string"
4345
+ },
4346
+ {
4347
+ "disabled": false,
4348
+ "document": "Audit rule ID.",
4349
+ "example": "cdbrule-asdfghjk",
4350
+ "member": "string",
4351
+ "name": "RuleId",
4352
+ "required": true,
4353
+ "type": "string"
4354
+ },
4355
+ {
4356
+ "disabled": false,
4357
+ "document": "Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.",
4358
+ "example": "cdb-qwerasdf",
4359
+ "member": "string",
4360
+ "name": "InstanceId",
4361
+ "required": true,
4362
+ "type": "string"
4363
+ },
4364
+ {
4365
+ "disabled": false,
4366
+ "document": "Retention period of audit logs. Valid values:\n7: seven days (a week);\n30: 30 days (a month);\n180: 180 days (six months);\n365: 365 days (a year);\n1095: 1095 days (three years);\n1825: 1825 days (five years).\nThis parameter specifies the retention period (30 days by default) of audit logs, which is valid when you create the first audit policy for an instance. If the instance already has audit policies, this parameter is invalid, but you can use the `ModifyAuditConfig` API to modify the retention period.",
4367
+ "example": "7",
4368
+ "member": "int64",
4369
+ "name": "LogExpireDay",
4370
+ "required": false,
4371
+ "type": "int"
4372
+ }
4373
+ ],
4374
+ "type": "object"
4375
+ },
4376
+ "CreateAuditPolicyResponse": {
4377
+ "document": "CreateAuditPolicy response structure.",
3786
4378
  "members": [
3787
4379
  {
3788
4380
  "disabled": false,
@@ -3803,6 +4395,79 @@
3803
4395
  ],
3804
4396
  "type": "object"
3805
4397
  },
4398
+ "CreateAuditRuleTemplateRequest": {
4399
+ "document": "CreateAuditRuleTemplate request structure.",
4400
+ "members": [
4401
+ {
4402
+ "disabled": false,
4403
+ "document": "Audit rule.",
4404
+ "example": "[{\"Type\": \"host\",\"Compare\": \"EQS\",\"Value\": [\"100.122.76.176\",\"10.0.0.9\"]}]",
4405
+ "member": "RuleFilters",
4406
+ "name": "RuleFilters",
4407
+ "required": true,
4408
+ "type": "list"
4409
+ },
4410
+ {
4411
+ "disabled": false,
4412
+ "document": "Rule template name. Up to 30 characters are allowed.",
4413
+ "example": "andy",
4414
+ "member": "string",
4415
+ "name": "RuleTemplateName",
4416
+ "required": true,
4417
+ "type": "string"
4418
+ },
4419
+ {
4420
+ "disabled": false,
4421
+ "document": "Rule template description. Up to 200 characters are allowed.",
4422
+ "example": "用于测试的规则模板",
4423
+ "member": "string",
4424
+ "name": "Description",
4425
+ "required": false,
4426
+ "type": "string"
4427
+ },
4428
+ {
4429
+ "disabled": false,
4430
+ "document": "Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk. Default value: 1.",
4431
+ "example": "3",
4432
+ "member": "uint64",
4433
+ "name": "AlarmLevel",
4434
+ "required": false,
4435
+ "type": "int"
4436
+ },
4437
+ {
4438
+ "disabled": false,
4439
+ "document": "Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled. Default value: 0.",
4440
+ "example": "1",
4441
+ "member": "uint64",
4442
+ "name": "AlarmPolicy",
4443
+ "required": false,
4444
+ "type": "int"
4445
+ }
4446
+ ],
4447
+ "type": "object"
4448
+ },
4449
+ "CreateAuditRuleTemplateResponse": {
4450
+ "document": "CreateAuditRuleTemplate response structure.",
4451
+ "members": [
4452
+ {
4453
+ "disabled": false,
4454
+ "document": "Generated rule template ID.",
4455
+ "example": "cdb-art-l1mlbo59",
4456
+ "member": "string",
4457
+ "name": "RuleTemplateId",
4458
+ "output_required": true,
4459
+ "type": "string",
4460
+ "value_allowed_null": false
4461
+ },
4462
+ {
4463
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
4464
+ "member": "string",
4465
+ "name": "RequestId",
4466
+ "type": "string"
4467
+ }
4468
+ ],
4469
+ "type": "object"
4470
+ },
3806
4471
  "CreateBackupRequest": {
3807
4472
  "document": "CreateBackup request structure.",
3808
4473
  "members": [
@@ -5437,6 +6102,42 @@
5437
6102
  ],
5438
6103
  "type": "object"
5439
6104
  },
6105
+ "CreateRotationPasswordRequest": {
6106
+ "document": "CreateRotationPassword request structure.",
6107
+ "members": [
6108
+ {
6109
+ "disabled": false,
6110
+ "document": "Instance ID, in the format of cdb-c1nl9rpv, which is the same as the instance ID displayed on the TencentDB for MySQL console page.",
6111
+ "example": "cdb-c1nl9rpv",
6112
+ "member": "string",
6113
+ "name": "InstanceId",
6114
+ "required": true,
6115
+ "type": "string"
6116
+ },
6117
+ {
6118
+ "disabled": false,
6119
+ "document": "Information about the account for which password rotation needs to be enabled. The account and host names are included.",
6120
+ "example": "[{\"User\": \"andy\",\"Host\": \"192.1.1.1\"}]",
6121
+ "member": "Account",
6122
+ "name": "Accounts",
6123
+ "required": true,
6124
+ "type": "list"
6125
+ }
6126
+ ],
6127
+ "type": "object"
6128
+ },
6129
+ "CreateRotationPasswordResponse": {
6130
+ "document": "CreateRotationPassword response structure.",
6131
+ "members": [
6132
+ {
6133
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6134
+ "member": "string",
6135
+ "name": "RequestId",
6136
+ "type": "string"
6137
+ }
6138
+ ],
6139
+ "type": "object"
6140
+ },
5440
6141
  "CustomConfig": {
5441
6142
  "document": "Proxy configuration",
5442
6143
  "members": [
@@ -5615,6 +6316,105 @@
5615
6316
  ],
5616
6317
  "type": "object"
5617
6318
  },
6319
+ "DeleteAuditLogFileRequest": {
6320
+ "document": "DeleteAuditLogFile request structure.",
6321
+ "members": [
6322
+ {
6323
+ "disabled": false,
6324
+ "document": "Audit log file name, which can be obtained through the [DescribeAuditLogFiles](https://www.tencentcloud.comom/document/api/236/45454?from_cn_redirect=1) API.",
6325
+ "example": "13123**346_cdb-0ej6n21d_1734**9765_42322441.csv",
6326
+ "member": "string",
6327
+ "name": "FileName",
6328
+ "required": true,
6329
+ "type": "string"
6330
+ },
6331
+ {
6332
+ "disabled": false,
6333
+ "document": "Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/236/15872?from_cn_redirect=1) API.",
6334
+ "example": "cdb-0ej6n21d",
6335
+ "member": "string",
6336
+ "name": "InstanceId",
6337
+ "required": true,
6338
+ "type": "string"
6339
+ }
6340
+ ],
6341
+ "type": "object"
6342
+ },
6343
+ "DeleteAuditLogFileResponse": {
6344
+ "document": "DeleteAuditLogFile response structure.",
6345
+ "members": [
6346
+ {
6347
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6348
+ "member": "string",
6349
+ "name": "RequestId",
6350
+ "type": "string"
6351
+ }
6352
+ ],
6353
+ "type": "object"
6354
+ },
6355
+ "DeleteAuditPolicyRequest": {
6356
+ "document": "DeleteAuditPolicy request structure.",
6357
+ "members": [
6358
+ {
6359
+ "disabled": false,
6360
+ "document": "Audit policy ID.",
6361
+ "example": "cdbpolicy-234",
6362
+ "member": "string",
6363
+ "name": "PolicyId",
6364
+ "required": true,
6365
+ "type": "string"
6366
+ },
6367
+ {
6368
+ "disabled": false,
6369
+ "document": "Instance ID.",
6370
+ "example": "cdb-0ej6n21d",
6371
+ "member": "string",
6372
+ "name": "InstanceId",
6373
+ "required": false,
6374
+ "type": "string"
6375
+ }
6376
+ ],
6377
+ "type": "object"
6378
+ },
6379
+ "DeleteAuditPolicyResponse": {
6380
+ "document": "DeleteAuditPolicy response structure.",
6381
+ "members": [
6382
+ {
6383
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6384
+ "member": "string",
6385
+ "name": "RequestId",
6386
+ "type": "string"
6387
+ }
6388
+ ],
6389
+ "type": "object"
6390
+ },
6391
+ "DeleteAuditRuleTemplatesRequest": {
6392
+ "document": "DeleteAuditRuleTemplates request structure.",
6393
+ "members": [
6394
+ {
6395
+ "disabled": false,
6396
+ "document": "Audit rule template ID, which can be obtained through the [DescribeAuditRuleTemplates](https://www.tencentcloud.comom/document/api/236/101811?from_cn_redirect=1) API. A maximum of 5 rule templates can be deleted per request.",
6397
+ "example": "cdb-art-l1mlbo59",
6398
+ "member": "string",
6399
+ "name": "RuleTemplateIds",
6400
+ "required": true,
6401
+ "type": "list"
6402
+ }
6403
+ ],
6404
+ "type": "object"
6405
+ },
6406
+ "DeleteAuditRuleTemplatesResponse": {
6407
+ "document": "DeleteAuditRuleTemplates response structure.",
6408
+ "members": [
6409
+ {
6410
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6411
+ "member": "string",
6412
+ "name": "RequestId",
6413
+ "type": "string"
6414
+ }
6415
+ ],
6416
+ "type": "object"
6417
+ },
5618
6418
  "DeleteBackupRequest": {
5619
6419
  "document": "DeleteBackup request structure.",
5620
6420
  "members": [
@@ -5921,33 +6721,267 @@
5921
6721
  ],
5922
6722
  "type": "object"
5923
6723
  },
5924
- "DescribeAuditLogsRequest": {
5925
- "document": "DescribeAuditLogs request structure.",
6724
+ "DescribeAuditConfigRequest": {
6725
+ "document": "DescribeAuditConfig request structure.",
5926
6726
  "members": [
5927
6727
  {
5928
6728
  "disabled": false,
5929
- "document": "Instance ID",
5930
- "example": "cdb-of5qmu1b",
6729
+ "document": "Instance ID, in the format such as cdb-c1nl9rpv or cdbro-c1nl9rpv. This matches the instance ID displayed on the TencentDB console.",
6730
+ "example": "cdb-txcniupi",
5931
6731
  "member": "string",
5932
6732
  "name": "InstanceId",
5933
6733
  "required": true,
5934
6734
  "type": "string"
6735
+ }
6736
+ ],
6737
+ "type": "object"
6738
+ },
6739
+ "DescribeAuditConfigResponse": {
6740
+ "document": "DescribeAuditConfig response structure.",
6741
+ "members": [
6742
+ {
6743
+ "disabled": false,
6744
+ "document": "Audit log retention period. Valid values: [0, 7, 30, 180, 365, 1095, 1825].",
6745
+ "example": "365",
6746
+ "member": "int64",
6747
+ "name": "LogExpireDay",
6748
+ "output_required": true,
6749
+ "type": "int",
6750
+ "value_allowed_null": false
5935
6751
  },
5936
6752
  {
5937
6753
  "disabled": false,
5938
- "document": "Start time",
5939
- "example": "2023-06-18 00:00:00",
6754
+ "document": "Audit log storage type. Valid value: \"storage\" - Storage type.",
6755
+ "example": "\"storage\"",
5940
6756
  "member": "string",
5941
- "name": "StartTime",
5942
- "required": true,
5943
- "type": "string"
6757
+ "name": "LogType",
6758
+ "output_required": true,
6759
+ "type": "string",
6760
+ "value_allowed_null": false
5944
6761
  },
5945
6762
  {
5946
6763
  "disabled": false,
5947
- "document": "End time",
5948
- "example": "2023-06-19 00:00:00",
6764
+ "document": "Whether the audit service is being disabled. Valid values: \"false\" - No, \"true\" - Yes.",
6765
+ "example": "\"false\"",
5949
6766
  "member": "string",
5950
- "name": "EndTime",
6767
+ "name": "IsClosing",
6768
+ "output_required": true,
6769
+ "type": "string",
6770
+ "value_allowed_null": false
6771
+ },
6772
+ {
6773
+ "disabled": false,
6774
+ "document": "Whether the audit service is being enabled. Valid values: \"false\" - No, \"true\" - Yes.",
6775
+ "example": "\"true\"",
6776
+ "member": "string",
6777
+ "name": "IsOpening",
6778
+ "output_required": false,
6779
+ "type": "string",
6780
+ "value_allowed_null": false
6781
+ },
6782
+ {
6783
+ "disabled": false,
6784
+ "document": "Time when the audit service was activated.",
6785
+ "example": "\"2021-07-13 11:34:35“",
6786
+ "member": "string",
6787
+ "name": "CreateTime",
6788
+ "output_required": true,
6789
+ "type": "string",
6790
+ "value_allowed_null": false
6791
+ },
6792
+ {
6793
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6794
+ "member": "string",
6795
+ "name": "RequestId",
6796
+ "type": "string"
6797
+ }
6798
+ ],
6799
+ "type": "object"
6800
+ },
6801
+ "DescribeAuditInstanceListRequest": {
6802
+ "document": "DescribeAuditInstanceList request structure.",
6803
+ "members": [
6804
+ {
6805
+ "disabled": false,
6806
+ "document": "Whether audit is enabled for the instance. Valid values: 1 - Enabled; 0 - Disabled.",
6807
+ "example": "1",
6808
+ "member": "int64",
6809
+ "name": "AuditSwitch",
6810
+ "required": false,
6811
+ "type": "int"
6812
+ },
6813
+ {
6814
+ "disabled": false,
6815
+ "document": "Filter conditions for querying the instance list.",
6816
+ "example": "[{\"Values\": [\"cdb-euu5fkcj\"], \"Name\": \"InstanceId\",\"ExactMatch\": true}]",
6817
+ "member": "AuditInstanceFilters",
6818
+ "name": "Filters",
6819
+ "required": false,
6820
+ "type": "list"
6821
+ },
6822
+ {
6823
+ "disabled": false,
6824
+ "document": "Audit rule mode for the instance. Valid values: 1 - Rule-based audit; 0 - Full audit.",
6825
+ "example": "1",
6826
+ "member": "int64",
6827
+ "name": "AuditMode",
6828
+ "required": false,
6829
+ "type": "int"
6830
+ },
6831
+ {
6832
+ "disabled": false,
6833
+ "document": "Number of entries to return per request. Default value: 30. Maximum value: 20000.",
6834
+ "example": "10",
6835
+ "member": "uint64",
6836
+ "name": "Limit",
6837
+ "required": false,
6838
+ "type": "int"
6839
+ },
6840
+ {
6841
+ "disabled": false,
6842
+ "document": "Offset. Default value: 0.",
6843
+ "example": "1",
6844
+ "member": "uint64",
6845
+ "name": "Offset",
6846
+ "required": false,
6847
+ "type": "int"
6848
+ }
6849
+ ],
6850
+ "type": "object"
6851
+ },
6852
+ "DescribeAuditInstanceListResponse": {
6853
+ "document": "DescribeAuditInstanceList response structure.",
6854
+ "members": [
6855
+ {
6856
+ "disabled": false,
6857
+ "document": "Total number of eligible instances.",
6858
+ "example": "0",
6859
+ "member": "uint64",
6860
+ "name": "TotalCount",
6861
+ "output_required": true,
6862
+ "type": "int",
6863
+ "value_allowed_null": false
6864
+ },
6865
+ {
6866
+ "disabled": false,
6867
+ "document": "List of audit instance details.Note: This field may return null, indicating that no valid values can be obtained.",
6868
+ "example": "[{\"BillingAmount\": 0,\"LowRealStorage\": 0,\"InstanceId\": \"cdb-euu5fkcj\",\"AuditTask\": 1,\"CreateAt\": \"2022-03-02 10:09:08\",\"AuditStatus\": \"1\"...}]",
6869
+ "member": "InstanceDbAuditStatus",
6870
+ "name": "Items",
6871
+ "output_required": true,
6872
+ "type": "list",
6873
+ "value_allowed_null": true
6874
+ },
6875
+ {
6876
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6877
+ "member": "string",
6878
+ "name": "RequestId",
6879
+ "type": "string"
6880
+ }
6881
+ ],
6882
+ "type": "object"
6883
+ },
6884
+ "DescribeAuditLogFilesRequest": {
6885
+ "document": "DescribeAuditLogFiles request structure.",
6886
+ "members": [
6887
+ {
6888
+ "disabled": false,
6889
+ "document": "Instance ID, in the format such as cdb-c1nl9rpv or cdbro-c1nl9rpv. This matches the instance ID displayed on the TencentDB console.",
6890
+ "example": "cdb-qwerasdf",
6891
+ "member": "string",
6892
+ "name": "InstanceId",
6893
+ "required": true,
6894
+ "type": "string"
6895
+ },
6896
+ {
6897
+ "disabled": false,
6898
+ "document": "Page size. Default value: 20; minimum value: 1; maximum value: 300.",
6899
+ "example": "10",
6900
+ "member": "int64",
6901
+ "name": "Limit",
6902
+ "required": false,
6903
+ "type": "int"
6904
+ },
6905
+ {
6906
+ "disabled": false,
6907
+ "document": "Pagination offset.",
6908
+ "example": "0",
6909
+ "member": "int64",
6910
+ "name": "Offset",
6911
+ "required": false,
6912
+ "type": "int"
6913
+ },
6914
+ {
6915
+ "disabled": false,
6916
+ "document": "Audit log file name.",
6917
+ "example": "shenji_andy",
6918
+ "member": "string",
6919
+ "name": "FileName",
6920
+ "required": false,
6921
+ "type": "string"
6922
+ }
6923
+ ],
6924
+ "type": "object"
6925
+ },
6926
+ "DescribeAuditLogFilesResponse": {
6927
+ "document": "DescribeAuditLogFiles response structure.",
6928
+ "members": [
6929
+ {
6930
+ "disabled": false,
6931
+ "document": "Number of eligible audit log files.",
6932
+ "example": "1",
6933
+ "member": "int64",
6934
+ "name": "TotalCount",
6935
+ "output_required": true,
6936
+ "type": "int",
6937
+ "value_allowed_null": false
6938
+ },
6939
+ {
6940
+ "disabled": false,
6941
+ "document": "Audit log file details.",
6942
+ "example": "[{\"FileName\": \"shenji_andy\", \"CreateTime\": \"2024-03-20 17:09:13\",\"Status\": \"success\"...}]",
6943
+ "member": "AuditLogFile",
6944
+ "name": "Items",
6945
+ "output_required": true,
6946
+ "type": "list",
6947
+ "value_allowed_null": false
6948
+ },
6949
+ {
6950
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
6951
+ "member": "string",
6952
+ "name": "RequestId",
6953
+ "type": "string"
6954
+ }
6955
+ ],
6956
+ "type": "object"
6957
+ },
6958
+ "DescribeAuditLogsRequest": {
6959
+ "document": "DescribeAuditLogs request structure.",
6960
+ "members": [
6961
+ {
6962
+ "disabled": false,
6963
+ "document": "Instance ID",
6964
+ "example": "cdb-of5qmu1b",
6965
+ "member": "string",
6966
+ "name": "InstanceId",
6967
+ "required": true,
6968
+ "type": "string"
6969
+ },
6970
+ {
6971
+ "disabled": false,
6972
+ "document": "Start time",
6973
+ "example": "2023-06-18 00:00:00",
6974
+ "member": "string",
6975
+ "name": "StartTime",
6976
+ "required": true,
6977
+ "type": "string"
6978
+ },
6979
+ {
6980
+ "disabled": false,
6981
+ "document": "End time",
6982
+ "example": "2023-06-19 00:00:00",
6983
+ "member": "string",
6984
+ "name": "EndTime",
5951
6985
  "required": true,
5952
6986
  "type": "string"
5953
6987
  },
@@ -6132,6 +7166,190 @@
6132
7166
  ],
6133
7167
  "type": "object"
6134
7168
  },
7169
+ "DescribeAuditRuleTemplateModifyHistoryRequest": {
7170
+ "document": "DescribeAuditRuleTemplateModifyHistory request structure.",
7171
+ "members": [
7172
+ {
7173
+ "disabled": false,
7174
+ "document": "Audit rule template ID, which can be obtained through the [DescribeAuditRuleTemplates](https://www.tencentcloud.comom/document/api/236/101811?from_cn_redirect=1) API.",
7175
+ "example": "[\"cdb-art-8qx2kcr7\"]",
7176
+ "member": "string",
7177
+ "name": "RuleTemplateIds",
7178
+ "required": false,
7179
+ "type": "list"
7180
+ },
7181
+ {
7182
+ "disabled": false,
7183
+ "document": "Start time of the query range.",
7184
+ "example": "2023-08-01 00:00:00",
7185
+ "member": "string",
7186
+ "name": "StartTime",
7187
+ "required": false,
7188
+ "type": "string"
7189
+ },
7190
+ {
7191
+ "disabled": false,
7192
+ "document": "End time of the query range.",
7193
+ "example": "2023-08-02 00:00:00",
7194
+ "member": "string",
7195
+ "name": "EndTime",
7196
+ "required": false,
7197
+ "type": "string"
7198
+ },
7199
+ {
7200
+ "disabled": false,
7201
+ "document": "Number of entries to return. Default value: 20. Maximum value: 1000.",
7202
+ "example": "10",
7203
+ "member": "uint64",
7204
+ "name": "Limit",
7205
+ "required": false,
7206
+ "type": "int"
7207
+ },
7208
+ {
7209
+ "disabled": false,
7210
+ "document": "Offset.",
7211
+ "example": "0",
7212
+ "member": "uint64",
7213
+ "name": "Offset",
7214
+ "required": false,
7215
+ "type": "int"
7216
+ },
7217
+ {
7218
+ "disabled": false,
7219
+ "document": "Sort order. DESC - Sorted by modification time in descending order, ASC - Ascending order. Default value: DESC.",
7220
+ "example": "DESC",
7221
+ "member": "string",
7222
+ "name": "Order",
7223
+ "required": false,
7224
+ "type": "string"
7225
+ }
7226
+ ],
7227
+ "type": "object"
7228
+ },
7229
+ "DescribeAuditRuleTemplateModifyHistoryResponse": {
7230
+ "document": "DescribeAuditRuleTemplateModifyHistory response structure.",
7231
+ "members": [
7232
+ {
7233
+ "disabled": false,
7234
+ "document": "Total number of entries.",
7235
+ "example": "10",
7236
+ "member": "int64",
7237
+ "name": "TotalCount",
7238
+ "output_required": false,
7239
+ "type": "int",
7240
+ "value_allowed_null": false
7241
+ },
7242
+ {
7243
+ "disabled": false,
7244
+ "document": "Change details.",
7245
+ "example": "[\"TaskId\": 12,\"ModifyBeforeInfo\": {},\"ModifyAfterInfo\": {},\"AffectedInstances\": [\"cdb-xqwe\"],\"Operator\": \"700000579947\",\"UpdateTime\": \"2023-07-26 00:09:00\"}]",
7246
+ "member": "RuleTemplateRecordInfo",
7247
+ "name": "Items",
7248
+ "output_required": false,
7249
+ "type": "list",
7250
+ "value_allowed_null": false
7251
+ },
7252
+ {
7253
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
7254
+ "member": "string",
7255
+ "name": "RequestId",
7256
+ "type": "string"
7257
+ }
7258
+ ],
7259
+ "type": "object"
7260
+ },
7261
+ "DescribeAuditRuleTemplatesRequest": {
7262
+ "document": "DescribeAuditRuleTemplates request structure.",
7263
+ "members": [
7264
+ {
7265
+ "disabled": false,
7266
+ "document": "Rule template ID.",
7267
+ "example": "cdb-art-nuzwpha1",
7268
+ "member": "string",
7269
+ "name": "RuleTemplateIds",
7270
+ "required": false,
7271
+ "type": "list"
7272
+ },
7273
+ {
7274
+ "disabled": false,
7275
+ "document": "Rule template name.",
7276
+ "example": "测试template",
7277
+ "member": "string",
7278
+ "name": "RuleTemplateNames",
7279
+ "required": false,
7280
+ "type": "list"
7281
+ },
7282
+ {
7283
+ "disabled": false,
7284
+ "document": "Number of entries to return per request. Default value: 20. Maximum value: 1000.",
7285
+ "example": "10",
7286
+ "member": "uint64",
7287
+ "name": "Limit",
7288
+ "required": false,
7289
+ "type": "int"
7290
+ },
7291
+ {
7292
+ "disabled": false,
7293
+ "document": "Offset. Default value: 0.",
7294
+ "example": "0",
7295
+ "member": "uint64",
7296
+ "name": "Offset",
7297
+ "required": false,
7298
+ "type": "int"
7299
+ },
7300
+ {
7301
+ "disabled": false,
7302
+ "document": "Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk.",
7303
+ "example": "3",
7304
+ "member": "uint64",
7305
+ "name": "AlarmLevel",
7306
+ "required": false,
7307
+ "type": "int"
7308
+ },
7309
+ {
7310
+ "disabled": false,
7311
+ "document": "Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled.",
7312
+ "example": "1",
7313
+ "member": "uint64",
7314
+ "name": "AlarmPolicy",
7315
+ "required": false,
7316
+ "type": "int"
7317
+ }
7318
+ ],
7319
+ "type": "object"
7320
+ },
7321
+ "DescribeAuditRuleTemplatesResponse": {
7322
+ "document": "DescribeAuditRuleTemplates response structure.",
7323
+ "members": [
7324
+ {
7325
+ "disabled": false,
7326
+ "document": "Total number of eligible instances.",
7327
+ "example": "2",
7328
+ "member": "uint64",
7329
+ "name": "TotalCount",
7330
+ "output_required": true,
7331
+ "type": "int",
7332
+ "value_allowed_null": false
7333
+ },
7334
+ {
7335
+ "disabled": false,
7336
+ "document": "List of rule template details.",
7337
+ "example": "[\"Description\": \"all_template_des\",\"RuleFilters\": [{\"Compare\": \"INC\"}],\"RuleTemplateId\": \"cdb-art-lcpm4as3\"}]",
7338
+ "member": "AuditRuleTemplateInfo",
7339
+ "name": "Items",
7340
+ "output_required": true,
7341
+ "type": "list",
7342
+ "value_allowed_null": false
7343
+ },
7344
+ {
7345
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
7346
+ "member": "string",
7347
+ "name": "RequestId",
7348
+ "type": "string"
7349
+ }
7350
+ ],
7351
+ "type": "object"
7352
+ },
6135
7353
  "DescribeAuditRulesRequest": {
6136
7354
  "document": "DescribeAuditRules request structure.",
6137
7355
  "members": [
@@ -7448,7 +8666,7 @@
7448
8666
  "example": "0",
7449
8667
  "member": "int64",
7450
8668
  "name": "ProtectMode",
7451
- "required": true,
8669
+ "output_required": true,
7452
8670
  "type": "int",
7453
8671
  "value_allowed_null": false
7454
8672
  },
@@ -7458,17 +8676,17 @@
7458
8676
  "example": "1",
7459
8677
  "member": "int64",
7460
8678
  "name": "DeployMode",
7461
- "required": true,
8679
+ "output_required": true,
7462
8680
  "type": "int",
7463
8681
  "value_allowed_null": false
7464
8682
  },
7465
8683
  {
7466
8684
  "disabled": false,
7467
- "document": "Instance AZ information in the format of \"ap-shanghai-1\".",
8685
+ "document": "Instance AZ information in the format of \"ap-shanghai-2\".",
7468
8686
  "example": "ap-guangzhou-3",
7469
8687
  "member": "string",
7470
8688
  "name": "Zone",
7471
- "required": true,
8689
+ "output_required": true,
7472
8690
  "type": "string",
7473
8691
  "value_allowed_null": false
7474
8692
  },
@@ -7478,7 +8696,7 @@
7478
8696
  "example": "无",
7479
8697
  "member": "SlaveConfig",
7480
8698
  "name": "SlaveConfig",
7481
- "required": true,
8699
+ "output_required": true,
7482
8700
  "type": "object",
7483
8701
  "value_allowed_null": true
7484
8702
  },
@@ -7488,7 +8706,7 @@
7488
8706
  "example": "无",
7489
8707
  "member": "BackupConfig",
7490
8708
  "name": "BackupConfig",
7491
- "required": true,
8709
+ "output_required": true,
7492
8710
  "type": "object",
7493
8711
  "value_allowed_null": true
7494
8712
  },
@@ -7498,7 +8716,7 @@
7498
8716
  "example": "false",
7499
8717
  "member": "bool",
7500
8718
  "name": "Switched",
7501
- "required": true,
8719
+ "output_required": true,
7502
8720
  "type": "bool",
7503
8721
  "value_allowed_null": false
7504
8722
  },
@@ -7744,7 +8962,7 @@
7744
8962
  {
7745
8963
  "disabled": false,
7746
8964
  "document": "Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).",
7747
- "example": "1",
8965
+ "example": "[1]",
7748
8966
  "member": "uint64",
7749
8967
  "name": "InstanceTypes",
7750
8968
  "required": false,
@@ -7753,7 +8971,7 @@
7753
8971
  {
7754
8972
  "disabled": false,
7755
8973
  "document": "Private IP address of the instance.",
7756
- "example": "\"\"",
8974
+ "example": "[\"172.1.1.1\"]",
7757
8975
  "member": "string",
7758
8976
  "name": "Vips",
7759
8977
  "required": false,
@@ -7762,7 +8980,7 @@
7762
8980
  {
7763
8981
  "disabled": false,
7764
8982
  "document": "Instance status. Valid values: <br>`0` (creating) <br>`1` (running) <br>`4` (isolating) <br>`5` (isolated; the instance can be restored and started in the recycle bin)",
7765
- "example": "1",
8983
+ "example": "[1]",
7766
8984
  "member": "uint64",
7767
8985
  "name": "Status",
7768
8986
  "required": false,
@@ -7789,7 +9007,7 @@
7789
9007
  {
7790
9008
  "disabled": false,
7791
9009
  "document": "Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.",
7792
- "example": "\"\"",
9010
+ "example": "sg-ajr1jzgj",
7793
9011
  "member": "string",
7794
9012
  "name": "SecurityGroupId",
7795
9013
  "required": false,
@@ -7797,8 +9015,8 @@
7797
9015
  },
7798
9016
  {
7799
9017
  "disabled": false,
7800
- "document": "Billing method. Value range: 0 (monthly subscribed), 1 (hourly).",
7801
- "example": "1",
9018
+ "document": "Payment type. Valid values: 0 - yearly/monthly subscription; 1 - bill by hour.",
9019
+ "example": "[1]",
7802
9020
  "member": "uint64",
7803
9021
  "name": "PayTypes",
7804
9022
  "required": false,
@@ -7807,7 +9025,7 @@
7807
9025
  {
7808
9026
  "disabled": false,
7809
9027
  "document": "Instance name.",
7810
- "example": "\"\"",
9028
+ "example": "[\"cdb27418\"]",
7811
9029
  "member": "string",
7812
9030
  "name": "InstanceNames",
7813
9031
  "required": false,
@@ -7815,8 +9033,8 @@
7815
9033
  },
7816
9034
  {
7817
9035
  "disabled": false,
7818
- "document": "Instance task status. Valid values: <br>0 - no task <br>1 - upgrading <br>2 - importing data <br>3 - enabling secondary instance access <br>4 - enabling public network access <br>5 - batch operation in progress <br>6 - rolling back <br>7 - disabling public network access <br>8 - modifying password <br>9 - renaming instance <br>10 - restarting <br>12 - migrating self-built database <br>13 - dropping tables <br>14 - Disaster recovery instance creating sync task <br>15 - waiting for switch <br>16 - switching <br>17 - upgrade and switch completed <br>19 - parameter settings to be executed",
7819
- "example": "0",
9036
+ "document": "Instance task status. Valid values:<br>0 - no task;<br>1 - upgrading;<br>2 - importing data;<br>3 - enabling secondary nodes;<br>4 - enabling public network access;<br>5 - executing batch operations;<br>6 - rolling back;<br>7 - disabling public network access;<br>8 - changing the password;<br>9 - renaming the instance;<br>10 - restarting;<br>12 - migrating self-built databases;<br>13 - deleting databases and tables;<br>14 - synchronizing the creation of disaster recovery instances;<br>15 - pending upgrade switch;<br>16 - under upgrade switch;<br>17 - upgrade switch completed;<br>19 - parameter settings pending execution;<br>34 - in-place upgrade pending execution.",
9037
+ "example": "[0]",
7820
9038
  "member": "uint64",
7821
9039
  "name": "TaskStatus",
7822
9040
  "required": false,
@@ -7825,7 +9043,7 @@
7825
9043
  {
7826
9044
  "disabled": false,
7827
9045
  "document": "Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.",
7828
- "example": "\"5.6\"",
9046
+ "example": "[\"5.7\",\"8.0\"]",
7829
9047
  "member": "string",
7830
9048
  "name": "EngineVersions",
7831
9049
  "required": false,
@@ -7834,7 +9052,7 @@
7834
9052
  {
7835
9053
  "disabled": false,
7836
9054
  "document": "VPC ID.",
7837
- "example": "0",
9055
+ "example": "[0]",
7838
9056
  "member": "uint64",
7839
9057
  "name": "VpcIds",
7840
9058
  "required": false,
@@ -7843,7 +9061,7 @@
7843
9061
  {
7844
9062
  "disabled": false,
7845
9063
  "document": "AZ ID.",
7846
- "example": "720001",
9064
+ "example": "[720001]",
7847
9065
  "member": "uint64",
7848
9066
  "name": "ZoneIds",
7849
9067
  "required": false,
@@ -7852,7 +9070,7 @@
7852
9070
  {
7853
9071
  "disabled": false,
7854
9072
  "document": "Subnet ID.",
7855
- "example": "0",
9073
+ "example": "[0]",
7856
9074
  "member": "uint64",
7857
9075
  "name": "SubnetIds",
7858
9076
  "required": false,
@@ -7861,7 +9079,7 @@
7861
9079
  {
7862
9080
  "disabled": false,
7863
9081
  "document": "Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.",
7864
- "example": "0",
9082
+ "example": "[0]",
7865
9083
  "member": "int64",
7866
9084
  "name": "CdbErrors",
7867
9085
  "required": false,
@@ -7869,8 +9087,8 @@
7869
9087
  },
7870
9088
  {
7871
9089
  "disabled": false,
7872
- "document": "Sort by field of the returned result set. Currently, supported values include \"InstanceId\", \"InstanceName\", \"CreateTime\", and \"DeadlineTime\".",
7873
- "example": "\"\"",
9090
+ "document": "Sorting field of the query results. Valid values: \"instanceId\", \"instanceName\", \"createTime\", and \"deadlineTime\".",
9091
+ "example": "instanceId",
7874
9092
  "member": "string",
7875
9093
  "name": "OrderBy",
7876
9094
  "required": false,
@@ -7878,7 +9096,7 @@
7878
9096
  },
7879
9097
  {
7880
9098
  "disabled": false,
7881
- "document": "Sorting method of the returned result set. Currently, \"ASC\" or \"DESC\" is supported.",
9099
+ "document": "Sorting method of the returned result set. Valid values: \"ASC\" - ascending order; \"DESC\" - descending order. The default value is \"DESC\".",
7882
9100
  "example": "\"DESC\"",
7883
9101
  "member": "string",
7884
9102
  "name": "OrderDirection",
@@ -7887,7 +9105,7 @@
7887
9105
  },
7888
9106
  {
7889
9107
  "disabled": false,
7890
- "document": "Whether security group ID is used as a filter",
9108
+ "document": "Whether to use the security group ID as the filter condition.\nNote: 0 indicates no; 1 indicates yes.",
7891
9109
  "example": "0",
7892
9110
  "member": "int64",
7893
9111
  "name": "WithSecurityGroup",
@@ -7906,7 +9124,7 @@
7906
9124
  {
7907
9125
  "disabled": false,
7908
9126
  "document": "Exclusive cluster ID.",
7909
- "example": "\"\"",
9127
+ "example": "cdb-g2ql0j11",
7910
9128
  "member": "string",
7911
9129
  "name": "ExClusterId",
7912
9130
  "required": false,
@@ -7915,7 +9133,7 @@
7915
9133
  {
7916
9134
  "disabled": false,
7917
9135
  "document": "Instance ID.",
7918
- "example": "[\"cdb-70zdmgg1\\r\\n\"]",
9136
+ "example": "[\"cdb-70zdmgg1\"]",
7919
9137
  "member": "string",
7920
9138
  "name": "InstanceIds",
7921
9139
  "required": false,
@@ -7960,7 +9178,7 @@
7960
9178
  {
7961
9179
  "disabled": false,
7962
9180
  "document": "Placement group ID list.",
7963
- "example": "\"\"",
9181
+ "example": "[\"ps-7t11vrwf\"]",
7964
9182
  "member": "string",
7965
9183
  "name": "DeployGroupIds",
7966
9184
  "required": false,
@@ -7969,7 +9187,7 @@
7969
9187
  {
7970
9188
  "disabled": false,
7971
9189
  "document": "Whether to use the tag key as a filter condition",
7972
- "example": "[\"\"]",
9190
+ "example": "[\"tagKey\"]",
7973
9191
  "member": "string",
7974
9192
  "name": "TagKeysForSearch",
7975
9193
  "required": false,
@@ -7978,7 +9196,7 @@
7978
9196
  {
7979
9197
  "disabled": false,
7980
9198
  "document": "Financial cage IDs.",
7981
- "example": "[\"cage-test\"]",
9199
+ "example": "[\"cage-dhges\"]",
7982
9200
  "member": "string",
7983
9201
  "name": "CageIds",
7984
9202
  "required": false,
@@ -8013,7 +9231,7 @@
8013
9231
  },
8014
9232
  {
8015
9233
  "disabled": false,
8016
- "document": "Tag key value",
9234
+ "document": "Tag key value.\nNote that tags cannot be queried for instances being created.",
8017
9235
  "example": "无",
8018
9236
  "member": "Tag",
8019
9237
  "name": "Tags",
@@ -8040,12 +9258,21 @@
8040
9258
  },
8041
9259
  {
8042
9260
  "disabled": false,
8043
- "document": "Database engine type",
9261
+ "document": "Database engine type. Valid values: InnoDB; RocksDB.",
8044
9262
  "example": "[\"InnoDB\"]",
8045
9263
  "member": "string",
8046
9264
  "name": "EngineTypes",
8047
9265
  "required": false,
8048
9266
  "type": "list"
9267
+ },
9268
+ {
9269
+ "disabled": false,
9270
+ "document": "Whether to obtain the Cluster Edition instance node information. Valid values: true or false. The default value is false.",
9271
+ "example": "false",
9272
+ "member": "bool",
9273
+ "name": "QueryClusterInfo",
9274
+ "required": false,
9275
+ "type": "bool"
8049
9276
  }
8050
9277
  ],
8051
9278
  "type": "object"
@@ -10661,7 +11888,7 @@
10661
11888
  "example": "1",
10662
11889
  "member": "int64",
10663
11890
  "name": "Status",
10664
- "required": true,
11891
+ "output_required": true,
10665
11892
  "type": "int",
10666
11893
  "value_allowed_null": false
10667
11894
  },
@@ -10671,7 +11898,7 @@
10671
11898
  "example": "ap-beijing-3",
10672
11899
  "member": "string",
10673
11900
  "name": "Zone",
10674
- "required": true,
11901
+ "output_required": true,
10675
11902
  "type": "string",
10676
11903
  "value_allowed_null": false
10677
11904
  },
@@ -10681,7 +11908,7 @@
10681
11908
  "example": "cdb-***",
10682
11909
  "member": "string",
10683
11910
  "name": "InstanceId",
10684
- "required": true,
11911
+ "output_required": true,
10685
11912
  "type": "string",
10686
11913
  "value_allowed_null": false
10687
11914
  },
@@ -10691,7 +11918,7 @@
10691
11918
  "example": "ap-beijing",
10692
11919
  "member": "string",
10693
11920
  "name": "Region",
10694
- "required": true,
11921
+ "output_required": true,
10695
11922
  "type": "string",
10696
11923
  "value_allowed_null": false
10697
11924
  },
@@ -10701,7 +11928,7 @@
10701
11928
  "example": "2",
10702
11929
  "member": "int64",
10703
11930
  "name": "SyncStatus",
10704
- "required": true,
11931
+ "output_required": true,
10705
11932
  "type": "int",
10706
11933
  "value_allowed_null": false
10707
11934
  },
@@ -10711,7 +11938,7 @@
10711
11938
  "example": "******",
10712
11939
  "member": "string",
10713
11940
  "name": "InstanceName",
10714
- "required": true,
11941
+ "output_required": true,
10715
11942
  "type": "string",
10716
11943
  "value_allowed_null": false
10717
11944
  },
@@ -10721,7 +11948,7 @@
10721
11948
  "example": "2",
10722
11949
  "member": "int64",
10723
11950
  "name": "InstanceType",
10724
- "required": true,
11951
+ "output_required": true,
10725
11952
  "type": "int",
10726
11953
  "value_allowed_null": false
10727
11954
  }
@@ -10986,13 +12213,219 @@
10986
12213
  ],
10987
12214
  "usage": "in"
10988
12215
  },
12216
+ "InstanceDbAuditStatus": {
12217
+ "document": "Instance audit details.",
12218
+ "members": [
12219
+ {
12220
+ "disabled": false,
12221
+ "document": "Instance ID.",
12222
+ "example": "cdb-euu5fkcj",
12223
+ "member": "string",
12224
+ "name": "InstanceId",
12225
+ "output_required": true,
12226
+ "type": "string",
12227
+ "value_allowed_null": false
12228
+ },
12229
+ {
12230
+ "disabled": false,
12231
+ "document": "Audit status. ON - Audit is enabled, OFF - Audit is disabled.",
12232
+ "example": "ON",
12233
+ "member": "string",
12234
+ "name": "AuditStatus",
12235
+ "output_required": true,
12236
+ "type": "string",
12237
+ "value_allowed_null": false
12238
+ },
12239
+ {
12240
+ "disabled": false,
12241
+ "document": "Task status. Valid values: 0 - No task; 1 - Enabling audit; 2 - Disabling audit.",
12242
+ "example": "0",
12243
+ "member": "uint64",
12244
+ "name": "AuditTask",
12245
+ "output_required": true,
12246
+ "type": "int",
12247
+ "value_allowed_null": false
12248
+ },
12249
+ {
12250
+ "disabled": false,
12251
+ "document": "Log retention period. Valid values:7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
12252
+ "example": "30",
12253
+ "member": "uint64",
12254
+ "name": "LogExpireDay",
12255
+ "output_required": true,
12256
+ "type": "int",
12257
+ "value_allowed_null": false
12258
+ },
12259
+ {
12260
+ "disabled": false,
12261
+ "document": "High-frequency storage period. Valid values:3 - 3 days;7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
12262
+ "example": "7",
12263
+ "member": "uint64",
12264
+ "name": "HighLogExpireDay",
12265
+ "output_required": true,
12266
+ "type": "int",
12267
+ "value_allowed_null": false
12268
+ },
12269
+ {
12270
+ "disabled": false,
12271
+ "document": "Low-frequency storage period (in days). This equals the log retention period minus the high-frequency storage period.",
12272
+ "example": "23",
12273
+ "member": "uint64",
12274
+ "name": "LowLogExpireDay",
12275
+ "output_required": true,
12276
+ "type": "int",
12277
+ "value_allowed_null": false
12278
+ },
12279
+ {
12280
+ "disabled": false,
12281
+ "document": "Log storage volume (in GB).",
12282
+ "example": "173749.248",
12283
+ "member": "float",
12284
+ "name": "BillingAmount",
12285
+ "output_required": true,
12286
+ "type": "float",
12287
+ "value_allowed_null": false
12288
+ },
12289
+ {
12290
+ "disabled": false,
12291
+ "document": "High-frequency storage volume (in GB).",
12292
+ "example": "45639.68",
12293
+ "member": "float",
12294
+ "name": "HighRealStorage",
12295
+ "output_required": true,
12296
+ "type": "float",
12297
+ "value_allowed_null": false
12298
+ },
12299
+ {
12300
+ "disabled": false,
12301
+ "document": "Low-frequency storage volume (in GB).",
12302
+ "example": "128109.568",
12303
+ "member": "float",
12304
+ "name": "LowRealStorage",
12305
+ "output_required": true,
12306
+ "type": "float",
12307
+ "value_allowed_null": false
12308
+ },
12309
+ {
12310
+ "disabled": false,
12311
+ "document": "Whether full audit is enabled. true - Full audit.",
12312
+ "example": "true",
12313
+ "member": "bool",
12314
+ "name": "AuditAll",
12315
+ "output_required": true,
12316
+ "type": "bool",
12317
+ "value_allowed_null": false
12318
+ },
12319
+ {
12320
+ "disabled": false,
12321
+ "document": "Time when the audit service was activated.",
12322
+ "example": "2022-10-12 11:41:42",
12323
+ "member": "string",
12324
+ "name": "CreateAt",
12325
+ "output_required": true,
12326
+ "type": "string",
12327
+ "value_allowed_null": false
12328
+ },
12329
+ {
12330
+ "disabled": false,
12331
+ "document": "Related information about the instance.",
12332
+ "example": "无",
12333
+ "member": "AuditInstanceInfo",
12334
+ "name": "InstanceInfo",
12335
+ "output_required": true,
12336
+ "type": "object",
12337
+ "value_allowed_null": false
12338
+ },
12339
+ {
12340
+ "disabled": false,
12341
+ "document": "Total storage volume (in GB).",
12342
+ "example": "173749.248",
12343
+ "member": "float",
12344
+ "name": "RealStorage",
12345
+ "output_required": true,
12346
+ "type": "float",
12347
+ "value_allowed_null": false
12348
+ },
12349
+ {
12350
+ "disabled": false,
12351
+ "document": "Whether an audit policy is configured.",
12352
+ "example": "false",
12353
+ "member": "bool",
12354
+ "name": "OldRule",
12355
+ "output_required": true,
12356
+ "type": "bool",
12357
+ "value_allowed_null": false
12358
+ },
12359
+ {
12360
+ "disabled": false,
12361
+ "document": "Rule template applied to the instance.",
12362
+ "example": "[\"cdb-art-8qx2kcr7\"]",
12363
+ "member": "string",
12364
+ "name": "RuleTemplateIds",
12365
+ "output_required": false,
12366
+ "type": "list",
12367
+ "value_allowed_null": false
12368
+ },
12369
+ {
12370
+ "disabled": false,
12371
+ "document": "Trial status.",
12372
+ "example": "\"TRIAL/EXPIRED/NONE\"",
12373
+ "member": "string",
12374
+ "name": "TrialStatus",
12375
+ "output_required": false,
12376
+ "type": "string",
12377
+ "value_allowed_null": false
12378
+ },
12379
+ {
12380
+ "disabled": false,
12381
+ "document": "Trial start time.",
12382
+ "example": "1",
12383
+ "member": "int64",
12384
+ "name": "TrialStartTime",
12385
+ "output_required": false,
12386
+ "type": "int",
12387
+ "value_allowed_null": false
12388
+ },
12389
+ {
12390
+ "disabled": false,
12391
+ "document": "Trial duration.",
12392
+ "example": "1",
12393
+ "member": "int64",
12394
+ "name": "TrialDuration",
12395
+ "output_required": false,
12396
+ "type": "int",
12397
+ "value_allowed_null": false
12398
+ },
12399
+ {
12400
+ "disabled": false,
12401
+ "document": "Trial end time.",
12402
+ "example": "1",
12403
+ "member": "int64",
12404
+ "name": "TrialCloseTime",
12405
+ "output_required": false,
12406
+ "type": "int",
12407
+ "value_allowed_null": false
12408
+ },
12409
+ {
12410
+ "disabled": false,
12411
+ "document": "Log query time limit during the trial period.",
12412
+ "example": "1",
12413
+ "member": "int64",
12414
+ "name": "TrialDescribeLogHours",
12415
+ "output_required": false,
12416
+ "type": "int",
12417
+ "value_allowed_null": false
12418
+ }
12419
+ ],
12420
+ "usage": "out"
12421
+ },
10989
12422
  "InstanceInfo": {
10990
12423
  "document": "Instance details",
10991
12424
  "members": [
10992
12425
  {
10993
12426
  "disabled": false,
10994
12427
  "document": "Public network access status. Value range: 0 (not enabled), 1 (enabled), 2 (disabled)",
10995
- "example": "0",
12428
+ "example": "2",
10996
12429
  "member": "int64",
10997
12430
  "name": "WanStatus",
10998
12431
  "output_required": true,
@@ -11021,13 +12454,13 @@
11021
12454
  },
11022
12455
  {
11023
12456
  "disabled": false,
11024
- "document": "VIP information of a read-only instance. This field is exclusive to read-only instances where read-only access is enabled separately\nNote: This field may return null, indicating that no valid values can be obtained.",
11025
- "example": "{}",
12457
+ "document": "Read-only VIP information. This field is available only for read-only instances with dedicated access enabled.",
12458
+ "example": "",
11026
12459
  "member": "RoVipInfo",
11027
12460
  "name": "RoVipInfo",
11028
12461
  "output_required": true,
11029
12462
  "type": "object",
11030
- "value_allowed_null": true
12463
+ "value_allowed_null": false
11031
12464
  },
11032
12465
  {
11033
12466
  "disabled": false,
@@ -11061,13 +12494,13 @@
11061
12494
  },
11062
12495
  {
11063
12496
  "disabled": false,
11064
- "document": "Information of a secondary server\nNote: This field may return null, indicating that no valid values can be obtained.",
11065
- "example": "{}",
12497
+ "document": "Secondary server information.",
12498
+ "example": "",
11066
12499
  "member": "SlaveInfo",
11067
12500
  "name": "SlaveInfo",
11068
12501
  "output_required": true,
11069
12502
  "type": "object",
11070
- "value_allowed_null": true
12503
+ "value_allowed_null": false
11071
12504
  },
11072
12505
  {
11073
12506
  "disabled": false,
@@ -11102,7 +12535,7 @@
11102
12535
  {
11103
12536
  "disabled": false,
11104
12537
  "document": "Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync)",
11105
- "example": "0",
12538
+ "example": "1",
11106
12539
  "member": "int64",
11107
12540
  "name": "ProtectMode",
11108
12541
  "output_required": true,
@@ -11111,13 +12544,13 @@
11111
12544
  },
11112
12545
  {
11113
12546
  "disabled": false,
11114
- "document": "Details of a read-only group\nNote: This field may return null, indicating that no valid values can be obtained.",
11115
- "example": "[]",
12547
+ "document": "Detailed information about the read-only group.",
12548
+ "example": "",
11116
12549
  "member": "RoGroup",
11117
12550
  "name": "RoGroups",
11118
12551
  "output_required": true,
11119
12552
  "type": "list",
11120
- "value_allowed_null": true
12553
+ "value_allowed_null": false
11121
12554
  },
11122
12555
  {
11123
12556
  "disabled": false,
@@ -11142,7 +12575,7 @@
11142
12575
  {
11143
12576
  "disabled": false,
11144
12577
  "document": "Project ID",
11145
- "example": "0",
12578
+ "example": "12451",
11146
12579
  "member": "int64",
11147
12580
  "name": "ProjectId",
11148
12581
  "output_required": true,
@@ -11172,7 +12605,7 @@
11172
12605
  {
11173
12606
  "disabled": false,
11174
12607
  "document": "AZ deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ)",
11175
- "example": "0",
12608
+ "example": "1",
11176
12609
  "member": "int64",
11177
12610
  "name": "DeployMode",
11178
12611
  "output_required": true,
@@ -11182,7 +12615,7 @@
11182
12615
  {
11183
12616
  "disabled": false,
11184
12617
  "document": "Instance task status. 0 - no task; 1 - upgrading; 2 - importing data; 3 - activating secondary; 4 - enabling public network access; 5 - batch operation in progress; 6 - rolling back; 7 - disabling public network access; 8 - changing password; 9 - renaming instance; 10 - restarting; 12 - migrating self-built instance; 13 - dropping table; 14 - creating and syncing disaster recovery instance; 15 - pending upgrade and switch; 16 - upgrade and switch in progress; 17 - upgrade and switch completed",
11185
- "example": "0",
12618
+ "example": "1",
11186
12619
  "member": "int64",
11187
12620
  "name": "TaskStatus",
11188
12621
  "output_required": true,
@@ -11191,13 +12624,13 @@
11191
12624
  },
11192
12625
  {
11193
12626
  "disabled": false,
11194
- "document": "Details of a primary instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11195
- "example": "{}",
12627
+ "document": "Detailed information about the primary instance.",
12628
+ "example": "",
11196
12629
  "member": "MasterInfo",
11197
12630
  "name": "MasterInfo",
11198
12631
  "output_required": true,
11199
12632
  "type": "object",
11200
- "value_allowed_null": true
12633
+ "value_allowed_null": false
11201
12634
  },
11202
12635
  {
11203
12636
  "disabled": false,
@@ -11231,18 +12664,18 @@
11231
12664
  },
11232
12665
  {
11233
12666
  "disabled": false,
11234
- "document": "Details of a disaster recovery instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11235
- "example": "[]",
12667
+ "document": "Detailed information about the disaster recovery instance.",
12668
+ "example": "",
11236
12669
  "member": "DrInfo",
11237
12670
  "name": "DrInfo",
11238
12671
  "output_required": true,
11239
12672
  "type": "list",
11240
- "value_allowed_null": true
12673
+ "value_allowed_null": false
11241
12674
  },
11242
12675
  {
11243
12676
  "disabled": false,
11244
12677
  "document": "Public domain name",
11245
- "example": "''",
12678
+ "example": "gz-cdb-******.sql.tencentcdb.com",
11246
12679
  "member": "string",
11247
12680
  "name": "WanDomain",
11248
12681
  "output_required": true,
@@ -11252,7 +12685,7 @@
11252
12685
  {
11253
12686
  "disabled": false,
11254
12687
  "document": "Public network port number",
11255
- "example": "0",
12688
+ "example": "25640",
11256
12689
  "member": "int64",
11257
12690
  "name": "WanPort",
11258
12691
  "output_required": true,
@@ -11332,7 +12765,7 @@
11332
12765
  {
11333
12766
  "disabled": false,
11334
12767
  "document": "Physical ID",
11335
- "example": "''",
12768
+ "example": "phyxxx",
11336
12769
  "member": "string",
11337
12770
  "name": "PhysicalId",
11338
12771
  "output_required": true,
@@ -11371,33 +12804,33 @@
11371
12804
  },
11372
12805
  {
11373
12806
  "disabled": false,
11374
- "document": "Physical machine model\nNote: This field may return null, indicating that no valid values can be obtained.",
11375
- "example": "‘’",
12807
+ "document": "Physical server model.",
12808
+ "example": "VSWEQ",
11376
12809
  "member": "string",
11377
12810
  "name": "DeviceClass",
11378
12811
  "output_required": true,
11379
12812
  "type": "string",
11380
- "value_allowed_null": true
12813
+ "value_allowed_null": false
11381
12814
  },
11382
12815
  {
11383
12816
  "disabled": false,
11384
- "document": "Placement group ID\nNote: this field may return null, indicating that no valid values can be obtained.",
11385
- "example": "‘’",
12817
+ "document": "Placement group ID.",
12818
+ "example": "andy",
11386
12819
  "member": "string",
11387
12820
  "name": "DeployGroupId",
11388
12821
  "output_required": true,
11389
12822
  "type": "string",
11390
- "value_allowed_null": true
12823
+ "value_allowed_null": false
11391
12824
  },
11392
12825
  {
11393
12826
  "disabled": false,
11394
- "document": "AZ ID\nNote: this field may return null, indicating that no valid values can be obtained.",
12827
+ "document": "AZ ID.",
11395
12828
  "example": "800003",
11396
12829
  "member": "int64",
11397
12830
  "name": "ZoneId",
11398
12831
  "output_required": true,
11399
12832
  "type": "int",
11400
- "value_allowed_null": true
12833
+ "value_allowed_null": false
11401
12834
  },
11402
12835
  {
11403
12836
  "disabled": false,
@@ -11411,41 +12844,91 @@
11411
12844
  },
11412
12845
  {
11413
12846
  "disabled": false,
11414
- "document": "List of tags\nNote: this field may return `null`, indicating that no valid values can be obtained.",
11415
- "example": "[]",
11416
- "member": "TagInfoItem",
11417
- "name": "TagList",
11418
- "output_required": true,
12847
+ "document": "Tag list.",
12848
+ "example": "",
12849
+ "member": "TagInfoItem",
12850
+ "name": "TagList",
12851
+ "output_required": true,
12852
+ "type": "list",
12853
+ "value_allowed_null": false
12854
+ },
12855
+ {
12856
+ "disabled": false,
12857
+ "document": "Engine type.",
12858
+ "example": "InnoDB",
12859
+ "member": "string",
12860
+ "name": "EngineType",
12861
+ "output_required": true,
12862
+ "type": "string",
12863
+ "value_allowed_null": false
12864
+ },
12865
+ {
12866
+ "disabled": false,
12867
+ "document": "Maximum delay threshold.",
12868
+ "example": "1",
12869
+ "member": "int64",
12870
+ "name": "MaxDelayTime",
12871
+ "output_required": true,
12872
+ "type": "int",
12873
+ "value_allowed_null": false
12874
+ },
12875
+ {
12876
+ "disabled": false,
12877
+ "document": "Instance disk type. Valid values are returned only for Cluster Edition and single-node (cloud disk) instances.\nNote:\n1. If \"DiskType\": \"CLOUD_HSSD\" is returned, it indicates that the instance disk type is Enhanced SSD.\n2. If \"DiskType\": \"CLOUD_SSD\" is returned, it indicates that the instance disk type is Cloud SSD.\n3. If \"DiskType\": \"\" is returned and the DeviceType parameter value is UNIVERSAL or EXCLUSIVE, it indicates that the instance uses a local SSD.",
12878
+ "example": "CLOUD_SSD",
12879
+ "member": "string",
12880
+ "name": "DiskType",
12881
+ "output_required": true,
12882
+ "type": "string",
12883
+ "value_allowed_null": false
12884
+ },
12885
+ {
12886
+ "disabled": false,
12887
+ "document": "Current number of CPU cores for scale-out.",
12888
+ "example": "2",
12889
+ "member": "int64",
12890
+ "name": "ExpandCpu",
12891
+ "output_required": false,
12892
+ "type": "int",
12893
+ "value_allowed_null": false
12894
+ },
12895
+ {
12896
+ "disabled": false,
12897
+ "document": "Cluster Edition instance node information.",
12898
+ "example": "无",
12899
+ "member": "ClusterInfo",
12900
+ "name": "ClusterInfo",
12901
+ "output_required": false,
11419
12902
  "type": "list",
11420
- "value_allowed_null": true
12903
+ "value_allowed_null": false
11421
12904
  },
11422
12905
  {
11423
12906
  "disabled": false,
11424
- "document": "Engine type\nNote: This field may return null, indicating that no valid values can be obtained.",
11425
- "example": "InnoDB",
11426
- "member": "string",
11427
- "name": "EngineType",
11428
- "output_required": true,
11429
- "type": "string",
11430
- "value_allowed_null": true
12907
+ "document": "Analysis engine node list.",
12908
+ "example": "",
12909
+ "member": "AnalysisNodeInfo",
12910
+ "name": "AnalysisNodeInfos",
12911
+ "output_required": false,
12912
+ "type": "list",
12913
+ "value_allowed_null": false
11431
12914
  },
11432
12915
  {
11433
12916
  "disabled": false,
11434
- "document": "Maximum delay threshold\nNote: This field may return null, indicating that no valid values can be obtained.",
11435
- "example": "1",
11436
- "member": "int64",
11437
- "name": "MaxDelayTime",
11438
- "output_required": true,
12917
+ "document": "Device bandwidth, in GB. This parameter is valid when DeviceClass is specified. For example, 25 means the current device bandwidth is 25 GB; 10 means the current device bandwidth is 10 GB.",
12918
+ "example": "25",
12919
+ "member": "uint64",
12920
+ "name": "DeviceBandwidth",
12921
+ "output_required": false,
11439
12922
  "type": "int",
11440
- "value_allowed_null": true
12923
+ "value_allowed_null": false
11441
12924
  },
11442
12925
  {
11443
12926
  "disabled": false,
11444
- "document": "Instance disk type, which is returned only for the instances of cloud disk edition. Valid values: `CLOUD_SSD` (SSD), `CLOUD_HSSD` (Enhanced SSD).",
11445
- "example": "CLOUD_SSD",
12927
+ "document": "Instance termination protection status. on indicates enabled; otherwise, the protection is disabled.",
12928
+ "example": "on",
11446
12929
  "member": "string",
11447
- "name": "DiskType",
11448
- "output_required": true,
12930
+ "name": "DestroyProtect",
12931
+ "output_required": false,
11449
12932
  "type": "string",
11450
12933
  "value_allowed_null": false
11451
12934
  }
@@ -11700,7 +13183,7 @@
11700
13183
  "example": "ap-guangzhou",
11701
13184
  "member": "string",
11702
13185
  "name": "Region",
11703
- "required": true,
13186
+ "output_required": true,
11704
13187
  "type": "string",
11705
13188
  "value_allowed_null": false
11706
13189
  },
@@ -11710,7 +13193,7 @@
11710
13193
  "example": "1",
11711
13194
  "member": "int64",
11712
13195
  "name": "RegionId",
11713
- "required": true,
13196
+ "output_required": true,
11714
13197
  "type": "int",
11715
13198
  "value_allowed_null": false
11716
13199
  },
@@ -11720,7 +13203,7 @@
11720
13203
  "example": "100003",
11721
13204
  "member": "int64",
11722
13205
  "name": "ZoneId",
11723
- "required": true,
13206
+ "output_required": true,
11724
13207
  "type": "int",
11725
13208
  "value_allowed_null": false
11726
13209
  },
@@ -11730,7 +13213,7 @@
11730
13213
  "example": "ap-guangzhou-3",
11731
13214
  "member": "string",
11732
13215
  "name": "Zone",
11733
- "required": true,
13216
+ "output_required": true,
11734
13217
  "type": "string",
11735
13218
  "value_allowed_null": false
11736
13219
  },
@@ -11740,17 +13223,17 @@
11740
13223
  "example": "cdb-***",
11741
13224
  "member": "string",
11742
13225
  "name": "InstanceId",
11743
- "required": true,
13226
+ "output_required": true,
11744
13227
  "type": "string",
11745
13228
  "value_allowed_null": false
11746
13229
  },
11747
13230
  {
11748
13231
  "disabled": false,
11749
13232
  "document": "Long instance ID",
11750
- "example": "''",
13233
+ "example": "1241asdd-qwed1-213-dad",
11751
13234
  "member": "string",
11752
13235
  "name": "ResourceId",
11753
- "required": true,
13236
+ "output_required": true,
11754
13237
  "type": "string",
11755
13238
  "value_allowed_null": false
11756
13239
  },
@@ -11760,7 +13243,7 @@
11760
13243
  "example": "1",
11761
13244
  "member": "int64",
11762
13245
  "name": "Status",
11763
- "required": true,
13246
+ "output_required": true,
11764
13247
  "type": "int",
11765
13248
  "value_allowed_null": false
11766
13249
  },
@@ -11770,7 +13253,7 @@
11770
13253
  "example": "***",
11771
13254
  "member": "string",
11772
13255
  "name": "InstanceName",
11773
- "required": true,
13256
+ "output_required": true,
11774
13257
  "type": "string",
11775
13258
  "value_allowed_null": false
11776
13259
  },
@@ -11780,7 +13263,7 @@
11780
13263
  "example": "1",
11781
13264
  "member": "int64",
11782
13265
  "name": "InstanceType",
11783
- "required": true,
13266
+ "output_required": true,
11784
13267
  "type": "int",
11785
13268
  "value_allowed_null": false
11786
13269
  },
@@ -11790,7 +13273,7 @@
11790
13273
  "example": "0",
11791
13274
  "member": "int64",
11792
13275
  "name": "TaskStatus",
11793
- "required": true,
13276
+ "output_required": true,
11794
13277
  "type": "int",
11795
13278
  "value_allowed_null": false
11796
13279
  },
@@ -11800,7 +13283,7 @@
11800
13283
  "example": "1000",
11801
13284
  "member": "int64",
11802
13285
  "name": "Memory",
11803
- "required": true,
13286
+ "output_required": true,
11804
13287
  "type": "int",
11805
13288
  "value_allowed_null": false
11806
13289
  },
@@ -11810,7 +13293,7 @@
11810
13293
  "example": "50",
11811
13294
  "member": "int64",
11812
13295
  "name": "Volume",
11813
- "required": true,
13296
+ "output_required": true,
11814
13297
  "type": "int",
11815
13298
  "value_allowed_null": false
11816
13299
  },
@@ -11820,7 +13303,7 @@
11820
13303
  "example": "UNIVERSAL",
11821
13304
  "member": "string",
11822
13305
  "name": "DeviceType",
11823
- "required": true,
13306
+ "output_required": true,
11824
13307
  "type": "string",
11825
13308
  "value_allowed_null": false
11826
13309
  },
@@ -11830,7 +13313,7 @@
11830
13313
  "example": "1000",
11831
13314
  "member": "int64",
11832
13315
  "name": "Qps",
11833
- "required": true,
13316
+ "output_required": true,
11834
13317
  "type": "int",
11835
13318
  "value_allowed_null": false
11836
13319
  },
@@ -11840,7 +13323,7 @@
11840
13323
  "example": "1533",
11841
13324
  "member": "int64",
11842
13325
  "name": "VpcId",
11843
- "required": true,
13326
+ "output_required": true,
11844
13327
  "type": "int",
11845
13328
  "value_allowed_null": false
11846
13329
  },
@@ -11850,27 +13333,27 @@
11850
13333
  "example": "12364",
11851
13334
  "member": "int64",
11852
13335
  "name": "SubnetId",
11853
- "required": true,
13336
+ "output_required": true,
11854
13337
  "type": "int",
11855
13338
  "value_allowed_null": false
11856
13339
  },
11857
13340
  {
11858
13341
  "disabled": false,
11859
13342
  "document": "Dedicated cluster ID",
11860
- "example": "''",
13343
+ "example": "andy",
11861
13344
  "member": "string",
11862
13345
  "name": "ExClusterId",
11863
- "required": true,
13346
+ "output_required": true,
11864
13347
  "type": "string",
11865
13348
  "value_allowed_null": false
11866
13349
  },
11867
13350
  {
11868
13351
  "disabled": false,
11869
13352
  "document": "Dedicated cluster name",
11870
- "example": "''",
13353
+ "example": "andy",
11871
13354
  "member": "string",
11872
13355
  "name": "ExClusterName",
11873
- "required": true,
13356
+ "output_required": true,
11874
13357
  "type": "string",
11875
13358
  "value_allowed_null": false
11876
13359
  }
@@ -12042,13 +13525,230 @@
12042
13525
  ],
12043
13526
  "type": "object"
12044
13527
  },
12045
- "ModifyAccountPrivilegesRequest": {
12046
- "document": "ModifyAccountPrivileges request structure.",
13528
+ "ModifyAccountPrivilegesRequest": {
13529
+ "document": "ModifyAccountPrivileges request structure.",
13530
+ "members": [
13531
+ {
13532
+ "disabled": false,
13533
+ "document": "Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.",
13534
+ "example": "cdb-f35wr6wj",
13535
+ "member": "string",
13536
+ "name": "InstanceId",
13537
+ "required": true,
13538
+ "type": "string"
13539
+ },
13540
+ {
13541
+ "disabled": false,
13542
+ "document": "Database account, including username and domain name.",
13543
+ "example": "无",
13544
+ "member": "Account",
13545
+ "name": "Accounts",
13546
+ "required": true,
13547
+ "type": "list"
13548
+ },
13549
+ {
13550
+ "disabled": false,
13551
+ "document": "Global permission. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"PROCESS\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"SHOW DATABASES\", \"CREATE TEMPORARY TABLES\", \"LOCK TABLES\", \"EXECUTE\", \"CREATE VIEW\", \"SHOW VIEW\", \"CREATE ROUTINE\", \"ALTER ROUTINE\", \"EVENT\", \"TRIGGER\", \"CREATE USER\", \"RELOAD\", \"REPLICATION CLIENT\", \"REPLICATION SLAVE\".\nNote: When “ModifyAction” is empty, if `GlobalPrivileges` is not passed in, it indicates the global permission will become ineffective.",
13552
+ "example": "[\"SELECT\"]",
13553
+ "member": "string",
13554
+ "name": "GlobalPrivileges",
13555
+ "required": false,
13556
+ "type": "list"
13557
+ },
13558
+ {
13559
+ "disabled": false,
13560
+ "document": "Database permission. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"CREATE TEMPORARY TABLES\", \"LOCK TABLES\", \"EXECUTE\", \"CREATE VIEW\", \"SHOW VIEW\", \"CREATE ROUTINE\", \"ALTER ROUTINE\", \"EVENT\", \"TRIGGER\".\nNote: When “ModifyAction” is empty, if `DatabasePrivileges` is not passed in, it indicates the permission of the database will become ineffective.",
13561
+ "example": "无",
13562
+ "member": "DatabasePrivilege",
13563
+ "name": "DatabasePrivileges",
13564
+ "required": false,
13565
+ "type": "list"
13566
+ },
13567
+ {
13568
+ "disabled": false,
13569
+ "document": "Table permission in the database. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"CREATE VIEW\", \"SHOW VIEW\", \"TRIGGER\".\nNote: When “ModifyAction” is empty, if `TablePrivileges` is not passed in, it indicates the permission of the table will become ineffective.",
13570
+ "example": "无",
13571
+ "member": "TablePrivilege",
13572
+ "name": "TablePrivileges",
13573
+ "required": false,
13574
+ "type": "list"
13575
+ },
13576
+ {
13577
+ "disabled": false,
13578
+ "document": "Column permission in the table. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"REFERENCES\".\nNote: When “ModifyAction” is empty, if `ColumnPrivileges` is not passed in, it indicates the permission of the column will become ineffective.",
13579
+ "example": "无",
13580
+ "member": "ColumnPrivilege",
13581
+ "name": "ColumnPrivileges",
13582
+ "required": false,
13583
+ "type": "list"
13584
+ },
13585
+ {
13586
+ "disabled": false,
13587
+ "document": "When this parameter is not empty, it indicates that the permission will be modified. Valid values: `grant` (grant permission), `revoke` (revoke permission)",
13588
+ "example": "无",
13589
+ "member": "string",
13590
+ "name": "ModifyAction",
13591
+ "required": false,
13592
+ "type": "string"
13593
+ }
13594
+ ],
13595
+ "type": "object"
13596
+ },
13597
+ "ModifyAccountPrivilegesResponse": {
13598
+ "document": "ModifyAccountPrivileges response structure.",
13599
+ "members": [
13600
+ {
13601
+ "disabled": false,
13602
+ "document": "Async task request ID, which can be used to query the execution result of an async task.",
13603
+ "example": "256117ed-efa08b54-61784d44-91781bbd",
13604
+ "member": "string",
13605
+ "name": "AsyncRequestId",
13606
+ "output_required": true,
13607
+ "type": "string",
13608
+ "value_allowed_null": false
13609
+ },
13610
+ {
13611
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
13612
+ "member": "string",
13613
+ "name": "RequestId",
13614
+ "type": "string"
13615
+ }
13616
+ ],
13617
+ "type": "object"
13618
+ },
13619
+ "ModifyAuditConfigRequest": {
13620
+ "document": "ModifyAuditConfig request structure.",
13621
+ "members": [
13622
+ {
13623
+ "disabled": false,
13624
+ "document": "Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/236/15872?from_cn_redirect=1) API.",
13625
+ "example": "cdb-txcniupi",
13626
+ "member": "string",
13627
+ "name": "InstanceId",
13628
+ "required": true,
13629
+ "type": "string"
13630
+ },
13631
+ {
13632
+ "disabled": false,
13633
+ "document": "Audit log retention period. Valid values:7 - One week;30 - One month;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
13634
+ "example": "365",
13635
+ "member": "int64",
13636
+ "name": "LogExpireDay",
13637
+ "required": false,
13638
+ "type": "int"
13639
+ },
13640
+ {
13641
+ "disabled": false,
13642
+ "document": "Whether to disable the audit service. Valid values: true - Disable; false - Do not disable. Default value: false.Notes:1. When the audit service is disabled, your audit logs and files will be deleted, and all audit policies for this instance will be removed.2. At least one of CloseAudit and LogExpireDay must be provided. If both are provided, CloseAudit takes priority.3. You can use this parameter to disable the audit service. Once disabled, the audit service cannot be re-enabled via this API.",
13643
+ "example": "true",
13644
+ "member": "bool",
13645
+ "name": "CloseAudit",
13646
+ "required": false,
13647
+ "type": "bool"
13648
+ },
13649
+ {
13650
+ "disabled": false,
13651
+ "document": "High-frequency audit log retention period. Valid values:7 - One week;30 - One month;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
13652
+ "example": "7",
13653
+ "member": "int64",
13654
+ "name": "HighLogExpireDay",
13655
+ "required": false,
13656
+ "type": "int"
13657
+ }
13658
+ ],
13659
+ "type": "object"
13660
+ },
13661
+ "ModifyAuditConfigResponse": {
13662
+ "document": "ModifyAuditConfig response structure.",
13663
+ "members": [
13664
+ {
13665
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
13666
+ "member": "string",
13667
+ "name": "RequestId",
13668
+ "type": "string"
13669
+ }
13670
+ ],
13671
+ "type": "object"
13672
+ },
13673
+ "ModifyAuditRuleTemplatesRequest": {
13674
+ "document": "ModifyAuditRuleTemplates request structure.",
13675
+ "members": [
13676
+ {
13677
+ "disabled": false,
13678
+ "document": "Audit rule template ID, which can be obtained through the [DescribeAuditRuleTemplates](https://www.tencentcloud.comom/document/api/236/101811?from_cn_redirect=1) API.",
13679
+ "example": "cdb-art-l1mlbo59",
13680
+ "member": "string",
13681
+ "name": "RuleTemplateIds",
13682
+ "required": true,
13683
+ "type": "list"
13684
+ },
13685
+ {
13686
+ "disabled": false,
13687
+ "document": "Modified audit rule.",
13688
+ "example": "无",
13689
+ "member": "RuleFilters",
13690
+ "name": "RuleFilters",
13691
+ "required": false,
13692
+ "type": "list"
13693
+ },
13694
+ {
13695
+ "disabled": false,
13696
+ "document": "Modified rule template name.",
13697
+ "example": "新规则模板名称",
13698
+ "member": "string",
13699
+ "name": "RuleTemplateName",
13700
+ "required": false,
13701
+ "type": "string"
13702
+ },
13703
+ {
13704
+ "disabled": false,
13705
+ "document": "Modified rule template description.",
13706
+ "example": "新规则模板名称",
13707
+ "member": "string",
13708
+ "name": "Description",
13709
+ "required": false,
13710
+ "type": "string"
13711
+ },
13712
+ {
13713
+ "disabled": false,
13714
+ "document": "Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk.",
13715
+ "example": "3",
13716
+ "member": "uint64",
13717
+ "name": "AlarmLevel",
13718
+ "required": false,
13719
+ "type": "int"
13720
+ },
13721
+ {
13722
+ "disabled": false,
13723
+ "document": "Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled.",
13724
+ "example": "1",
13725
+ "member": "uint64",
13726
+ "name": "AlarmPolicy",
13727
+ "required": false,
13728
+ "type": "int"
13729
+ }
13730
+ ],
13731
+ "type": "object"
13732
+ },
13733
+ "ModifyAuditRuleTemplatesResponse": {
13734
+ "document": "ModifyAuditRuleTemplates response structure.",
13735
+ "members": [
13736
+ {
13737
+ "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
13738
+ "member": "string",
13739
+ "name": "RequestId",
13740
+ "type": "string"
13741
+ }
13742
+ ],
13743
+ "type": "object"
13744
+ },
13745
+ "ModifyAuditServiceRequest": {
13746
+ "document": "ModifyAuditService request structure.",
12047
13747
  "members": [
12048
13748
  {
12049
13749
  "disabled": false,
12050
- "document": "Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.",
12051
- "example": "cdb-f35wr6wj",
13750
+ "document": "Instance ID, which can be obtained through the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/236/15872?from_cn_redirect=1) API.",
13751
+ "example": "cdb-22dhn3e3",
12052
13752
  "member": "string",
12053
13753
  "name": "InstanceId",
12054
13754
  "required": true,
@@ -12056,74 +13756,55 @@
12056
13756
  },
12057
13757
  {
12058
13758
  "disabled": false,
12059
- "document": "Database account, including username and domain name.",
12060
- "example": "",
12061
- "member": "Account",
12062
- "name": "Accounts",
12063
- "required": true,
12064
- "type": "list"
12065
- },
12066
- {
12067
- "disabled": false,
12068
- "document": "Global permission. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"PROCESS\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"SHOW DATABASES\", \"CREATE TEMPORARY TABLES\", \"LOCK TABLES\", \"EXECUTE\", \"CREATE VIEW\", \"SHOW VIEW\", \"CREATE ROUTINE\", \"ALTER ROUTINE\", \"EVENT\", \"TRIGGER\", \"CREATE USER\", \"RELOAD\", \"REPLICATION CLIENT\", \"REPLICATION SLAVE\".\nNote: When “ModifyAction” is empty, if `GlobalPrivileges` is not passed in, it indicates the global permission will become ineffective.",
12069
- "example": "[\"SELECT\"]",
12070
- "member": "string",
12071
- "name": "GlobalPrivileges",
13759
+ "document": "Log retention period. Valid values:7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
13760
+ "example": "30",
13761
+ "member": "uint64",
13762
+ "name": "LogExpireDay",
12072
13763
  "required": false,
12073
- "type": "list"
13764
+ "type": "int"
12074
13765
  },
12075
13766
  {
12076
13767
  "disabled": false,
12077
- "document": "Database permission. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"CREATE TEMPORARY TABLES\", \"LOCK TABLES\", \"EXECUTE\", \"CREATE VIEW\", \"SHOW VIEW\", \"CREATE ROUTINE\", \"ALTER ROUTINE\", \"EVENT\", \"TRIGGER\".\nNote: When “ModifyAction” is empty, if `DatabasePrivileges` is not passed in, it indicates the permission of the database will become ineffective.",
12078
- "example": "",
12079
- "member": "DatabasePrivilege",
12080
- "name": "DatabasePrivileges",
13768
+ "document": "High-frequency log retention period. Default value: 7. This value must be less than or equal to LogExpireDay. Valid values include:3 - 3 days;7 - One week;30 - One month;90 - Three months;180 - Six months;365 - One year;1095 - Three years;1825 - Five years.",
13769
+ "example": "7",
13770
+ "member": "uint64",
13771
+ "name": "HighLogExpireDay",
12081
13772
  "required": false,
12082
- "type": "list"
13773
+ "type": "int"
12083
13774
  },
12084
13775
  {
12085
13776
  "disabled": false,
12086
- "document": "Table permission in the database. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"DELETE\", \"CREATE\", \"DROP\", \"REFERENCES\", \"INDEX\", \"ALTER\", \"CREATE VIEW\", \"SHOW VIEW\", \"TRIGGER\".\nNote: When “ModifyAction” is empty, if `TablePrivileges` is not passed in, it indicates the permission of the table will become ineffective.",
12087
- "example": "",
12088
- "member": "TablePrivilege",
12089
- "name": "TablePrivileges",
13777
+ "document": "Modifies the instance audit rule to Full audit.",
13778
+ "example": "true",
13779
+ "member": "bool",
13780
+ "name": "AuditAll",
12090
13781
  "required": false,
12091
- "type": "list"
13782
+ "type": "bool"
12092
13783
  },
12093
13784
  {
12094
- "disabled": false,
12095
- "document": "Column permission in the table. Valid values: \"SELECT\", \"INSERT\", \"UPDATE\", \"REFERENCES\".\nNote: When “ModifyAction” is empty, if `ColumnPrivileges` is not passed in, it indicates the permission of the column will become ineffective.",
13785
+ "disabled": true,
13786
+ "document": "Deprecated.",
12096
13787
  "example": "无",
12097
- "member": "ColumnPrivilege",
12098
- "name": "ColumnPrivileges",
13788
+ "member": "AuditRuleFilters",
13789
+ "name": "AuditRuleFilters",
12099
13790
  "required": false,
12100
13791
  "type": "list"
12101
13792
  },
12102
13793
  {
12103
13794
  "disabled": false,
12104
- "document": "When this parameter is not empty, it indicates that the permission will be modified. Valid values: `grant` (grant permission), `revoke` (revoke permission)",
12105
- "example": "",
13795
+ "document": "Rule template ID, which can be obtained through the [DescribeAuditRuleTemplates](https://www.tencentcloud.comom/document/api/236/101811?from_cn_redirect=1) API.",
13796
+ "example": "[\"cdb-art-nuf7e111\"]",
12106
13797
  "member": "string",
12107
- "name": "ModifyAction",
13798
+ "name": "RuleTemplateIds",
12108
13799
  "required": false,
12109
- "type": "string"
13800
+ "type": "list"
12110
13801
  }
12111
13802
  ],
12112
13803
  "type": "object"
12113
13804
  },
12114
- "ModifyAccountPrivilegesResponse": {
12115
- "document": "ModifyAccountPrivileges response structure.",
13805
+ "ModifyAuditServiceResponse": {
13806
+ "document": "ModifyAuditService response structure.",
12116
13807
  "members": [
12117
- {
12118
- "disabled": false,
12119
- "document": "Async task request ID, which can be used to query the execution result of an async task.",
12120
- "example": "256117ed-efa08b54-61784d44-91781bbd",
12121
- "member": "string",
12122
- "name": "AsyncRequestId",
12123
- "output_required": true,
12124
- "type": "string",
12125
- "value_allowed_null": false
12126
- },
12127
13808
  {
12128
13809
  "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
12129
13810
  "member": "string",
@@ -14890,7 +16571,7 @@
14890
16571
  },
14891
16572
  {
14892
16573
  "disabled": false,
14893
- "document": "Read-only group ID.",
16574
+ "document": "Read-only group ID.\nNote: If the data structure is used during instance purchase, this item is required only when the read-only group mode is set to join.",
14894
16575
  "example": "cdbrg-92zkeaq2",
14895
16576
  "member": "string",
14896
16577
  "name": "RoGroupId",
@@ -14923,7 +16604,7 @@
14923
16604
  },
14924
16605
  {
14925
16606
  "disabled": false,
14926
- "document": "Latency threshold",
16607
+ "document": "Delay threshold, in seconds. Value range: 1–10000. The value is an integer.",
14927
16608
  "example": "1",
14928
16609
  "member": "int64",
14929
16610
  "name": "RoMaxDelayTime",
@@ -14968,7 +16649,7 @@
14968
16649
  {
14969
16650
  "disabled": false,
14970
16651
  "document": "Details of read-only instances in read-only group",
14971
- "example": "[]",
16652
+ "example": "",
14972
16653
  "member": "RoInstanceInfo",
14973
16654
  "name": "RoInstances",
14974
16655
  "output_required": true,
@@ -15000,58 +16681,58 @@
15000
16681
  },
15001
16682
  {
15002
16683
  "disabled": false,
15003
- "document": "VPC ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
16684
+ "document": "Virtual Private Cloud (VPC) ID.",
15004
16685
  "example": "vpc-ja6ts123",
15005
16686
  "member": "string",
15006
16687
  "name": "UniqVpcId",
15007
16688
  "output_required": true,
15008
16689
  "required": false,
15009
16690
  "type": "string",
15010
- "value_allowed_null": true
16691
+ "value_allowed_null": false
15011
16692
  },
15012
16693
  {
15013
16694
  "disabled": false,
15014
- "document": "Subnet ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
16695
+ "document": "Subnet ID.",
15015
16696
  "example": "subnet-njh2bc99",
15016
16697
  "member": "string",
15017
16698
  "name": "UniqSubnetId",
15018
16699
  "output_required": true,
15019
16700
  "required": false,
15020
16701
  "type": "string",
15021
- "value_allowed_null": true
16702
+ "value_allowed_null": false
15022
16703
  },
15023
16704
  {
15024
16705
  "disabled": false,
15025
- "document": "Read-only group region.\nNote: this field may return null, indicating that no valid values can be obtained.",
16706
+ "document": "Region of the read-only group.",
15026
16707
  "example": "ap-beijing",
15027
16708
  "member": "string",
15028
16709
  "name": "RoGroupRegion",
15029
16710
  "output_required": true,
15030
16711
  "required": false,
15031
16712
  "type": "string",
15032
- "value_allowed_null": true
16713
+ "value_allowed_null": false
15033
16714
  },
15034
16715
  {
15035
16716
  "disabled": false,
15036
- "document": "Read-only group AZ.\nNote: this field may return null, indicating that no valid values can be obtained.",
16717
+ "document": "AZ of the read-only group.",
15037
16718
  "example": "ap-beijing-3",
15038
16719
  "member": "string",
15039
16720
  "name": "RoGroupZone",
15040
16721
  "output_required": true,
15041
16722
  "required": false,
15042
16723
  "type": "string",
15043
- "value_allowed_null": true
16724
+ "value_allowed_null": false
15044
16725
  },
15045
16726
  {
15046
16727
  "disabled": false,
15047
- "document": "Replication delay.\nNote: this field may return `null`, indicating that no valid values can be obtained.",
16728
+ "document": "Replication delay time, in seconds. Value range: 1–259200. The value is an integer.",
15048
16729
  "example": "1000",
15049
16730
  "member": "int64",
15050
16731
  "name": "DelayReplicationTime",
15051
16732
  "output_required": true,
15052
16733
  "required": false,
15053
16734
  "type": "int",
15054
- "value_allowed_null": true
16735
+ "value_allowed_null": false
15055
16736
  }
15056
16737
  ],
15057
16738
  "usage": "both"
@@ -15182,8 +16863,8 @@
15182
16863
  },
15183
16864
  {
15184
16865
  "disabled": false,
15185
- "document": "Name of RO AZ, such as ap-shanghai-1",
15186
- "example": "ap-shanghai-1",
16866
+ "document": "Name of RO AZ, such as ap-shanghai-2",
16867
+ "example": "ap-shanghai-2",
15187
16868
  "member": "string",
15188
16869
  "name": "Zone",
15189
16870
  "output_required": true,
@@ -15237,7 +16918,7 @@
15237
16918
  },
15238
16919
  {
15239
16920
  "disabled": false,
15240
- "document": "Pay-as-you-go billing status. Value range: 1 (normal), 2 (in arrears)",
16921
+ "document": "Pay-as-you-go status. Valid values: 1 - normal; 2 - in arrears.",
15241
16922
  "example": "1",
15242
16923
  "member": "int64",
15243
16924
  "name": "HourFeeStatus",
@@ -15359,7 +17040,7 @@
15359
17040
  {
15360
17041
  "disabled": false,
15361
17042
  "document": "RO instance expiration time in the format of yyyy-mm-dd hh:mm:ss. If it is a pay-as-you-go instance, the value of this field is 0000-00-00 00:00:00",
15362
- "example": "‘’",
17043
+ "example": "2024-09-09 16:40:30",
15363
17044
  "member": "string",
15364
17045
  "name": "DeadlineTime",
15365
17046
  "output_required": true,
@@ -15369,7 +17050,7 @@
15369
17050
  },
15370
17051
  {
15371
17052
  "disabled": false,
15372
- "document": "RO instance billing method. Value range: 0 (monthly subscribed), 1 (pay-as-you-go), 2 (monthly postpaid)",
17053
+ "document": "Billing type of the RO instance. Valid values: 0 - yearly/monthly subscription; 1 - pay-as-you-go; 2-postpaid by month.",
15373
17054
  "example": "0",
15374
17055
  "member": "int64",
15375
17056
  "name": "PayType",
@@ -15377,6 +17058,17 @@
15377
17058
  "required": false,
15378
17059
  "type": "int",
15379
17060
  "value_allowed_null": false
17061
+ },
17062
+ {
17063
+ "disabled": false,
17064
+ "document": "RO replication delay status.",
17065
+ "example": "RUNNING",
17066
+ "member": "string",
17067
+ "name": "ReplicationStatus",
17068
+ "output_required": true,
17069
+ "required": false,
17070
+ "type": "string",
17071
+ "value_allowed_null": false
15380
17072
  }
15381
17073
  ],
15382
17074
  "usage": "both"
@@ -15387,47 +17079,52 @@
15387
17079
  {
15388
17080
  "disabled": false,
15389
17081
  "document": "VIP status of the read-only instance",
15390
- "example": "",
17082
+ "example": "2",
15391
17083
  "member": "int64",
15392
17084
  "name": "RoVipStatus",
15393
- "required": true,
15394
- "type": "int"
17085
+ "output_required": true,
17086
+ "type": "int",
17087
+ "value_allowed_null": false
15395
17088
  },
15396
17089
  {
15397
17090
  "disabled": false,
15398
17091
  "document": "VPC subnet of the read-only instance",
15399
- "example": "",
17092
+ "example": "2132421",
15400
17093
  "member": "int64",
15401
17094
  "name": "RoSubnetId",
15402
- "required": true,
15403
- "type": "int"
17095
+ "output_required": true,
17096
+ "type": "int",
17097
+ "value_allowed_null": false
15404
17098
  },
15405
17099
  {
15406
17100
  "disabled": false,
15407
17101
  "document": "VPC of the read-only instance",
15408
- "example": "",
17102
+ "example": "13421234",
15409
17103
  "member": "int64",
15410
17104
  "name": "RoVpcId",
15411
- "required": true,
15412
- "type": "int"
17105
+ "output_required": true,
17106
+ "type": "int",
17107
+ "value_allowed_null": false
15413
17108
  },
15414
17109
  {
15415
17110
  "disabled": false,
15416
17111
  "document": "VIP port number of the read-only instance",
15417
- "example": "",
17112
+ "example": "3306",
15418
17113
  "member": "int64",
15419
17114
  "name": "RoVport",
15420
- "required": true,
15421
- "type": "int"
17115
+ "output_required": true,
17116
+ "type": "int",
17117
+ "value_allowed_null": false
15422
17118
  },
15423
17119
  {
15424
17120
  "disabled": false,
15425
17121
  "document": "VIP of the read-only instance",
15426
- "example": "",
17122
+ "example": "10.1.1.1",
15427
17123
  "member": "string",
15428
17124
  "name": "RoVip",
15429
- "required": true,
15430
- "type": "string"
17125
+ "output_required": true,
17126
+ "type": "string",
17127
+ "value_allowed_null": false
15431
17128
  }
15432
17129
  ],
15433
17130
  "usage": "out"
@@ -15744,6 +17441,138 @@
15744
17441
  ],
15745
17442
  "usage": "both"
15746
17443
  },
17444
+ "RuleTemplateInfo": {
17445
+ "document": "Rule template content.",
17446
+ "members": [
17447
+ {
17448
+ "disabled": false,
17449
+ "document": "Rule template ID.",
17450
+ "example": "cdb-art-8qx2kcr7",
17451
+ "member": "string",
17452
+ "name": "RuleTemplateId",
17453
+ "output_required": false,
17454
+ "type": "string",
17455
+ "value_allowed_null": false
17456
+ },
17457
+ {
17458
+ "disabled": false,
17459
+ "document": "Rule template name.",
17460
+ "example": "andy",
17461
+ "member": "string",
17462
+ "name": "RuleTemplateName",
17463
+ "output_required": false,
17464
+ "type": "string",
17465
+ "value_allowed_null": false
17466
+ },
17467
+ {
17468
+ "disabled": false,
17469
+ "document": "Rule content.",
17470
+ "example": "[{\"Type\":\"host\",\"Compare\":\"INC\",\"Value\":[\"100.122.76.176\"]}]",
17471
+ "member": "RuleFilters",
17472
+ "name": "RuleFilters",
17473
+ "output_required": false,
17474
+ "type": "list",
17475
+ "value_allowed_null": false
17476
+ },
17477
+ {
17478
+ "disabled": false,
17479
+ "document": "Alarm level. Valid values: 1 - Low risk, 2 - Medium risk, 3 - High risk.",
17480
+ "example": "1",
17481
+ "member": "int64",
17482
+ "name": "AlarmLevel",
17483
+ "output_required": false,
17484
+ "type": "int",
17485
+ "value_allowed_null": false
17486
+ },
17487
+ {
17488
+ "disabled": false,
17489
+ "document": "Alarm policy. Valid values: 0 - Alarm disabled, 1 - Alarm enabled.",
17490
+ "example": "0",
17491
+ "member": "int64",
17492
+ "name": "AlarmPolicy",
17493
+ "output_required": false,
17494
+ "type": "int",
17495
+ "value_allowed_null": false
17496
+ },
17497
+ {
17498
+ "disabled": false,
17499
+ "document": "Rule description.",
17500
+ "example": "这不单单是一个的描述",
17501
+ "member": "string",
17502
+ "name": "Description",
17503
+ "output_required": false,
17504
+ "type": "string",
17505
+ "value_allowed_null": false
17506
+ }
17507
+ ],
17508
+ "usage": "out"
17509
+ },
17510
+ "RuleTemplateRecordInfo": {
17511
+ "document": "Rule template change history.",
17512
+ "members": [
17513
+ {
17514
+ "disabled": false,
17515
+ "document": "Task ID.",
17516
+ "example": "172",
17517
+ "member": "int64",
17518
+ "name": "TaskId",
17519
+ "output_required": false,
17520
+ "type": "int",
17521
+ "value_allowed_null": false
17522
+ },
17523
+ {
17524
+ "disabled": false,
17525
+ "document": "Details of the original rule template.",
17526
+ "example": "[{\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"andy\",\"RuleFilters\": [{\"Type\": \"sqltype\",\"Compare\": \"INC\",\"Value\": \"UPDATE\"}],\"AlarmLevel\": \"1\",\"AlarmPolicy\": \"1\",\"Description\": \"触发推送报告\"}]",
17527
+ "member": "RuleTemplateInfo",
17528
+ "name": "ModifyBeforeInfo",
17529
+ "output_required": false,
17530
+ "type": "object",
17531
+ "value_allowed_null": false
17532
+ },
17533
+ {
17534
+ "disabled": false,
17535
+ "document": "Details of the modified rule template.",
17536
+ "example": "[{\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"andy\",\"RuleFilters\": [{\"Type\": \"sqltype\",\"Compare\": \"INC\",\"Value\": \"logout\"}],\"AlarmLevel\": \"1\",\"AlarmPolicy\": \"1\",\"Description\": \"触发推送报告\"}]",
17537
+ "member": "RuleTemplateInfo",
17538
+ "name": "ModifyAfterInfo",
17539
+ "output_required": false,
17540
+ "type": "object",
17541
+ "value_allowed_null": false
17542
+ },
17543
+ {
17544
+ "disabled": false,
17545
+ "document": "Affected instances.",
17546
+ "example": "[\"cdb-3gj2ya11\",\"cdb-3gj2ya22\"]",
17547
+ "member": "string",
17548
+ "name": "AffectedInstances",
17549
+ "output_required": false,
17550
+ "type": "list",
17551
+ "value_allowed_null": false
17552
+ },
17553
+ {
17554
+ "disabled": false,
17555
+ "document": "Operator (account UIN).",
17556
+ "example": "1000***3726",
17557
+ "member": "string",
17558
+ "name": "Operator",
17559
+ "output_required": false,
17560
+ "type": "string",
17561
+ "value_allowed_null": false
17562
+ },
17563
+ {
17564
+ "disabled": false,
17565
+ "document": "Time of the change.",
17566
+ "example": "2024-03-17 02:10:37",
17567
+ "member": "string",
17568
+ "name": "UpdateTime",
17569
+ "output_required": false,
17570
+ "type": "string",
17571
+ "value_allowed_null": false
17572
+ }
17573
+ ],
17574
+ "usage": "out"
17575
+ },
15747
17576
  "SecurityGroup": {
15748
17577
  "document": "Security group details",
15749
17578
  "members": [
@@ -15819,20 +17648,22 @@
15819
17648
  {
15820
17649
  "disabled": false,
15821
17650
  "document": "Replication mode of the secondary database. Value range: async, semi-sync",
15822
- "example": "",
17651
+ "example": "aysnc",
15823
17652
  "member": "string",
15824
17653
  "name": "ReplicationMode",
15825
- "required": true,
15826
- "type": "string"
17654
+ "output_required": true,
17655
+ "type": "string",
17656
+ "value_allowed_null": false
15827
17657
  },
15828
17658
  {
15829
17659
  "disabled": false,
15830
- "document": "AZ name of the secondary database, such as ap-shanghai-1",
15831
- "example": "",
17660
+ "document": "AZ name of the secondary database, such as ap-shanghai-2",
17661
+ "example": "ap-shanghai-2",
15832
17662
  "member": "string",
15833
17663
  "name": "Zone",
15834
- "required": true,
15835
- "type": "string"
17664
+ "output_required": true,
17665
+ "type": "string",
17666
+ "value_allowed_null": false
15836
17667
  }
15837
17668
  ],
15838
17669
  "usage": "out"
@@ -15843,22 +17674,22 @@
15843
17674
  {
15844
17675
  "disabled": false,
15845
17676
  "document": "Information of secondary server 1",
15846
- "example": "",
17677
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.1.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15847
17678
  "member": "SlaveInstanceInfo",
15848
17679
  "name": "First",
15849
- "required": true,
17680
+ "output_required": true,
15850
17681
  "type": "object",
15851
17682
  "value_allowed_null": false
15852
17683
  },
15853
17684
  {
15854
17685
  "disabled": false,
15855
- "document": "Information of secondary server 2\nNote: This field may return null, indicating that no valid values can be obtained.",
15856
- "example": "",
17686
+ "document": "Second secondary server information.",
17687
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.0.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15857
17688
  "member": "SlaveInstanceInfo",
15858
17689
  "name": "Second",
15859
- "required": false,
17690
+ "output_required": true,
15860
17691
  "type": "object",
15861
- "value_allowed_null": true
17692
+ "value_allowed_null": false
15862
17693
  }
15863
17694
  ],
15864
17695
  "usage": "out"
@@ -16689,25 +18520,25 @@
16689
18520
  "members": [
16690
18521
  {
16691
18522
  "disabled": false,
16692
- "document": "Tag key\nNote: this field may return `null`, indicating that no valid values can be obtained.",
18523
+ "document": "Tag key.",
16693
18524
  "example": "‘’",
16694
18525
  "member": "string",
16695
18526
  "name": "TagKey",
16696
18527
  "output_required": true,
16697
18528
  "required": true,
16698
18529
  "type": "string",
16699
- "value_allowed_null": true
18530
+ "value_allowed_null": false
16700
18531
  },
16701
18532
  {
16702
18533
  "disabled": false,
16703
- "document": "Tag value\nNote: this field may return `null`, indicating that no valid values can be obtained.",
18534
+ "document": "Tag value.",
16704
18535
  "example": "‘’",
16705
18536
  "member": "string",
16706
18537
  "name": "TagValue",
16707
18538
  "output_required": true,
16708
18539
  "required": true,
16709
18540
  "type": "string",
16710
- "value_allowed_null": true
18541
+ "value_allowed_null": false
16711
18542
  }
16712
18543
  ],
16713
18544
  "usage": "both"
@@ -16718,20 +18549,20 @@
16718
18549
  {
16719
18550
  "disabled": false,
16720
18551
  "document": "Tag key",
16721
- "example": "",
18552
+ "example": "created-by",
16722
18553
  "member": "string",
16723
18554
  "name": "TagKey",
16724
- "required": true,
18555
+ "output_required": true,
16725
18556
  "type": "string",
16726
18557
  "value_allowed_null": false
16727
18558
  },
16728
18559
  {
16729
18560
  "disabled": false,
16730
18561
  "document": "Tag value",
16731
- "example": "",
18562
+ "example": "andy",
16732
18563
  "member": "string",
16733
18564
  "name": "TagValue",
16734
- "required": true,
18565
+ "output_required": true,
16735
18566
  "type": "string",
16736
18567
  "value_allowed_null": false
16737
18568
  }
@@ -17248,7 +19079,7 @@
17248
19079
  {
17249
19080
  "disabled": false,
17250
19081
  "document": "AZ where the primary instance is located",
17251
- "example": "[\"ap-shanghai-1\"]",
19082
+ "example": "[\"ap-shanghai-2\"]",
17252
19083
  "member": "string",
17253
19084
  "name": "MasterZone",
17254
19085
  "output_required": true,