tccli 3.0.1339.1__py2.py3-none-any.whl → 3.0.1341.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 (55) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/bh/bh_client.py +326 -8
  3. tccli/services/bh/v20230418/api.json +547 -0
  4. tccli/services/bh/v20230418/examples.json +48 -0
  5. tccli/services/ccc/v20200210/api.json +1 -1
  6. tccli/services/cdb/v20170320/api.json +144 -144
  7. tccli/services/cdb/v20170320/examples.json +19 -19
  8. tccli/services/cdn/v20180606/examples.json +1 -1
  9. tccli/services/csip/v20221121/api.json +48 -10
  10. tccli/services/csip/v20221121/examples.json +11 -11
  11. tccli/services/cvm/v20170312/api.json +9 -0
  12. tccli/services/cwp/v20180228/api.json +106 -2
  13. tccli/services/cwp/v20180228/examples.json +12 -0
  14. tccli/services/cynosdb/v20190107/api.json +29 -2
  15. tccli/services/cynosdb/v20190107/examples.json +1 -1
  16. tccli/services/dsgc/v20190723/api.json +215 -17
  17. tccli/services/emr/emr_client.py +363 -310
  18. tccli/services/emr/v20190103/api.json +299 -0
  19. tccli/services/emr/v20190103/examples.json +8 -0
  20. tccli/services/ess/v20201111/api.json +16 -5
  21. tccli/services/essbasic/v20210526/api.json +1 -1
  22. tccli/services/gs/v20191118/api.json +10 -1
  23. tccli/services/ims/v20200713/api.json +1 -1
  24. tccli/services/ims/v20200713/examples.json +1 -1
  25. tccli/services/kms/kms_client.py +915 -120
  26. tccli/services/kms/v20190118/api.json +1104 -27
  27. tccli/services/kms/v20190118/examples.json +126 -0
  28. tccli/services/live/v20180801/api.json +9 -0
  29. tccli/services/live/v20180801/examples.json +4 -4
  30. tccli/services/lke/lke_client.py +228 -16
  31. tccli/services/lke/v20231130/api.json +1490 -217
  32. tccli/services/lke/v20231130/examples.json +33 -1
  33. tccli/services/mqtt/v20240516/api.json +80 -0
  34. tccli/services/mqtt/v20240516/examples.json +6 -0
  35. tccli/services/organization/v20210331/api.json +11 -0
  36. tccli/services/organization/v20210331/examples.json +1 -1
  37. tccli/services/partners/v20180321/api.json +2 -2
  38. tccli/services/postgres/v20170312/api.json +4 -4
  39. tccli/services/ses/v20201002/api.json +8 -8
  40. tccli/services/tcss/v20201101/api.json +10 -0
  41. tccli/services/thpc/v20230321/api.json +32 -2
  42. tccli/services/tione/v20211111/api.json +11 -0
  43. tccli/services/trocket/trocket_client.py +53 -0
  44. tccli/services/trocket/v20230308/api.json +233 -143
  45. tccli/services/trocket/v20230308/examples.json +14 -6
  46. tccli/services/vpc/v20170312/api.json +9 -0
  47. tccli/services/waf/v20180125/api.json +59 -21
  48. tccli/services/wedata/v20210820/api.json +432 -10
  49. tccli/services/wedata/v20210820/examples.json +17 -1
  50. tccli/services/wedata/wedata_client.py +114 -8
  51. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/METADATA +2 -2
  52. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/RECORD +55 -55
  53. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/WHEEL +0 -0
  54. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/entry_points.txt +0 -0
  55. {tccli-3.0.1339.1.dist-info → tccli-3.0.1341.1.dist-info}/license_files/LICENSE +0 -0
@@ -8,7 +8,7 @@
8
8
  "status": "online"
9
9
  },
10
10
  "AdjustCdbProxy": {
11
- "document": "调整数据库代理配置",
11
+ "document": "本接口(AdjustCdbProxy)用于调整数据库代理配置。",
12
12
  "input": "AdjustCdbProxyRequest",
13
13
  "name": "调整数据库代理",
14
14
  "output": "AdjustCdbProxyResponse",
@@ -64,14 +64,14 @@
64
64
  "status": "online"
65
65
  },
66
66
  "CloseCdbProxyAddress": {
67
- "document": "请求关闭数据库代理地址",
67
+ "document": "本接口(CloseCdbProxyAddress)用于请求关闭数据库代理地址。",
68
68
  "input": "CloseCdbProxyAddressRequest",
69
69
  "name": "关闭数据库代理地址",
70
70
  "output": "CloseCdbProxyAddressResponse",
71
71
  "status": "online"
72
72
  },
73
73
  "CloseSSL": {
74
- "document": "关闭SSL连接功能。",
74
+ "document": "本接口(CloseSSL)用于关闭 SSL 连接功能。",
75
75
  "input": "CloseSSLRequest",
76
76
  "name": "关闭SSL",
77
77
  "output": "CloseSSLResponse",
@@ -183,7 +183,7 @@
183
183
  "status": "online"
184
184
  },
185
185
  "CreateParamTemplate": {
186
- "document": "该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数 Region 均为 ap-guangzhou。",
186
+ "document": "该接口(CreateParamTemplate)用于创建参数模板。\n说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。",
187
187
  "input": "CreateParamTemplateRequest",
188
188
  "name": "创建参数模板",
189
189
  "output": "CreateParamTemplateResponse",
@@ -260,7 +260,7 @@
260
260
  "status": "online"
261
261
  },
262
262
  "DeleteParamTemplate": {
263
- "document": "该接口(DeleteParamTemplate)用于删除参数模板,全地域公共参数 Region 均为 ap-guangzhou。",
263
+ "document": "该接口(DeleteParamTemplate)用于删除参数模板。\n说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。",
264
264
  "input": "DeleteParamTemplateRequest",
265
265
  "name": "删除参数模板",
266
266
  "output": "DeleteParamTemplateResponse",
@@ -281,7 +281,7 @@
281
281
  "status": "online"
282
282
  },
283
283
  "DescribeAccountPrivileges": {
284
- "document": "本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。",
284
+ "document": "本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。",
285
285
  "input": "DescribeAccountPrivilegesRequest",
286
286
  "name": "查询云数据库账户的权限信息",
287
287
  "output": "DescribeAccountPrivilegesResponse",
@@ -638,7 +638,7 @@
638
638
  "status": "online"
639
639
  },
640
640
  "DescribeParamTemplates": {
641
- "document": "该接口(DescribeParamTemplates)查询参数模板列表,全地域公共参数Region均为ap-guangzhou。",
641
+ "document": "该接口(DescribeParamTemplates)查询参数模板列表。\n说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。",
642
642
  "input": "DescribeParamTemplatesRequest",
643
643
  "name": "查询参数模板列表",
644
644
  "output": "DescribeParamTemplatesResponse",
@@ -659,7 +659,7 @@
659
659
  "status": "online"
660
660
  },
661
661
  "DescribeProxySupportParam": {
662
- "document": "查询实例支持代理版本和参数",
662
+ "document": "本接口(DescribeProxySupportParam)用于查询实例支持代理版本和参数。",
663
663
  "input": "DescribeProxySupportParamRequest",
664
664
  "name": "查询实例支持代理版本和参数",
665
665
  "output": "DescribeProxySupportParamResponse",
@@ -883,21 +883,21 @@
883
883
  "status": "online"
884
884
  },
885
885
  "ModifyCdbProxyAddressDesc": {
886
- "document": "修改代理地址描述信息",
886
+ "document": "本接口(ModifyCdbProxyAddressDesc)用于修改代理地址描述信息。",
887
887
  "input": "ModifyCdbProxyAddressDescRequest",
888
888
  "name": "修改代理地址描述",
889
889
  "output": "ModifyCdbProxyAddressDescResponse",
890
890
  "status": "online"
891
891
  },
892
892
  "ModifyCdbProxyAddressVipAndVPort": {
893
- "document": "修改数据库代理地址VPC信息",
893
+ "document": "本接口(ModifyCdbProxyAddressVipAndVPort)用于修改数据库代理地址VPC信息。",
894
894
  "input": "ModifyCdbProxyAddressVipAndVPortRequest",
895
895
  "name": "修改数据库代理地址VPC",
896
896
  "output": "ModifyCdbProxyAddressVipAndVPortResponse",
897
897
  "status": "online"
898
898
  },
899
899
  "ModifyCdbProxyParam": {
900
- "document": "配置数据库代理参数",
900
+ "document": "本接口(ModifyCdbProxyParam)用于配置数据库代理参数。",
901
901
  "input": "ModifyCdbProxyParamRequest",
902
902
  "name": "配置数据库代理参数",
903
903
  "output": "ModifyCdbProxyParamResponse",
@@ -981,7 +981,7 @@
981
981
  "status": "online"
982
982
  },
983
983
  "ModifyParamTemplate": {
984
- "document": "该接口(ModifyParamTemplate)用于修改参数模板,全地域公共参数Region均为ap-guangzhou。",
984
+ "document": "该接口(ModifyParamTemplate)用于修改参数模板。\n说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。",
985
985
  "input": "ModifyParamTemplateRequest",
986
986
  "name": "修改参数模板",
987
987
  "output": "ModifyParamTemplateResponse",
@@ -1023,14 +1023,14 @@
1023
1023
  "status": "online"
1024
1024
  },
1025
1025
  "OpenAuditService": {
1026
- "document": "CDB实例开通审计服务",
1026
+ "document": "本接口(OpenAuditService)用 CDB 实例开通审计服务。",
1027
1027
  "input": "OpenAuditServiceRequest",
1028
1028
  "name": "开通审计服务",
1029
1029
  "output": "OpenAuditServiceResponse",
1030
1030
  "status": "online"
1031
1031
  },
1032
1032
  "OpenDBInstanceEncryption": {
1033
- "document": "本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。\n\n注意,启用实例数据存储加密之前,需要进行以下操作:\n\n1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作;\n\n2、开启 [KMS服务](https://console.cloud.tencent.com/kms2);\n\n3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;\n\n该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。",
1033
+ "document": "本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。\n\n注意,启用实例数据存储加密之前,需要进行以下操作:\n\n1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作;\n\n2、开启 [KMS服务](https://console.cloud.tencent.com/kms2);\n\n3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;\n4、开启加密后不允许关闭。\n\n该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用 [DescribeDBInstanceInfo](https://cloud.tencent.com/document/product/236/44160) 确认后端加密是否开通成功,调用后参数 Encryption 为 YES 表示已开通成功。",
1034
1034
  "input": "OpenDBInstanceEncryptionRequest",
1035
1035
  "name": "启用数据存储加密",
1036
1036
  "output": "OpenDBInstanceEncryptionResponse",
@@ -1044,7 +1044,7 @@
1044
1044
  "status": "online"
1045
1045
  },
1046
1046
  "OpenSSL": {
1047
- "document": "开启SSL连接功能。",
1047
+ "document": "本接口(OpenSSL)用于开启 SSL 连接功能。",
1048
1048
  "input": "OpenSSLRequest",
1049
1049
  "name": "开启SSL",
1050
1050
  "output": "OpenSSLResponse",
@@ -1128,7 +1128,7 @@
1128
1128
  "status": "online"
1129
1129
  },
1130
1130
  "StopDBImportJob": {
1131
- "document": "本接口(StopDBImportJob)用于终止数据导入任务。",
1131
+ "document": "本接口(StopDBImportJob)用于终止数据导入任务。\n说明:只有未完成的导入任务支持被终止,且终止后已执行的 SQL 部分会被保留。",
1132
1132
  "input": "StopDBImportJobRequest",
1133
1133
  "name": "终止数据导入任务",
1134
1134
  "output": "StopDBImportJobResponse",
@@ -1156,7 +1156,7 @@
1156
1156
  "status": "online"
1157
1157
  },
1158
1158
  "SwitchCDBProxy": {
1159
- "document": "数据库代理配置变更或则升级版本后手动发起立即切换",
1159
+ "document": "本接口(SwitchCDBProxy)用于数据库代理配置变更或者升级版本后手动发起立即切换。",
1160
1160
  "input": "SwitchCDBProxyRequest",
1161
1161
  "name": "切换数据库代理",
1162
1162
  "output": "SwitchCDBProxyResponse",
@@ -1184,14 +1184,14 @@
1184
1184
  "status": "online"
1185
1185
  },
1186
1186
  "UpgradeCDBProxyVersion": {
1187
- "document": "升级数据库代理版本",
1187
+ "document": "本接口(UpgradeCDBProxyVersion)用于升级数据库代理版本。",
1188
1188
  "input": "UpgradeCDBProxyVersionRequest",
1189
1189
  "name": "升级数据库代理版本",
1190
1190
  "output": "UpgradeCDBProxyVersionResponse",
1191
1191
  "status": "online"
1192
1192
  },
1193
1193
  "UpgradeDBInstance": {
1194
- "document": "本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务,请一定填写实例规格(CPU、内存),不然系统会默认以最小允许规格传参。",
1194
+ "document": "本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务,请一定填写实例规格(CPU、内存),不然系统会默认以最小允许规格传参。",
1195
1195
  "input": "UpgradeDBInstanceRequest",
1196
1196
  "name": "调整云数据库实例的配置",
1197
1197
  "output": "UpgradeDBInstanceResponse",
@@ -1224,7 +1224,7 @@
1224
1224
  "members": [
1225
1225
  {
1226
1226
  "disabled": false,
1227
- "document": "新账户的名称",
1227
+ "document": "账号名,可输入1 - 32个字符。",
1228
1228
  "example": "andy",
1229
1229
  "member": "string",
1230
1230
  "name": "User",
@@ -1235,7 +1235,7 @@
1235
1235
  },
1236
1236
  {
1237
1237
  "disabled": false,
1238
- "document": "新账户的域名",
1238
+ "document": "账号的主机。\n说明:\n1. IP 形式,支持填入%。\n2. 多个主机以分隔符分隔,分隔符支持;,|换行符和空格。",
1239
1239
  "example": "172.1.1.1",
1240
1240
  "member": "string",
1241
1241
  "name": "Host",
@@ -1513,7 +1513,7 @@
1513
1513
  "members": [
1514
1514
  {
1515
1515
  "disabled": false,
1516
- "document": "代理组ID",
1516
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
1517
1517
  "example": "proxy-il2nlsdn",
1518
1518
  "member": "string",
1519
1519
  "name": "ProxyGroupId",
@@ -1540,7 +1540,7 @@
1540
1540
  },
1541
1541
  {
1542
1542
  "disabled": false,
1543
- "document": "最小保留数量,最小取值:0",
1543
+ "document": "最小保留数量,最小取值:0。\n说明:当 IsKickOut 为 true 时才有效。",
1544
1544
  "example": "2",
1545
1545
  "member": "uint64",
1546
1546
  "name": "MinCount",
@@ -1549,7 +1549,7 @@
1549
1549
  },
1550
1550
  {
1551
1551
  "disabled": false,
1552
- "document": "延迟剔除阈值,最小取值:0",
1552
+ "document": "延迟剔除阈值,最小取值:1,取值范围:[1,10000],整数。",
1553
1553
  "example": "100",
1554
1554
  "member": "uint64",
1555
1555
  "name": "MaxDelay",
@@ -1585,8 +1585,8 @@
1585
1585
  },
1586
1586
  {
1587
1587
  "disabled": false,
1588
- "document": "代理组地址ID",
1589
- "example": "proxy-il2nlsdn",
1588
+ "document": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
1589
+ "example": "proxyadd-il2nlsdn",
1590
1590
  "member": "string",
1591
1591
  "name": "ProxyAddressId",
1592
1592
  "required": true,
@@ -1594,7 +1594,7 @@
1594
1594
  },
1595
1595
  {
1596
1596
  "disabled": false,
1597
- "document": "是否开启事务分离,取值:\"true\" | \"false\"",
1597
+ "document": "是否开启事务分离,取值:\"true\" | \"false\",默认值 false。",
1598
1598
  "example": "true",
1599
1599
  "member": "bool",
1600
1600
  "name": "TransSplit",
@@ -1603,7 +1603,7 @@
1603
1603
  },
1604
1604
  {
1605
1605
  "disabled": false,
1606
- "document": "是否开启连接池\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
1606
+ "document": "是否开启连接池。默认关闭。\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
1607
1607
  "example": "true",
1608
1608
  "member": "bool",
1609
1609
  "name": "ConnectionPool",
@@ -1621,7 +1621,7 @@
1621
1621
  },
1622
1622
  {
1623
1623
  "disabled": false,
1624
- "document": "是否开启自适应负载均衡",
1624
+ "document": "是否开启自适应负载均衡。默认关闭。",
1625
1625
  "example": "false",
1626
1626
  "member": "bool",
1627
1627
  "name": "AutoLoadBalance",
@@ -1630,7 +1630,7 @@
1630
1630
  },
1631
1631
  {
1632
1632
  "disabled": false,
1633
- "document": "访问模式:就近访问,均衡分配",
1633
+ "document": "访问模式:nearby - 就近访问,balance - 均衡分配,默认就近访问。",
1634
1634
  "example": "balance",
1635
1635
  "member": "string",
1636
1636
  "name": "AccessMode",
@@ -1667,7 +1667,7 @@
1667
1667
  "members": [
1668
1668
  {
1669
1669
  "disabled": false,
1670
- "document": "实例ID",
1670
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
1671
1671
  "example": "cdb-aykuksx3",
1672
1672
  "member": "string",
1673
1673
  "name": "InstanceId",
@@ -1676,7 +1676,7 @@
1676
1676
  },
1677
1677
  {
1678
1678
  "disabled": false,
1679
- "document": "代理组ID",
1679
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
1680
1680
  "example": "proxy-il2nlsdn",
1681
1681
  "member": "string",
1682
1682
  "name": "ProxyGroupId",
@@ -1859,7 +1859,7 @@
1859
1859
  "members": [
1860
1860
  {
1861
1861
  "disabled": false,
1862
- "document": "实例ID",
1862
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
1863
1863
  "example": "cdb-r9bpb9gs",
1864
1864
  "member": "string",
1865
1865
  "name": "InstanceId",
@@ -1905,7 +1905,7 @@
1905
1905
  {
1906
1906
  "disabled": false,
1907
1907
  "document": "该过滤条件下的审计日志结果集作为分析日志。",
1908
- "example": "{\"SqlTypes\": [\"SELECT\"]}",
1908
+ "example": "[{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"delete\"]}]",
1909
1909
  "member": "InstanceAuditLogFilters",
1910
1910
  "name": "LogFilter",
1911
1911
  "required": false,
@@ -4297,7 +4297,7 @@
4297
4297
  "members": [
4298
4298
  {
4299
4299
  "disabled": false,
4300
- "document": "实例ID",
4300
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
4301
4301
  "example": "cdb-22dhn3e3",
4302
4302
  "member": "string",
4303
4303
  "name": "InstanceId",
@@ -4324,7 +4324,7 @@
4324
4324
  "members": [
4325
4325
  {
4326
4326
  "disabled": false,
4327
- "document": "实例ID",
4327
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
4328
4328
  "example": "cdb-93hvfedd",
4329
4329
  "member": "string",
4330
4330
  "name": "InstanceId",
@@ -4333,7 +4333,7 @@
4333
4333
  },
4334
4334
  {
4335
4335
  "disabled": false,
4336
- "document": "代理组ID",
4336
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
4337
4337
  "example": "proxy-ixw3ll2d",
4338
4338
  "member": "string",
4339
4339
  "name": "ProxyGroupId",
@@ -4369,7 +4369,7 @@
4369
4369
  "members": [
4370
4370
  {
4371
4371
  "disabled": false,
4372
- "document": "代理组ID",
4372
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
4373
4373
  "example": "proxy-aykuksx3",
4374
4374
  "member": "string",
4375
4375
  "name": "ProxyGroupId",
@@ -4378,7 +4378,7 @@
4378
4378
  },
4379
4379
  {
4380
4380
  "disabled": false,
4381
- "document": "代理组地址ID",
4381
+ "document": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
4382
4382
  "example": "proxyaddr-aykuksx3",
4383
4383
  "member": "string",
4384
4384
  "name": "ProxyAddressId",
@@ -4405,8 +4405,8 @@
4405
4405
  "members": [
4406
4406
  {
4407
4407
  "disabled": false,
4408
- "document": "实例 ID 。只读组 ID为空时必填。",
4409
- "example": "cdb-test",
4408
+ "document": "实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
4409
+ "example": "cdb-je5egmdl",
4410
4410
  "member": "string",
4411
4411
  "name": "InstanceId",
4412
4412
  "required": false,
@@ -4414,8 +4414,8 @@
4414
4414
  },
4415
4415
  {
4416
4416
  "disabled": false,
4417
- "document": "只读组 ID。实例 ID为空时必填。",
4418
- "example": "cdbrg-test",
4417
+ "document": "只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。",
4418
+ "example": "cdbrg-k9a6gup3",
4419
4419
  "member": "string",
4420
4420
  "name": "RoGroupId",
4421
4421
  "required": false,
@@ -4433,7 +4433,7 @@
4433
4433
  "example": "123asd21-2dasdasd-123qcsdw-313213",
4434
4434
  "member": "string",
4435
4435
  "name": "AsyncRequestId",
4436
- "required": true,
4436
+ "output_required": true,
4437
4437
  "type": "string",
4438
4438
  "value_allowed_null": false
4439
4439
  },
@@ -5078,7 +5078,7 @@
5078
5078
  "members": [
5079
5079
  {
5080
5080
  "disabled": false,
5081
- "document": "审计规则",
5081
+ "document": "审计规则。",
5082
5082
  "example": "[{\"Type\": \"host\",\"Compare\": \"EQS\",\"Value\": [\"100.122.76.176\",\"10.0.0.9\"]}]",
5083
5083
  "member": "RuleFilters",
5084
5084
  "name": "RuleFilters",
@@ -5087,7 +5087,7 @@
5087
5087
  },
5088
5088
  {
5089
5089
  "disabled": false,
5090
- "document": "规则模板名称",
5090
+ "document": "规则模板名称。最多支持输入30个字符。",
5091
5091
  "example": "andy",
5092
5092
  "member": "string",
5093
5093
  "name": "RuleTemplateName",
@@ -5096,7 +5096,7 @@
5096
5096
  },
5097
5097
  {
5098
5098
  "disabled": false,
5099
- "document": "规则模板描述",
5099
+ "document": "规则模板描述。最多支持输入200个字符。",
5100
5100
  "example": "用于测试的规则模板",
5101
5101
  "member": "string",
5102
5102
  "name": "Description",
@@ -5105,7 +5105,7 @@
5105
5105
  },
5106
5106
  {
5107
5107
  "disabled": false,
5108
- "document": "告警等级。1-低风险,2-中风险,3-高风险",
5108
+ "document": "告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。",
5109
5109
  "example": "3",
5110
5110
  "member": "uint64",
5111
5111
  "name": "AlarmLevel",
@@ -5114,7 +5114,7 @@
5114
5114
  },
5115
5115
  {
5116
5116
  "disabled": false,
5117
- "document": "告警策略。0-不告警,1-告警",
5117
+ "document": "告警策略。0 - 不告警,1 - 告警。默认值为0。",
5118
5118
  "example": "1",
5119
5119
  "member": "uint64",
5120
5120
  "name": "AlarmPolicy",
@@ -5224,7 +5224,7 @@
5224
5224
  "members": [
5225
5225
  {
5226
5226
  "disabled": false,
5227
- "document": "代理组ID",
5227
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
5228
5228
  "example": "proxy-kti9m7m1",
5229
5229
  "member": "string",
5230
5230
  "name": "ProxyGroupId",
@@ -5260,7 +5260,7 @@
5260
5260
  },
5261
5261
  {
5262
5262
  "disabled": false,
5263
- "document": "延迟剔除阈值,最小取值:0",
5263
+ "document": "延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。",
5264
5264
  "example": "100",
5265
5265
  "member": "uint64",
5266
5266
  "name": "MaxDelay",
@@ -5314,7 +5314,7 @@
5314
5314
  },
5315
5315
  {
5316
5316
  "disabled": false,
5317
- "document": "私有网络ID",
5317
+ "document": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
5318
5318
  "example": "vpc-ixw3ll2d",
5319
5319
  "member": "string",
5320
5320
  "name": "UniqVpcId",
@@ -5323,7 +5323,7 @@
5323
5323
  },
5324
5324
  {
5325
5325
  "disabled": false,
5326
- "document": "私有子网ID",
5326
+ "document": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
5327
5327
  "example": "subnet-0z3r56vq",
5328
5328
  "member": "string",
5329
5329
  "name": "UniqSubnetId",
@@ -5332,7 +5332,7 @@
5332
5332
  },
5333
5333
  {
5334
5334
  "disabled": false,
5335
- "document": "是否开启连接池\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
5335
+ "document": "是否开启连接池。默认关闭。\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
5336
5336
  "example": "true",
5337
5337
  "member": "bool",
5338
5338
  "name": "ConnectionPool",
@@ -5350,7 +5350,7 @@
5350
5350
  },
5351
5351
  {
5352
5352
  "disabled": false,
5353
- "document": "IP地址",
5353
+ "document": "IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。",
5354
5354
  "example": "192.0.0.1",
5355
5355
  "member": "string",
5356
5356
  "name": "Vip",
@@ -5359,7 +5359,7 @@
5359
5359
  },
5360
5360
  {
5361
5361
  "disabled": false,
5362
- "document": "端口",
5362
+ "document": "端口。默认值3306。",
5363
5363
  "example": "80",
5364
5364
  "member": "uint64",
5365
5365
  "name": "VPort",
@@ -5377,7 +5377,7 @@
5377
5377
  },
5378
5378
  {
5379
5379
  "disabled": false,
5380
- "document": "连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。",
5380
+ "document": "连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。",
5381
5381
  "example": "connection",
5382
5382
  "member": "string",
5383
5383
  "name": "ConnectionPoolType",
@@ -5386,7 +5386,7 @@
5386
5386
  },
5387
5387
  {
5388
5388
  "disabled": false,
5389
- "document": "是否自适应负载均衡",
5389
+ "document": "是否开启自适应负载均衡。默认关闭。",
5390
5390
  "example": "false",
5391
5391
  "member": "bool",
5392
5392
  "name": "AutoLoadBalance",
@@ -5395,7 +5395,7 @@
5395
5395
  },
5396
5396
  {
5397
5397
  "disabled": false,
5398
- "document": "接入模式",
5398
+ "document": "接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。",
5399
5399
  "example": "nearBy",
5400
5400
  "member": "string",
5401
5401
  "name": "AccessMode",
@@ -5432,7 +5432,7 @@
5432
5432
  "members": [
5433
5433
  {
5434
5434
  "disabled": false,
5435
- "document": "实例ID",
5435
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
5436
5436
  "example": "cdb-aykuksx3",
5437
5437
  "member": "string",
5438
5438
  "name": "InstanceId",
@@ -5441,7 +5441,7 @@
5441
5441
  },
5442
5442
  {
5443
5443
  "disabled": false,
5444
- "document": "私有网络ID",
5444
+ "document": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
5445
5445
  "example": "vpc-ixw3ll2d",
5446
5446
  "member": "string",
5447
5447
  "name": "UniqVpcId",
@@ -5450,7 +5450,7 @@
5450
5450
  },
5451
5451
  {
5452
5452
  "disabled": false,
5453
- "document": "私有子网ID",
5453
+ "document": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
5454
5454
  "example": "subnet-0z3r56vq",
5455
5455
  "member": "string",
5456
5456
  "name": "UniqSubnetId",
@@ -5469,7 +5469,7 @@
5469
5469
  {
5470
5470
  "disabled": false,
5471
5471
  "document": "安全组",
5472
- "example": "[{\"security\"}]",
5472
+ "example": "[\"security\"]",
5473
5473
  "member": "string",
5474
5474
  "name": "SecurityGroup",
5475
5475
  "required": false,
@@ -7202,7 +7202,7 @@
7202
7202
  "members": [
7203
7203
  {
7204
7204
  "disabled": false,
7205
- "document": "审计日志文件名称。",
7205
+ "document": "审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。",
7206
7206
  "example": "13123**346_cdb-0ej6n21d_1734**9765_42322441.csv",
7207
7207
  "member": "string",
7208
7208
  "name": "FileName",
@@ -7211,7 +7211,7 @@
7211
7211
  },
7212
7212
  {
7213
7213
  "disabled": false,
7214
- "document": "实例 ID",
7214
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
7215
7215
  "example": "cdb-0ej6n21d",
7216
7216
  "member": "string",
7217
7217
  "name": "InstanceId",
@@ -7639,7 +7639,7 @@
7639
7639
  },
7640
7640
  {
7641
7641
  "disabled": false,
7642
- "document": "数据库的账号名称。",
7642
+ "document": "数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。",
7643
7643
  "example": "ajnnw",
7644
7644
  "member": "string",
7645
7645
  "name": "User",
@@ -7648,7 +7648,7 @@
7648
7648
  },
7649
7649
  {
7650
7650
  "disabled": false,
7651
- "document": "数据库的账号域名。",
7651
+ "document": "数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。",
7652
7652
  "example": "127.0.0.1",
7653
7653
  "member": "string",
7654
7654
  "name": "Host",
@@ -7664,40 +7664,40 @@
7664
7664
  {
7665
7665
  "disabled": false,
7666
7666
  "document": "全局权限数组。",
7667
- "example": "[\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\",\"DROP\",\"REFERENCES",
7667
+ "example": "[\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"...\",\"TRIGGER\"]",
7668
7668
  "member": "string",
7669
7669
  "name": "GlobalPrivileges",
7670
- "required": true,
7670
+ "output_required": true,
7671
7671
  "type": "list",
7672
7672
  "value_allowed_null": false
7673
7673
  },
7674
7674
  {
7675
7675
  "disabled": false,
7676
7676
  "document": "数据库权限数组。",
7677
- "example": "",
7677
+ "example": "[{\"Privileges\": [\"CREATE\",\"DROP\"],\"Database\": \"jersey\"}]",
7678
7678
  "member": "DatabasePrivilege",
7679
7679
  "name": "DatabasePrivileges",
7680
- "required": true,
7680
+ "output_required": true,
7681
7681
  "type": "list",
7682
7682
  "value_allowed_null": false
7683
7683
  },
7684
7684
  {
7685
7685
  "disabled": false,
7686
7686
  "document": "数据库中的表权限数组。",
7687
- "example": "",
7687
+ "example": "[{\"Table\": \"user\",\"Privileges\": [\"SELECT\",\"INSERT\"],\"Database\": \"mysql\"}]",
7688
7688
  "member": "TablePrivilege",
7689
7689
  "name": "TablePrivileges",
7690
- "required": true,
7690
+ "output_required": true,
7691
7691
  "type": "list",
7692
7692
  "value_allowed_null": false
7693
7693
  },
7694
7694
  {
7695
7695
  "disabled": false,
7696
7696
  "document": "数据库表中的列权限数组。",
7697
- "example": "",
7697
+ "example": "[{\"Column\": \"Host\",\"Table\": \"user\",\"Privileges\": [\"SELECT\",\"INSERT\"],\"Database\": \"mysql\"}]",
7698
7698
  "member": "ColumnPrivilege",
7699
7699
  "name": "ColumnPrivileges",
7700
- "required": true,
7700
+ "output_required": true,
7701
7701
  "type": "list",
7702
7702
  "value_allowed_null": false
7703
7703
  },
@@ -8005,7 +8005,7 @@
8005
8005
  },
8006
8006
  {
8007
8007
  "disabled": false,
8008
- "document": "分页大小参数。默认值为 20,最小值为 1,最大值为 100。",
8008
+ "document": "分页大小参数。默认值为20,最小值为1,最大值为300。",
8009
8009
  "example": "10",
8010
8010
  "member": "int64",
8011
8011
  "name": "Limit",
@@ -8049,7 +8049,7 @@
8049
8049
  {
8050
8050
  "disabled": false,
8051
8051
  "document": "审计日志文件详情。",
8052
- "example": "[{\"FileName\": \"shenji_andy\", \"CreateTime\": \"2024-03-20 17:09:13\",\"Status\": success}]",
8052
+ "example": "[{\"FileName\": \"shenji_andy\", \"CreateTime\": \"2024-03-20 17:09:13\",\"Status\": \"success\"...}]",
8053
8053
  "member": "AuditLogFile",
8054
8054
  "name": "Items",
8055
8055
  "output_required": true,
@@ -8391,7 +8391,7 @@
8391
8391
  },
8392
8392
  {
8393
8393
  "disabled": false,
8394
- "document": "单次请求返回的数量。默认值20。",
8394
+ "document": "单次请求返回的数量。默认值20,最大值为1000。",
8395
8395
  "example": "10",
8396
8396
  "member": "uint64",
8397
8397
  "name": "Limit",
@@ -9359,7 +9359,7 @@
9359
9359
  "members": [
9360
9360
  {
9361
9361
  "disabled": false,
9362
- "document": "实例 ID",
9362
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
9363
9363
  "example": "cdb-xxdasd",
9364
9364
  "member": "string",
9365
9365
  "name": "InstanceId",
@@ -9374,7 +9374,7 @@
9374
9374
  "members": [
9375
9375
  {
9376
9376
  "disabled": false,
9377
- "document": "策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。\n注意:此字段可能返回 null,表示取不到有效值。",
9377
+ "document": "策略类型。输出值:auto、manual、timeInterval、period。\n说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。\n注意:此字段可能返回 null,表示取不到有效值。",
9378
9378
  "example": "auto",
9379
9379
  "member": "string",
9380
9380
  "name": "Type",
@@ -9384,7 +9384,7 @@
9384
9384
  },
9385
9385
  {
9386
9386
  "disabled": false,
9387
- "document": "手动扩容的 CPU 。Type 为 manual 时有效。\n注意:此字段可能返回 null,表示取不到有效值。",
9387
+ "document": "自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。\n注意:此字段可能返回 null,表示取不到有效值。",
9388
9388
  "example": "4",
9389
9389
  "member": "int64",
9390
9390
  "name": "ExpandCpu",
@@ -9404,7 +9404,7 @@
9404
9404
  },
9405
9405
  {
9406
9406
  "disabled": false,
9407
- "document": "按周期扩容策略。",
9407
+ "document": "按周期扩容策略。当 Type 为 period 时有效。",
9408
9408
  "example": "{\"TimeCycle\": {\"Friday\": true,\"Monday\": true,\"Saturday\": false,\"Sunday\": false,\"Thursday\": true,\"Tuesday\": false,\"Wednesday\": true},\"TimeInterval\": {\"EndTime\": \"00:00\",\"StartTime\": \"08:00\"}}",
9409
9409
  "member": "PeriodStrategy",
9410
9410
  "name": "PeriodStrategy",
@@ -9414,8 +9414,8 @@
9414
9414
  },
9415
9415
  {
9416
9416
  "disabled": false,
9417
- "document": "按时间段扩容策略。",
9418
- "example": "{\"StartTime\": 1749722400}",
9417
+ "document": "按时间段扩容策略。当 Type 为 timeInterval 时有效。",
9418
+ "example": "{\"EndTime\": 1750348800,\"StartTime\": 1750338000}",
9419
9419
  "member": "TimeIntervalStrategy",
9420
9420
  "name": "TimeIntervalStrategy",
9421
9421
  "output_required": false,
@@ -9584,7 +9584,7 @@
9584
9584
  "members": [
9585
9585
  {
9586
9586
  "disabled": false,
9587
- "document": "实例 ID",
9587
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。\n说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。",
9588
9588
  "example": "cdb-dctw4edd",
9589
9589
  "member": "string",
9590
9590
  "name": "InstanceId",
@@ -11755,7 +11755,7 @@
11755
11755
  "members": [
11756
11756
  {
11757
11757
  "disabled": false,
11758
- "document": "实例ID",
11758
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
11759
11759
  "example": "\"cdb-g3rbtabc\"",
11760
11760
  "member": "string",
11761
11761
  "name": "InstanceId",
@@ -11764,7 +11764,7 @@
11764
11764
  },
11765
11765
  {
11766
11766
  "disabled": false,
11767
- "document": "目标数据库版本",
11767
+ "document": "目标数据库版本。\n说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。",
11768
11768
  "example": "\"8.0\"",
11769
11769
  "member": "string",
11770
11770
  "name": "DstMysqlVersion",
@@ -12194,7 +12194,7 @@
12194
12194
  "members": [
12195
12195
  {
12196
12196
  "disabled": false,
12197
- "document": "项目ID",
12197
+ "document": "项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。",
12198
12198
  "example": "11954",
12199
12199
  "member": "int64",
12200
12200
  "name": "ProjectId",
@@ -12210,7 +12210,7 @@
12210
12210
  {
12211
12211
  "disabled": false,
12212
12212
  "document": "安全组详情。",
12213
- "example": "[]",
12213
+ "example": "[{\"Outbound\": [],\"SecurityGroupName\": \"CDB\",\"Inbound\": [],\"ProjectId\": 11954,\"SecurityGroupId\": \"sg-disnd\",\"SecurityGroupRemark\": \"\",\"CreateTime\": \"2017-04-13 15:00:06\"}]",
12214
12214
  "member": "SecurityGroup",
12215
12215
  "name": "Groups",
12216
12216
  "output_required": true,
@@ -12316,7 +12316,7 @@
12316
12316
  "members": [
12317
12317
  {
12318
12318
  "disabled": false,
12319
- "document": "实例ID",
12319
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
12320
12320
  "example": "cdb-aykuksx3",
12321
12321
  "member": "string",
12322
12322
  "name": "InstanceId",
@@ -15678,7 +15678,7 @@
15678
15678
  },
15679
15679
  {
15680
15680
  "disabled": false,
15681
- "document": "账户的名称",
15681
+ "document": "账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。",
15682
15682
  "example": "andy",
15683
15683
  "member": "string",
15684
15684
  "name": "User",
@@ -15687,7 +15687,7 @@
15687
15687
  },
15688
15688
  {
15689
15689
  "disabled": false,
15690
- "document": "账户的旧主机",
15690
+ "document": "账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。",
15691
15691
  "example": "172.1.1.1",
15692
15692
  "member": "string",
15693
15693
  "name": "Host",
@@ -15696,7 +15696,7 @@
15696
15696
  },
15697
15697
  {
15698
15698
  "disabled": false,
15699
- "document": "账户的新主机",
15699
+ "document": "账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。",
15700
15700
  "example": "172.1.1.2",
15701
15701
  "member": "string",
15702
15702
  "name": "NewHost",
@@ -15934,7 +15934,7 @@
15934
15934
  "members": [
15935
15935
  {
15936
15936
  "disabled": false,
15937
- "document": "实例 ID",
15937
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
15938
15938
  "example": "cdb-txcniupi",
15939
15939
  "member": "string",
15940
15940
  "name": "InstanceId",
@@ -15952,7 +15952,7 @@
15952
15952
  },
15953
15953
  {
15954
15954
  "disabled": false,
15955
- "document": "是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。\n当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。\nCloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。",
15955
+ "document": "是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。\n说明:\n1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。\n2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。\n3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。",
15956
15956
  "example": "true",
15957
15957
  "member": "bool",
15958
15958
  "name": "CloseAudit",
@@ -16051,7 +16051,7 @@
16051
16051
  "members": [
16052
16052
  {
16053
16053
  "disabled": false,
16054
- "document": "审计规则模板ID",
16054
+ "document": "审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。",
16055
16055
  "example": "cdb-art-l1mlbo59",
16056
16056
  "member": "string",
16057
16057
  "name": "RuleTemplateIds",
@@ -16123,7 +16123,7 @@
16123
16123
  "members": [
16124
16124
  {
16125
16125
  "disabled": false,
16126
- "document": "实例ID",
16126
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
16127
16127
  "example": "cdb-22dhn3e3",
16128
16128
  "member": "string",
16129
16129
  "name": "InstanceId",
@@ -16132,7 +16132,7 @@
16132
16132
  },
16133
16133
  {
16134
16134
  "disabled": false,
16135
- "document": "日志保留时长。",
16135
+ "document": "日志保留时长。支持值包括:\n7 - 一周;\n30 - 一个月;\n90 - 三个月;\n180 - 六个月;\n365 - 一年;\n1095 - 三年;\n1825 - 五年。",
16136
16136
  "example": "30",
16137
16137
  "member": "uint64",
16138
16138
  "name": "LogExpireDay",
@@ -16141,7 +16141,7 @@
16141
16141
  },
16142
16142
  {
16143
16143
  "disabled": false,
16144
- "document": "高频日志保留时长。",
16144
+ "document": "高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:\n3 - 3天;\n7 - 一周;\n30 - 一个月;\n90 - 三个月;\n180 - 六个月;\n365 - 一年;\n1095 - 三年;\n1825 - 五年。",
16145
16145
  "example": "7",
16146
16146
  "member": "uint64",
16147
16147
  "name": "HighLogExpireDay",
@@ -16168,7 +16168,7 @@
16168
16168
  },
16169
16169
  {
16170
16170
  "disabled": false,
16171
- "document": "规则模板ID",
16171
+ "document": "规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。",
16172
16172
  "example": "cdb-art-nuf7e111",
16173
16173
  "member": "string",
16174
16174
  "name": "RuleTemplateIds",
@@ -16528,7 +16528,7 @@
16528
16528
  "members": [
16529
16529
  {
16530
16530
  "disabled": false,
16531
- "document": "代理组ID",
16531
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
16532
16532
  "example": "proxy-ixw3ll2d",
16533
16533
  "member": "string",
16534
16534
  "name": "ProxyGroupId",
@@ -16537,7 +16537,7 @@
16537
16537
  },
16538
16538
  {
16539
16539
  "disabled": false,
16540
- "document": "代理组地址ID",
16540
+ "document": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
16541
16541
  "example": "proxyaddr-ixw3ll2d",
16542
16542
  "member": "string",
16543
16543
  "name": "ProxyAddressId",
@@ -16573,7 +16573,7 @@
16573
16573
  "members": [
16574
16574
  {
16575
16575
  "disabled": false,
16576
- "document": "代理组ID",
16576
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
16577
16577
  "example": "proxy-ixw3ll2d",
16578
16578
  "member": "string",
16579
16579
  "name": "ProxyGroupId",
@@ -16582,7 +16582,7 @@
16582
16582
  },
16583
16583
  {
16584
16584
  "disabled": false,
16585
- "document": "代理组地址ID",
16585
+ "document": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
16586
16586
  "example": "proxyaddr-ixw3ll2d",
16587
16587
  "member": "string",
16588
16588
  "name": "ProxyAddressId",
@@ -16591,7 +16591,7 @@
16591
16591
  },
16592
16592
  {
16593
16593
  "disabled": false,
16594
- "document": "私有网络ID",
16594
+ "document": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
16595
16595
  "example": "vpc-ixw3ll2d",
16596
16596
  "member": "string",
16597
16597
  "name": "UniqVpcId",
@@ -16600,7 +16600,7 @@
16600
16600
  },
16601
16601
  {
16602
16602
  "disabled": false,
16603
- "document": "私有子网ID",
16603
+ "document": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
16604
16604
  "example": "subnet-ixw3ll2d",
16605
16605
  "member": "string",
16606
16606
  "name": "UniqSubnetId",
@@ -16609,7 +16609,7 @@
16609
16609
  },
16610
16610
  {
16611
16611
  "disabled": false,
16612
- "document": "IP地址",
16612
+ "document": "IP 地址。若不填写则自动分配子网下的可用 IP。",
16613
16613
  "example": "192.0.0.1",
16614
16614
  "member": "string",
16615
16615
  "name": "Vip",
@@ -16618,7 +16618,7 @@
16618
16618
  },
16619
16619
  {
16620
16620
  "disabled": false,
16621
- "document": "端口",
16621
+ "document": "端口。默认值3306,取值范围:1024 - 65535。",
16622
16622
  "example": "80",
16623
16623
  "member": "uint64",
16624
16624
  "name": "VPort",
@@ -16627,7 +16627,7 @@
16627
16627
  },
16628
16628
  {
16629
16629
  "disabled": false,
16630
- "document": "旧IP地址回收时间",
16630
+ "document": "旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。",
16631
16631
  "example": "10",
16632
16632
  "member": "uint64",
16633
16633
  "name": "ReleaseDuration",
@@ -16654,7 +16654,7 @@
16654
16654
  "members": [
16655
16655
  {
16656
16656
  "disabled": false,
16657
- "document": "实例ID",
16657
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
16658
16658
  "example": "cdb-aykuksx3",
16659
16659
  "member": "string",
16660
16660
  "name": "InstanceId",
@@ -16663,7 +16663,7 @@
16663
16663
  },
16664
16664
  {
16665
16665
  "disabled": false,
16666
- "document": "代理组ID",
16666
+ "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
16667
16667
  "example": "proxy-ixw3ll2d",
16668
16668
  "member": "string",
16669
16669
  "name": "ProxyGroupId",
@@ -16672,7 +16672,7 @@
16672
16672
  },
16673
16673
  {
16674
16674
  "disabled": false,
16675
- "document": "连接池阈值\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
16675
+ "document": "连接池阈值。取值范围:大于0,小于等于300。\n注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。",
16676
16676
  "example": "10",
16677
16677
  "member": "uint64",
16678
16678
  "name": "ConnectionPoolLimit",
@@ -17666,7 +17666,7 @@
17666
17666
  "members": [
17667
17667
  {
17668
17668
  "disabled": false,
17669
- "document": "CDB实例ID",
17669
+ "document": "CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
17670
17670
  "example": "cdb-etxaaa12",
17671
17671
  "member": "string",
17672
17672
  "name": "InstanceId",
@@ -17675,7 +17675,7 @@
17675
17675
  },
17676
17676
  {
17677
17677
  "disabled": false,
17678
- "document": "审计日志保存时长。支持值包括:\n7 - 一周\n30 - 一个月;\n90 - 三个月;\n180 - 六个月;\n365 - 一年;\n1095 - 三年;\n1825 - 五年;",
17678
+ "document": "审计日志保存时长。支持值包括:\n7 - 一周;\n30 - 一个月;\n90 - 三个月;\n180 - 六个月;\n365 - 一年;\n1095 - 三年;\n1825 - 五年。",
17679
17679
  "example": "30",
17680
17680
  "member": "uint64",
17681
17681
  "name": "LogExpireDay",
@@ -17684,7 +17684,7 @@
17684
17684
  },
17685
17685
  {
17686
17686
  "disabled": false,
17687
- "document": "高频审计日志保存时长。支持值包括:\n7 - 一周\n30 - 一个月;",
17687
+ "document": "高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:\n3 - 3天;\n7 - 一周;\n30 - 一个月;\n90 - 三个月;\n180 - 六个月;\n365 - 一年;\n1095 - 三年;\n1825 - 五年。",
17688
17688
  "example": "7",
17689
17689
  "member": "uint64",
17690
17690
  "name": "HighLogExpireDay",
@@ -17702,7 +17702,7 @@
17702
17702
  },
17703
17703
  {
17704
17704
  "disabled": false,
17705
- "document": "规则模板ID。同AuditRuleFilters都不填是全审计。",
17705
+ "document": "规则模板 ID",
17706
17706
  "example": "[\"cdb-art-l1mlbo59\"]",
17707
17707
  "member": "string",
17708
17708
  "name": "RuleTemplateIds",
@@ -17711,7 +17711,7 @@
17711
17711
  },
17712
17712
  {
17713
17713
  "disabled": false,
17714
- "document": "审计类型。true-全审计;默认false-规则审计。",
17714
+ "document": "审计类型。true - 全审计;默认 false - 规则审计。",
17715
17715
  "example": "true",
17716
17716
  "member": "bool",
17717
17717
  "name": "AuditAll",
@@ -17738,7 +17738,7 @@
17738
17738
  "members": [
17739
17739
  {
17740
17740
  "disabled": false,
17741
- "document": "云数据库实例 ID",
17741
+ "document": "云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
17742
17742
  "example": "cdb-qwer1234",
17743
17743
  "member": "string",
17744
17744
  "name": "InstanceId",
@@ -17820,8 +17820,8 @@
17820
17820
  "members": [
17821
17821
  {
17822
17822
  "disabled": false,
17823
- "document": "实例 ID ",
17824
- "example": "cdb-test",
17823
+ "document": "实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
17824
+ "example": "cdb-je5egmdl",
17825
17825
  "member": "string",
17826
17826
  "name": "InstanceId",
17827
17827
  "required": false,
@@ -17829,8 +17829,8 @@
17829
17829
  },
17830
17830
  {
17831
17831
  "disabled": false,
17832
- "document": "只读组 ID",
17833
- "example": "cdbrg-test",
17832
+ "document": "只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。",
17833
+ "example": "cdbrg-k9a6gup3",
17834
17834
  "member": "string",
17835
17835
  "name": "RoGroupId",
17836
17836
  "required": false,
@@ -17848,7 +17848,7 @@
17848
17848
  "example": "123asd21-2dasdasd-123qcsdw-313213",
17849
17849
  "member": "string",
17850
17850
  "name": "AsyncRequestId",
17851
- "required": true,
17851
+ "output_required": true,
17852
17852
  "type": "string",
17853
17853
  "value_allowed_null": false
17854
17854
  },
@@ -17866,7 +17866,7 @@
17866
17866
  "members": [
17867
17867
  {
17868
17868
  "disabled": false,
17869
- "document": "实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。",
17869
+ "document": "实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。",
17870
17870
  "example": "cdb-ezq1vzem",
17871
17871
  "member": "string",
17872
17872
  "name": "InstanceId",
@@ -19496,7 +19496,7 @@
19496
19496
  },
19497
19497
  {
19498
19498
  "disabled": false,
19499
- "document": "RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。",
19499
+ "document": "RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。\n注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。",
19500
19500
  "example": "10",
19501
19501
  "member": "int64",
19502
19502
  "name": "RoMaxDelayTime",
@@ -19514,7 +19514,7 @@
19514
19514
  },
19515
19515
  {
19516
19516
  "disabled": false,
19517
- "document": "最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。",
19517
+ "document": "最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。\n注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。",
19518
19518
  "example": "1",
19519
19519
  "member": "int64",
19520
19520
  "name": "MinRoInGroup",
@@ -19532,7 +19532,7 @@
19532
19532
  },
19533
19533
  {
19534
19534
  "disabled": false,
19535
- "document": "延迟复制时间。",
19535
+ "document": "延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。",
19536
19536
  "example": "100",
19537
19537
  "member": "int64",
19538
19538
  "name": "ReplicationDelayTime",
@@ -20787,7 +20787,7 @@
20787
20787
  "members": [
20788
20788
  {
20789
20789
  "disabled": false,
20790
- "document": "实例 ID",
20790
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
20791
20791
  "example": "cdb-himitj11",
20792
20792
  "member": "string",
20793
20793
  "name": "InstanceId",
@@ -20815,7 +20815,7 @@
20815
20815
  {
20816
20816
  "disabled": false,
20817
20817
  "document": "自动扩容策略。Type 为 auto 时必传。",
20818
- "example": "[{\"ExpandThreshold\": \"70\",\"ShrinkThreshold\": \"\t10\",\"ExpandPeriod\": \"1\",\"ShrinkPeriod\": \"5\"}]",
20818
+ "example": "{\"ExpandThreshold\": 70,\"ShrinkThreshold\": 30,\"ExpandSecondPeriod\": 15,\"ShrinkSecondPeriod\": 300}",
20819
20819
  "member": "AutoStrategy",
20820
20820
  "name": "AutoStrategy",
20821
20821
  "required": false,
@@ -20823,8 +20823,8 @@
20823
20823
  },
20824
20824
  {
20825
20825
  "disabled": false,
20826
- "document": "按时间段扩容策略。",
20827
- "example": "[{\"StartTime\": 1749546000,\"EndTime\": 1749718800}]",
20826
+ "document": "按时间段扩容策略。\n说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。",
20827
+ "example": "{\"StartTime\": 1749546000,\"EndTime\": 1749718800}",
20828
20828
  "member": "TimeIntervalStrategy",
20829
20829
  "name": "TimeIntervalStrategy",
20830
20830
  "required": false,
@@ -20832,8 +20832,8 @@
20832
20832
  },
20833
20833
  {
20834
20834
  "disabled": false,
20835
- "document": "按周期扩容策略。",
20836
- "example": "[{\"TimeCycle\": {\"Monday\": true,\"Tuesday\": false,\"Wednesday\": false,\"Thursday\": false,\"Friday\": true,\"Saturday\": false,\"Sunday\": false},\"TimeInterval\": {\"StartTime\": \"17:00\",\"EndTime\": \"20:00\"}}]",
20835
+ "document": "按周期扩容策略。\n说明:当 Type 为 period 时,PeriodStrategy 必填。",
20836
+ "example": "{\"TimeCycle\": {\"Monday\": true,\"Tuesday\": false,\"Wednesday\": false,\"Thursday\": false,\"Friday\": true,\"Saturday\": false,\"Sunday\": false},\"TimeInterval\": {\"StartTime\": \"17:00\",\"EndTime\": \"20:00\"}}",
20837
20837
  "member": "PeriodStrategy",
20838
20838
  "name": "PeriodStrategy",
20839
20839
  "required": false,
@@ -20847,7 +20847,7 @@
20847
20847
  "members": [
20848
20848
  {
20849
20849
  "disabled": false,
20850
- "document": "异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询",
20850
+ "document": "异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。",
20851
20851
  "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
20852
20852
  "member": "string",
20853
20853
  "name": "AsyncRequestId",
@@ -21044,7 +21044,7 @@
21044
21044
  "members": [
21045
21045
  {
21046
21046
  "disabled": false,
21047
- "document": "实例 ID",
21047
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
21048
21048
  "example": "cdb-g3rbtabc",
21049
21049
  "member": "string",
21050
21050
  "name": "InstanceId",
@@ -21053,7 +21053,7 @@
21053
21053
  },
21054
21054
  {
21055
21055
  "disabled": false,
21056
- "document": "目标数据库版本。",
21056
+ "document": "目标数据库版本。\n说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。",
21057
21057
  "example": "8.0",
21058
21058
  "member": "string",
21059
21059
  "name": "DstMysqlVersion",
@@ -21090,7 +21090,7 @@
21090
21090
  "members": [
21091
21091
  {
21092
21092
  "disabled": false,
21093
- "document": "实例ID",
21093
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
21094
21094
  "example": "cdb-pr1rb3j1",
21095
21095
  "member": "string",
21096
21096
  "name": "InstanceId",
@@ -21099,7 +21099,7 @@
21099
21099
  },
21100
21100
  {
21101
21101
  "disabled": false,
21102
- "document": "数据库代理ID",
21102
+ "document": "数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
21103
21103
  "example": "proxy-p11rb3j9",
21104
21104
  "member": "string",
21105
21105
  "name": "ProxyGroupId",
@@ -21717,7 +21717,7 @@
21717
21717
  "members": [
21718
21718
  {
21719
21719
  "disabled": false,
21720
- "document": "实例ID",
21720
+ "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
21721
21721
  "example": "cdb-pr1rb3j1",
21722
21722
  "member": "string",
21723
21723
  "name": "InstanceId",
@@ -21726,7 +21726,7 @@
21726
21726
  },
21727
21727
  {
21728
21728
  "disabled": false,
21729
- "document": "数据库代理ID",
21729
+ "document": "数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
21730
21730
  "example": "proxy-p11rb3j9",
21731
21731
  "member": "string",
21732
21732
  "name": "ProxyGroupId",
@@ -21935,7 +21935,7 @@
21935
21935
  },
21936
21936
  {
21937
21937
  "disabled": false,
21938
- "document": "主实例数据库引擎版本,支持值包括:5.5、5.65.7",
21938
+ "document": "主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0。\n说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。",
21939
21939
  "example": "\"5.7\"",
21940
21940
  "member": "string",
21941
21941
  "name": "EngineVersion",
@@ -21953,7 +21953,7 @@
21953
21953
  },
21954
21954
  {
21955
21955
  "disabled": false,
21956
- "document": "备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。\n备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。",
21956
+ "document": "备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。\n备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。",
21957
21957
  "example": "ap-guangzhou-2",
21958
21958
  "member": "string",
21959
21959
  "name": "BackupZone",
@@ -22077,8 +22077,8 @@
22077
22077
  },
22078
22078
  {
22079
22079
  "disabled": false,
22080
- "document": "异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。",
22081
- "example": "\"1sdada\"",
22080
+ "document": "异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。",
22081
+ "example": "a6040589-3b098df5-b551d9e5-81c6bfdc",
22082
22082
  "member": "string",
22083
22083
  "name": "AsyncRequestId",
22084
22084
  "output_required": true,