tccli 3.0.1343.1__py2.py3-none-any.whl → 3.0.1345.1__py2.py3-none-any.whl

tccli/services/cdb/v20170320/api.json

@@ -631,7 +631,7 @@
       "status": "online"
     },
     "DescribeParamTemplateInfo": {
-      "document": "该接口（DescribeParamTemplateInfo）用于查询参数模板详情，全地域公共参数Region均为ap-guangzhou。",
+      "document": "该接口（DescribeParamTemplateInfo）用于查询参数模板详情。\n说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。",
       "input": "DescribeParamTemplateInfoRequest",
       "name": "查询参数模板详情",
       "output": "DescribeParamTemplateInfoResponse",
@@ -743,7 +743,7 @@
       "status": "online"
     },
     "DescribeTagsOfInstanceIds": {
-      "document": "本接口(DescribeTagsOfInstanceIds)用于获取云数据库实例的标签信息。",
+      "document": "本接口（DescribeTagsOfInstanceIds）用于获取云数据库实例的标签信息。",
       "input": "DescribeTagsOfInstanceIdsRequest",
       "name": "获取实例绑定的标签",
       "output": "DescribeTagsOfInstanceIdsResponse",
@@ -778,9 +778,9 @@
       "status": "online"
     },
     "InquiryPriceUpgradeInstances": {
-      "document": "本接口(InquiryPriceUpgradeInstances)用于查询云数据库实例升级的价格，支持查询按量计费或者包年包月实例的升级价格，实例类型支持主实例、灾备实例和只读实例。",
+      "document": "本接口（InquiryPriceUpgradeInstances）用于查询云数据库实例升级的价格，支持查询按量计费或者包年包月实例的升级价格，实例类型支持主实例、灾备实例和只读实例。",
       "input": "InquiryPriceUpgradeInstancesRequest",
-      "name": "查询数据库升级价格",
+      "name": "查询云数据库升级价格",
       "output": "InquiryPriceUpgradeInstancesResponse",
       "status": "online"
     },
@@ -1016,7 +1016,7 @@
       "status": "online"
     },
     "OfflineIsolatedInstances": {
-      "document": "本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态，即通过 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询到 Status 值为 5 的实例。\n\n该接口为异步操作，部分资源的回收可能存在延迟。您可以通过使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口，指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查询，若返回实例为空，则实例资源已全部释放。\n\n注意，实例下线后，相关资源和数据将无法找回，请谨慎操作。",
+      "document": "本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态，即通过 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询到 Status 值为 5 的实例。\n\n该接口为异步操作，部分资源的回收可能存在延迟。您可以通过使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口，指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查询，其中5代表已隔离，6代表下线中，7代表已下线。若返回实例为空，则实例资源已全部释放。\n\n注意，实例下线后，相关资源和数据将无法找回，请谨慎操作。",
       "input": "OfflineIsolatedInstancesRequest",
       "name": "下线隔离状态的云数据库实例",
       "output": "OfflineIsolatedInstancesResponse",
@@ -1198,7 +1198,7 @@
       "status": "online"
     },
     "UpgradeDBInstanceEngineVersion": {
-      "document": "本接口(UpgradeDBInstanceEngineVersion)用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例等。",
+      "document": "本接口（UpgradeDBInstanceEngineVersion）用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例等。升级前请通过 [SubmitInstanceUpgradeCheckJob](https://cloud.tencent.com/document/product/236/110468) 提交升级检查任务，通过后才能升级。",
       "input": "UpgradeDBInstanceEngineVersionRequest",
       "name": "升级实例版本",
       "output": "UpgradeDBInstanceEngineVersionResponse",
@@ -4045,7 +4045,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例Id。",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-2wpip111",
           "member": "string",
           "name": "InstanceId",
@@ -4054,7 +4054,7 @@
         },
         {
           "disabled": false,
-          "document": "实例CPU核数",
+          "document": "实例 CPU 核数。当 InstanceId 为主实例时必传。",
           "example": "1",
           "member": "int64",
           "name": "Cpu",
@@ -4063,7 +4063,7 @@
         },
         {
           "disabled": false,
-          "document": "实例内存大小，单位：MB",
+          "document": "实例内存大小，单位：MB。当 InstanceId 为主实例时必传。",
           "example": "1000",
           "member": "int64",
           "name": "Memory",
@@ -4072,7 +4072,7 @@
         },
         {
           "disabled": false,
-          "document": "实例硬盘大小，单位：GB",
+          "document": "实例硬盘大小，单位：GB。",
           "example": "50",
           "member": "int64",
           "name": "Volume",
@@ -4081,7 +4081,7 @@
         },
         {
           "disabled": false,
-          "document": "磁盘类型。 CLOUD_SSD: SSD云硬盘; CLOUD_HSSD: 增强型SSD云硬盘",
+          "document": "磁盘类型。 CLOUD_SSD: SSD 云硬盘; CLOUD_HSSD: 增强型 SSD 云硬盘。",
           "example": "CLOUD_SSD",
           "member": "string",
           "name": "DiskType",
@@ -4090,7 +4090,7 @@
         },
         {
           "disabled": false,
-          "document": "云盘版节点拓扑配置。",
+          "document": "云盘版节点拓扑配置。当 InstanceId 为主实例时必传。",
           "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
           "member": "ClusterTopology",
           "name": "ClusterTopology",
@@ -4108,7 +4108,7 @@
         },
         {
           "disabled": false,
-          "document": "只读实例信息",
+          "document": "只读实例信息。",
           "example": "{\"InstanceRole\": \"ro\",\"MasterInstanceId\": \"cdb-fn3f9xpx\",\"Period\": \"1\",\"Volume\": 100,\"Memory\": 4000}",
           "member": "MigrateClusterRoInfo",
           "name": "RoInfo",
@@ -4597,7 +4597,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "RW 节点拓扑。",
+          "document": "RW 节点拓扑。\n说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。",
           "example": "[{\"Zone\": \"ap-guangzhou-4\",\"NodeId\": \"dbn-73ktfl1j\"}]",
           "member": "ReadWriteNode",
           "name": "ReadWriteNode",
@@ -4606,7 +4606,7 @@
         },
         {
           "disabled": false,
-          "document": "RO 节点拓扑。",
+          "document": "RO 节点拓扑。\n说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。",
           "example": "[{\"IsRandomZone\": \"\",\"Zone\": \"ap-guangzhou-2\",\"NodeId\": \"dbn-73ktf111\"}]",
           "member": "ReadonlyNode",
           "name": "ReadOnlyNodes",
@@ -4850,7 +4850,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例 ID，与云数据库控制台页面中显示的实例 ID 相同。",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-cdtkp3hr",
           "member": "string",
           "name": "InstanceId",
@@ -4859,7 +4859,7 @@
         },
         {
           "disabled": false,
-          "document": "开始时间。",
+          "document": "开始时间(建议开始到结束时间区间最大7天)。",
           "example": "2023-06-07 15:59:45",
           "member": "string",
           "name": "StartTime",
@@ -4868,7 +4868,7 @@
         },
         {
           "disabled": false,
-          "document": "结束时间。",
+          "document": "结束时间(建议开始到结束时间区间最大7天）。",
           "example": "2023-06-16 14:27:00",
           "member": "string",
           "name": "EndTime",
@@ -4877,7 +4877,7 @@
         },
         {
           "disabled": false,
-          "document": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序。",
+          "document": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序，默认降序排序。",
           "example": "DESC",
           "member": "string",
           "name": "Order",
@@ -4886,7 +4886,7 @@
         },
         {
           "disabled": false,
-          "document": "排序字段。支持值包括：\n\"timestamp\" - 时间戳；\n\"affectRows\" - 影响行数；\n\"execTime\" - 执行时间。",
+          "document": "排序字段。支持值包括(默认按照时间戳排序)： \"timestamp\" - 时间戳； \"affectRows\" - 影响行数； \"execTime\" - 执行时间。",
           "example": "timestamp",
           "member": "string",
           "name": "OrderBy",
@@ -4905,7 +4905,7 @@
         {
           "disabled": false,
           "document": "过滤条件。可按设置的过滤条件过滤日志。",
-          "example": "{\"SqlTypes\": [\"SELECT\"]}",
+          "example": "[{\"Type\": \"host\", \"Compare\": \"EXC\",\"Value\": \"10.0.\"}]",
           "member": "InstanceAuditLogFilters",
           "name": "LogFilter",
           "required": false,
@@ -4914,7 +4914,7 @@
         {
           "disabled": false,
           "document": "下载筛选列",
-          "example": "{\"ColumnFilter\": [\"AffectRows\", \"TableName\",\"DBName\", \"Sql\"]}",
+          "example": "{\"ColumnFilter\": [\"AffectRows\", \"ErrCode\", \"SqlType\", \"TableName\", \"DBName\", \"Sql\", \"Host\", \"User\", \"ExecTime\", \"CheckRows\", \"SentRows\", \"ThreadId\", \"NsTime\", \"IoWaitTime\", \"TrxLivingTime\", \"Timestamp\", \"Result\",\"RiskLevel\",\"TrxId\"]}",
           "member": "string",
           "name": "ColumnFilter",
           "required": false,
@@ -7301,7 +7301,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "审计规则模板ID。",
+          "document": "审计规则模板ID,可通过[DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811)接口获取，单次允许最多删除5个规则模板。",
           "example": "cdb-art-l1mlbo59",
           "member": "string",
           "name": "RuleTemplateIds",
@@ -7975,7 +7975,7 @@
         {
           "disabled": false,
           "document": "审计实例详细信息列表。\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "[{\"BillingAmount\": 0,\"LowRealStorage\": 0,\"InstanceId\": \"cdb-euu5fkcj\",\"AuditTask\": 1,\"CreateAt\": \"2022-03-02 10:09:08\",\"AuditStatus\": \"1\",\"LogExpireDay\": 1,\"AuditAll\": true,\"InstanceInfo\": {\"ProjectId\": 0,\"TagList\": [{\"TagKey\": \"andy\",\"TagValue\": \"1\"}]},\"HighRealStorage\": 0,\"HighLogExpireDay\": 30,\"LowLogExpireDay\": 7}]",
+          "example": "[{\"BillingAmount\": 0,\"LowRealStorage\": 0,\"InstanceId\": \"cdb-euu5fkcj\",\"AuditTask\": 1,\"CreateAt\": \"2022-03-02 10:09:08\",\"AuditStatus\": \"1\"...}]",
           "member": "InstanceDbAuditStatus",
           "name": "Items",
           "output_required": true,
@@ -8070,7 +8070,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例 ID。",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-of5qmu1b",
           "member": "string",
           "name": "InstanceId",
@@ -8079,7 +8079,7 @@
         },
         {
           "disabled": false,
-          "document": "开始时间。",
+          "document": "开始时间(建议开始到结束时间区间最大7天)。",
           "example": "2023-06-18 00:00:00",
           "member": "string",
           "name": "StartTime",
@@ -8088,7 +8088,7 @@
         },
         {
           "disabled": false,
-          "document": "结束时间。",
+          "document": "结束时间(建议开始到结束时间区间最大7天）。",
           "example": "2023-06-19 00:00:00",
           "member": "string",
           "name": "EndTime",
@@ -8115,7 +8115,7 @@
         },
         {
           "disabled": false,
-          "document": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序。",
+          "document": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序，默认降序排序。",
           "example": "DESC",
           "member": "string",
           "name": "Order",
@@ -8124,7 +8124,7 @@
         },
         {
           "disabled": false,
-          "document": "排序字段。支持值包括：\n\"timestamp\" - 时间戳；\n\"affectRows\" - 影响行数；\n\"execTime\" - 执行时间。",
+          "document": "排序字段。支持值包括(默认按照时间戳排序)：\n\"timestamp\" - 时间戳；\n\"affectRows\" - 影响行数；\n\"execTime\" - 执行时间。",
           "example": "timestamp",
           "member": "string",
           "name": "OrderBy",
@@ -8281,7 +8281,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "模板ID",
+          "document": "审计规则模板ID,可通过[DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811)接口获取。",
           "example": "[\"cdb-art-8qx2kcr7\"]",
           "member": "string",
           "name": "RuleTemplateIds",
@@ -8308,7 +8308,7 @@
         },
         {
           "disabled": false,
-          "document": "返回条数。",
+          "document": "返回条数,默认值-20，最大值-1000。",
           "example": "10",
           "member": "uint64",
           "name": "Limit",
@@ -8326,7 +8326,7 @@
         },
         {
           "disabled": false,
-          "document": "排序方式。DESC-按修改时间倒排，ASC-正序。",
+          "document": "排序方式，DESC-按修改时间倒排，ASC-正序，默认：DESC。",
           "example": "DESC",
           "member": "string",
           "name": "Order",
@@ -8352,7 +8352,7 @@
         {
           "disabled": false,
           "document": "变更详情。",
-          "example": "[\"TaskId\": 1997098,\"ModifyBeforeInfo\": {\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"wy_1\",\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"DROP\"]}],\"AlarmLevel\": 1,\"AlarmPolicy\": 0,\"Description\": \"\"},\"ModifyAfterInfo\": {\"RuleTemplateId\": \"cdb-art-8qx2kcr7\",\"RuleTemplateName\": \"wy_1\",\"RuleFilters\": [{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"DROP\",\"DELETE\"]}],\"AlarmLevel\": 2,\"AlarmPolicy\": 0,\"Description\": \"\"},\"AffectedInstances\": [\"cdb-nzg4gv35\",\"cdb-12y4cjjd\"],\"Operator\": \"700000579947\",\"UpdateTime\": \"2023-07-26 00:09:00\"}]",
+          "example": "[\"TaskId\": 12,\"ModifyBeforeInfo\": {},\"ModifyAfterInfo\": {},\"AffectedInstances\": [\"cdb-xqwe\"],\"Operator\": \"700000579947\",\"UpdateTime\": \"2023-07-26 00:09:00\"}]",
           "member": "RuleTemplateRecordInfo",
           "name": "Items",
           "output_required": false,
@@ -9671,7 +9671,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例 ID",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-dctw4edd",
           "member": "string",
           "name": "InstanceId",
@@ -9698,8 +9698,8 @@
         },
         {
           "disabled": false,
-          "document": "查询的开始时间。只能查看30天内的扩容历史",
-          "example": "2024-10-29 00:01:24",
+          "document": "查询的开始时间。只能查看30天内的扩容历史，格式为 Integer 的时间戳（秒级）。",
+          "example": "1750994217",
           "member": "int64",
           "name": "StartTime",
           "required": false,
@@ -9707,8 +9707,8 @@
         },
         {
           "disabled": false,
-          "document": "查询的结束时间。只能查看30天内的扩容历史",
-          "example": "2024-10-30 00:01:24",
+          "document": "查询的结束时间。只能查看30天内的扩容历史，格式为 Integer 的时间戳（秒级）。",
+          "example": "1750994218",
           "member": "int64",
           "name": "EndTime",
           "required": false,
@@ -10467,7 +10467,7 @@
         },
         {
           "disabled": false,
-          "document": "返回结果集排序方式，目前支持：\"ASC\" 或者 \"DESC\"。",
+          "document": "返回结果集排序方式。目前支持值：\"ASC\" - 表示升序，\"DESC\" - 表示降序，默认为 \"DESC\"。",
           "example": "\"DESC\"",
           "member": "string",
           "name": "OrderDirection",
@@ -10476,7 +10476,7 @@
         },
         {
           "disabled": false,
-          "document": "是否以安全组 ID 为过滤条件。",
+          "document": "是否以安全组 ID 为过滤条件。\n说明：0表示否，1表示是。",
           "example": "0",
           "member": "int64",
           "name": "WithSecurityGroup",
@@ -10549,7 +10549,7 @@
         {
           "disabled": false,
           "document": "置放群组ID列表。",
-          "example": "[\"\"]",
+          "example": "[\"ps-7t11vrwf\"]",
           "member": "string",
           "name": "DeployGroupIds",
           "required": false,
@@ -10558,7 +10558,7 @@
         {
           "disabled": false,
           "document": "是否以标签键为过滤条件。",
-          "example": "[\"\"]",
+          "example": "[\"tagKey\"]",
           "member": "string",
           "name": "TagKeysForSearch",
           "required": false,
@@ -10629,7 +10629,7 @@
         },
         {
           "disabled": false,
-          "document": "数据库引擎类型。",
+          "document": "数据库引擎类型。可选值为：InnoDB、RocksDB。",
           "example": "[\"InnoDB\"]",
           "member": "string",
           "name": "EngineTypes",
@@ -10638,7 +10638,7 @@
         },
         {
           "disabled": false,
-          "document": "是否获取集群版实例节点信息，可填：true或false",
+          "document": "是否获取集群版实例节点信息，可填：true 或 false。默认为 false。",
           "example": "false",
           "member": "bool",
           "name": "QueryClusterInfo",
@@ -10664,7 +10664,7 @@
         {
           "disabled": false,
           "document": "实例详细信息列表。",
-          "example": "[{}]",
+          "example": "无",
           "member": "InstanceInfo",
           "name": "Items",
           "output_required": true,
@@ -11524,7 +11524,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例 ID。",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-0mu6taqx",
           "member": "string",
           "name": "InstanceId",
@@ -11578,7 +11578,7 @@
         },
         {
           "disabled": false,
-          "document": "事件展示数量。",
+          "document": "事件展示数量。默认为100，最大为200。",
           "example": "10",
           "member": "string",
           "name": "Limit",
@@ -11811,7 +11811,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例 ID。",
+          "document": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
           "example": "cdb-2wpip1dd",
           "member": "string",
           "name": "InstanceId",
@@ -11820,7 +11820,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例 CPU 的核数。",
+          "document": "目标实例 CPU 的核数。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的 CPU 值范围。",
           "example": "2",
           "member": "float",
           "name": "DstCpu",
@@ -11829,7 +11829,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例内存大小，单位：MB。",
+          "document": "目标实例内存大小，单位：MB。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的内存大小范围。",
           "example": "4000",
           "member": "uint64",
           "name": "DstMemory",
@@ -11838,7 +11838,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例磁盘大小，单位：GB。",
+          "document": "目标实例磁盘大小，单位：GB。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的磁盘大小范围。",
           "example": "1000",
           "member": "uint64",
           "name": "DstDisk",
@@ -11847,7 +11847,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例数据库版本。",
+          "document": "目标实例数据库版本。可选值：5.6，5.7，8.0。",
           "example": "5.7",
           "member": "string",
           "name": "DstVersion",
@@ -11856,7 +11856,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例部署模型。",
+          "document": "目标实例部署模型。默认为0，支持值包括：0 - 表示单可用区，1 - 表示多可用区。",
           "example": "0",
           "member": "int64",
           "name": "DstDeployMode",
@@ -11865,7 +11865,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例复制类型。",
+          "document": "目标实例复制类型，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。",
           "example": "0",
           "member": "int64",
           "name": "DstProtectMode",
@@ -11874,7 +11874,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例备机1可用区。",
+          "document": "目标实例备机1可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。",
           "example": "100001",
           "member": "int64",
           "name": "DstSlaveZone",
@@ -11883,7 +11883,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例备机2可用区。",
+          "document": "目标实例备机2可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。",
           "example": "100001",
           "member": "int64",
           "name": "DstBackupZone",
@@ -11892,7 +11892,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例类型。",
+          "document": "目标实例类型。支持值包括：\"CUSTOM\" - 通用型实例，\"EXCLUSIVE\" - 独享型实例，\"ONTKE\" - ONTKE 单节点实例，\"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型，\"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型。",
           "example": "CUSTOM",
           "member": "string",
           "name": "DstCdbType",
@@ -11901,7 +11901,7 @@
         },
         {
           "disabled": false,
-          "document": "目标实例主可用区。",
+          "document": "目标实例主可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。",
           "example": "100001",
           "member": "int64",
           "name": "DstZoneId",
@@ -11919,7 +11919,7 @@
         },
         {
           "disabled": false,
-          "document": "集群版的节点拓扑配置",
+          "document": "集群版的节点拓扑配置。Nodeld信息可通过 [DescribeClusterInfo](https://cloud.tencent.com/document/api/236/105116) 接口获取。",
           "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}",
           "member": "ClusterTopology",
           "name": "ClusterTopology",
@@ -11944,7 +11944,7 @@
         },
         {
           "disabled": false,
-          "document": "实例升级类型。",
+          "document": "实例升级类型。Trsf - 迁移升级，InPlace - 原地升级，Topology - 架构升级。",
           "example": "Trsf",
           "member": "string",
           "name": "UpgradeType",
@@ -13234,7 +13234,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例列表。",
+          "document": "实例列表。实例 ID 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。可传入的数组长度暂无限制。",
           "example": "[\"cdb-uns231ns\"]",
           "member": "string",
           "name": "InstanceIds",
@@ -13252,7 +13252,7 @@
         },
         {
           "disabled": false,
-          "document": "分页大小。",
+          "document": "分页大小。默认为15。",
           "example": "10",
           "member": "int64",
           "name": "Limit",
@@ -13781,7 +13781,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "安全组 ID。",
+          "document": "安全组 ID。可通过 [DescribeDBSecurityGroups](https://cloud.tencent.com/document/api/236/15854) 接口获取。",
           "example": "sg-ajr1jzgj",
           "member": "string",
           "name": "SecurityGroupId",
@@ -13790,8 +13790,8 @@
         },
         {
           "disabled": false,
-          "document": "实例 ID 列表，一个或者多个实例 ID 组成的数组。",
-          "example": "[\"cdb-eb2w7dto\\r\\n\"]",
+          "document": "实例 ID 列表，一个或者多个实例 ID 组成的数组。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。",
+          "example": "[\"cdb-eb2w7dto\"]",
           "member": "string",
           "name": "InstanceIds",
           "required": true,
@@ -13799,7 +13799,7 @@
         },
         {
           "disabled": false,
-          "document": "当传入只读实例ID时，默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True",
+          "document": "当传入只读实例 ID 时，默认操作的是对应只读组的安全组。如果需要操作只读实例 ID 的安全组，需要将该入参置为 True，默认为 False。",
           "example": "False",
           "member": "bool",
           "name": "ForReadonlyInstance",
@@ -14014,7 +14014,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "状态值",
+          "document": "状态值。0 - 初始化中，1 - 运行中，2 - 运行成功，3 - 运行失败。",
           "example": "3",
           "member": "int64",
           "name": "Status",
@@ -14024,7 +14024,7 @@
         },
         {
           "disabled": false,
-          "document": "状态值",
+          "document": "状态值，为负数时任务异常。",
           "example": "1",
           "member": "int64",
           "name": "Code",
@@ -14034,7 +14034,7 @@
         },
         {
           "disabled": false,
-          "document": "执行时间",
+          "document": "执行时间，单位：秒。",
           "example": "0",
           "member": "int64",
           "name": "CostTime",
@@ -14074,7 +14074,7 @@
         },
         {
           "disabled": false,
-          "document": "执行进度",
+          "document": "执行进度，单位：百分比。",
           "example": "5",
           "member": "int64",
           "name": "Process",
@@ -14094,7 +14094,7 @@
         },
         {
           "disabled": false,
-          "document": "文件大小",
+          "document": "文件大小，单位：byte。",
           "example": "12",
           "member": "string",
           "name": "FileSize",
@@ -14309,7 +14309,7 @@
           "example": "48000",
           "member": "int64",
           "name": "Price",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -14319,7 +14319,7 @@
           "example": "460800",
           "member": "int64",
           "name": "OriginalPrice",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -14456,7 +14456,7 @@
         },
         {
           "disabled": false,
-          "document": "日志保留时长。",
+          "document": "日志保留时长。支持值包括：\n7 - 一周；\n30 - 一个月；\n90 - 三个月；\n180 - 六个月；\n365 - 一年；\n1095 - 三年；\n1825 - 五年。",
           "example": "30",
           "member": "uint64",
           "name": "LogExpireDay",
@@ -14466,7 +14466,7 @@
         },
         {
           "disabled": false,
-          "document": "高频存储时长。",
+          "document": "高频存储时长。支持值包括：\n3 - 3天；\n7 - 一周；\n30 - 一个月；\n90 - 三个月；\n180 - 六个月；\n365 - 一年；\n1095 - 三年；\n1825 - 五年。",
           "example": "7",
           "member": "uint64",
           "name": "HighLogExpireDay",
@@ -14476,7 +14476,7 @@
         },
         {
           "disabled": false,
-          "document": "低频存储时长。",
+          "document": "低频存储时长。单位：天，等于日志保存时长减去高频存储时长。",
           "example": "23",
           "member": "uint64",
           "name": "LowLogExpireDay",
@@ -14486,7 +14486,7 @@
         },
         {
           "disabled": false,
-          "document": "日志存储量。",
+          "document": "日志存储量(单位：GB)。",
           "example": "173749.248",
           "member": "float",
           "name": "BillingAmount",
@@ -14496,7 +14496,7 @@
         },
         {
           "disabled": false,
-          "document": "高频存储量。",
+          "document": "高频存储量(单位：GB)。",
           "example": "45639.68",
           "member": "float",
           "name": "HighRealStorage",
@@ -14506,7 +14506,7 @@
         },
         {
           "disabled": false,
-          "document": "低频存储量。",
+          "document": "低频存储量(单位：GB)。",
           "example": "128109.568",
           "member": "float",
           "name": "LowRealStorage",
@@ -14546,7 +14546,7 @@
         },
         {
           "disabled": false,
-          "document": "总存储量。",
+          "document": "总存储量(单位：GB)。",
           "example": "173749.248",
           "member": "float",
           "name": "RealStorage",
@@ -15088,7 +15088,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "实例ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同",
+          "document": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。",
           "example": "cdb-c1nl9rpv",
           "member": "string",
           "name": "InstanceId",
@@ -15098,7 +15098,7 @@
         },
         {
           "disabled": false,
-          "document": "预期重启时间",
+          "document": "预期重启时间，单位：秒。",
           "example": "360",
           "member": "int64",
           "name": "TimeInSeconds",
@@ -15623,7 +15623,7 @@
         },
         {
           "disabled": false,
-          "document": "云数据库账号。",
+          "document": "云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。",
           "example": "andy",
           "member": "Account",
           "name": "Accounts",
@@ -15632,7 +15632,7 @@
         },
         {
           "disabled": false,
-          "document": "数据库账号的备注信息。",
+          "document": "数据库账号的备注信息。最多支持输入255个字符。",
           "example": "new",
           "member": "string",
           "name": "Description",
@@ -16816,7 +16816,7 @@
         },
         {
           "disabled": false,
-          "document": "修改后的实例名称。",
+          "document": "修改后的实例名称，仅支持数字,英文大小写字母、中文以及特殊字符-_./()[]（）+=:：@ 且长度不能超过60。",
           "example": "我是中文",
           "member": "string",
           "name": "InstanceName",
@@ -16924,8 +16924,8 @@
         },
         {
           "disabled": false,
-          "document": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。\n注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。",
-          "example": "[\"sg-ajr1jzgj\\r\\n\"]",
+          "document": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。可通过 [DescribeDBSecurityGroups](hhttps://cloud.tencent.com/document/api/236/15854) 接口获取。输入的安全组 ID 数组无长度限制。\n注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。",
+          "example": "[\"sg-ajr1jzgj\"]",
           "member": "string",
           "name": "SecurityGroupIds",
           "required": true,
@@ -16933,7 +16933,7 @@
         },
         {
           "disabled": false,
-          "document": "当传入只读实例ID时，默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True",
+          "document": "当传入只读实例 ID 时，默认操作的是对应只读组的安全组。如果需要操作只读实例 ID 的安全组， 需要将该入参置为 True。默认为 False。",
           "example": "False",
           "member": "bool",
           "name": "ForReadonlyInstance",
@@ -16942,7 +16942,7 @@
         },
         {
           "disabled": false,
-          "document": "变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。",
+          "document": "变更集群版实例只读组时，InstanceId 传实例 ID，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。",
           "example": "cdb-xxx|readonly",
           "member": "string",
           "name": "OpResourceId",
@@ -17640,7 +17640,7 @@
         {
           "disabled": false,
           "document": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。",
-          "example": "[\"cdb-70zdmgg1\\r\\n\"]",
+          "example": "[\"cdb-70zdmgg1\"]",
           "member": "string",
           "name": "InstanceIds",
           "required": true,
@@ -18587,7 +18587,7 @@
         },
         {
           "disabled": false,
-          "document": "代理状态",
+          "document": "代理状态。0 - 初始化中，1 - 在线中，2 - 在线中-读写分离中，3 - 下线，4 - 销毁。",
           "example": "online",
           "member": "string",
           "name": "Status",
@@ -18597,7 +18597,7 @@
         },
         {
           "disabled": false,
-          "document": "代理任务状态",
+          "document": "代理任务状态，Upgrading - 升级中，UpgradeTo - 升级待切换，UpgradeSwitching - 升级切换中，ProxyCreateAddress - 配置地址中，ProxyModifyAddress - 修改地址中，ProxyCloseAddress - 关闭地址中。",
           "example": "upgrade",
           "member": "string",
           "name": "TaskStatus",
@@ -18788,7 +18788,7 @@
         },
         {
           "disabled": false,
-          "document": "内存大小",
+          "document": "内存大小，单位为 MB。",
           "example": "100",
           "member": "uint64",
           "name": "Mem",
@@ -18798,7 +18798,7 @@
         },
         {
           "disabled": false,
-          "document": "节点状态",
+          "document": "节点状态，0 - 初始化中，1 - 在线中，2 - 下线中，3 - 销毁中，4 - 故障恢复中，5 - 节点故障，6 - 切换中。",
           "example": "online",
           "member": "string",
           "name": "Status",
@@ -18973,7 +18973,7 @@
         {
           "disabled": false,
           "document": "解隔离操作的结果集。",
-          "example": "[{\"InstanceId\": \"cdb-f35wr6wj\",\"Code\": 0,\"Message\": \"ok\"}]",
+          "example": "[{\"InstanceId\": \"cdb-f35wr6wj\",\"Code\": 0,\"Message\": \"\"}]",
           "member": "ReleaseResult",
           "name": "Items",
           "output_required": true,
@@ -19030,7 +19030,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "代理组ID",
+          "document": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。",
           "example": "proxy-ixw3ll2d",
           "member": "string",
           "name": "ProxyGroupId",
@@ -19039,7 +19039,7 @@
         },
         {
           "disabled": false,
-          "document": "代理组地址ID",
+          "document": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。如果不传则会对所有代理组地址进行负载均衡。",
           "example": " proxyaddr-kti9dddd",
           "member": "string",
           "name": "ProxyAddressId",
@@ -21545,7 +21545,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "错误码。",
+          "document": "错误码。0代表成功，其他对应不同的报错场景。",
           "example": "0",
           "member": "int64",
           "name": "Code",
@@ -21799,7 +21799,7 @@
         },
         {
           "disabled": false,
-          "document": "主实例数据库引擎版本，支持值包括：5.6 和 5.7。",
+          "document": "主实例数据库引擎版本，支持值包括：5.6、5.7、8.0。\n说明：不支持越级升级，升级后不支持降级。",
           "example": "5.7",
           "member": "string",
           "name": "EngineVersion",
@@ -21817,7 +21817,7 @@
         },
         {
           "disabled": false,
-          "document": "是否是内核子版本升级，支持的值：1 - 升级内核子版本；0 - 升级数据库引擎版本。",
+          "document": "是否是内核子版本升级，支持的值：1 - 升级内核子版本；0 - 升级数据库引擎版本。无默认值，请指定要升级的版本类型。",
           "example": "20201231",
           "member": "int64",
           "name": "UpgradeSubversion",
@@ -21826,7 +21826,7 @@
         },
         {
           "disabled": false,
-          "document": "延迟阈值。取值范围1~10",
+          "document": "延迟阈值。取值范围：1 - 10。无默认值，不传此参数时，延迟阈值为0，表示延迟阈值不做设置。",
           "example": "1",
           "member": "int64",
           "name": "MaxDelayTime",
@@ -21835,7 +21835,7 @@
         },
         {
           "disabled": false,
-          "document": "5.7升级8.0是否忽略关键字错误，取值范围[0,1]，1表示忽略，0表示不忽略",
+          "document": "5.7升级8.0是否忽略关键字错误，取值范围[0,1]，1表示忽略，0表示不忽略。无默认值，不传此参数表示不做处理。",
           "example": "1",
           "member": "int64",
           "name": "IgnoreErrKeyword",
@@ -21845,7 +21845,7 @@
         {
           "disabled": false,
           "document": "版本升级支持指定参数",
-          "example": "无",
+          "example": "[{\"Name\": \"default_collation_for_utf8mb4\", \"Value\": \"EXC\",\"Value\": \"utf8mb4_0900_ai_ci\"}]",
           "member": "UpgradeEngineVersionParams",
           "name": "ParamList",
           "required": false,