{ "name": "cdb", "display_name": "云数据库 MySQL", "description": "介绍如何使用 API 对云数据库 MySQL 进行操作，包括查询数据库表、查询云数据库实例任务列表、续费云数据库实例等。", "domain": "database", "api_version": "2017-03-20", "endpoint": "cdb.tencentcloudapi.com", "actions": [ { "name": "AddTimeWindow", "description": "本接口（AddTimeWindow）用于添加云数据库实例的维护时间窗口，以指定实例在哪些时间段可以自动执行切换访问操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-eb2w7dto" }, { "name": "Monday", "type": "array", "required": false, "description": "星期一的可维护时间段，其中每一个时间段的格式形如：10:00-12:00；起始时间按半个小时对齐；最短半个小时，最长三个小时；可设置多个时间段。 一周中应至少设置一天的时间窗。下同。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Tuesday", "type": "array", "required": false, "description": "星期二的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Wednesday", "type": "array", "required": false, "description": "星期三的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Thursday", "type": "array", "required": false, "description": "星期四的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Friday", "type": "array", "required": false, "description": "星期五的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Saturday", "type": "array", "required": false, "description": "星期六的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "Sunday", "type": "array", "required": false, "description": "星期日的可维护时间窗口。 一周中应至少设置一天的时间窗。", "example": "02:00-03:00", "item_type": "string" }, { "name": "MaxDelayTime", "type": "integer", "required": false, "description": "最大延迟阈值（秒），仅对主实例和灾备实例有效。默认值：10，取值范围：1-10的整数。", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "AdjustCdbProxy", "description": "本接口（AdjustCdbProxy）用于调整数据库代理配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-aykuksx3" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-il2nlsdn" }, { "name": "ProxyNodeCustom", "type": "array", "required": true, "description": "节点规格配置 备注：数据库代理支持的节点规格为：2C4000MB、4C8000MB、8C16000MB。 示例中参数说明： NodeCount：节点个数 Region：节点地域 Zone：节点可用区 Cpu：单个代理节点核数（单位：核） Mem：单个代理节点内存数（单位：MB）", "example": "{ \"NodeCount\": 2, \"Region\": \"ap-guangzhou\", \"Zone\": \"ap-guangzhou-1\", \"Cpu\": 2, \"Mem\": 4000 }", "item_type": "object", "children": [ { "name": "NodeCount", "type": "integer", "required": true, "description": "节点个数", "example": "2" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "8" }, { "name": "Mem", "type": "integer", "required": true, "description": "内存大小", "example": "1000" }, { "name": "Region", "type": "string", "required": true, "description": "地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-1" } ] }, { "name": "ReloadBalance", "type": "string", "required": true, "description": "重新负载均衡：auto(自动),manual(手动)", "example": "auto" }, { "name": "UpgradeTime", "type": "string", "required": true, "description": "升级切换时间：nowTime(升级完成时),timeWindow(维护时间内)", "example": "nowTime" } ], "required": [ "InstanceId", "ProxyGroupId", "ProxyNodeCustom", "ReloadBalance", "UpgradeTime" ] }, { "name": "AdjustCdbProxyAddress", "description": "本接口（AdjustCdbProxyAddress）用于调整数据库代理地址配置。", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-il2nlsdn" }, { "name": "WeightMode", "type": "string", "required": true, "description": "权重分配模式， 系统自动分配：\"system\"， 自定义：\"custom\"", "example": "system" }, { "name": "IsKickOut", "type": "boolean", "required": true, "description": "是否开启延迟剔除，取值：\"true\" | \"false\"", "example": "true" }, { "name": "MinCount", "type": "integer", "required": true, "description": "最小保留数量，最小取值：0。 说明：当 IsKickOut 为 true 时才有效。", "example": "2" }, { "name": "MaxDelay", "type": "integer", "required": true, "description": "延迟剔除阈值，最小取值：1，取值范围：[1,10000]，整数。", "example": "100" }, { "name": "FailOver", "type": "boolean", "required": true, "description": "是否开启故障转移，取值：\"true\" | \"false\"", "example": "true" }, { "name": "AutoAddRo", "type": "boolean", "required": true, "description": "是否自动添加RO，取值：\"true\" | \"false\"", "example": "true" }, { "name": "ReadOnly", "type": "boolean", "required": true, "description": "是否是只读，取值：\"true\" | \"false\"", "example": "true" }, { "name": "ProxyAddressId", "type": "string", "required": true, "description": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxyadd-il2nlsdn" }, { "name": "TransSplit", "type": "boolean", "required": false, "description": "是否开启事务分离，取值：\"true\" | \"false\"，默认值 false。", "example": "true" }, { "name": "ConnectionPool", "type": "boolean", "required": false, "description": "是否开启连接池。默认关闭。 注意：如需使用数据库代理连接池能力，MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。", "example": "true" }, { "name": "ProxyAllocation", "type": "array", "required": false, "description": "读写权重分配。如果 WeightMode 传的是 system ，则传入的权重不生效，由系统分配默认权重。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "代理节点所属地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": true, "description": "代理节点所属可用区", "example": "ap-guangzhou-1" }, { "name": "ProxyInstance", "type": "array", "required": true, "description": "代理实例分布", "example": "[{\"InstanceId\": \"cdb-aykuksx3\",\"InstanceName\": \"cdb37262\",\"InstanceType\": \"1\",\"Status\": \"1\",\"Weight\": \"100\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"InstNodeId\": \"cbn-ehjshe\",\"InstNodeRole\": \"master\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cdb-aykuksx3" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "cdb3874" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "实例类型：1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例", "example": "1" }, { "name": "Status", "type": "integer", "required": false, "description": "实例状态，可能的返回值：0-创建中；1-运行中；4-隔离中；5-已隔离", "example": "1" }, { "name": "Weight", "type": "integer", "required": false, "description": "只读权重,如果权重为系统自动分配，改值不生效，只代表是否启用该实例", "example": "100" }, { "name": "Region", "type": "string", "required": false, "description": "实例所属地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": false, "description": "实例所属可用区", "example": "ap-guangzhou-1" }, { "name": "InstNodeId", "type": "string", "required": false, "description": "实例节点ID", "example": "cbn-test" }, { "name": "InstNodeRole", "type": "string", "required": false, "description": "节点角色", "example": "master" } ] } ] }, { "name": "AutoLoadBalance", "type": "boolean", "required": false, "description": "是否开启自适应负载均衡。默认关闭。", "example": "false" }, { "name": "AccessMode", "type": "string", "required": false, "description": "访问模式：nearby - 就近访问，balance - 均衡分配，默认就近访问。", "example": "balance" }, { "name": "ApNodeAsRoNode", "type": "string", "required": false, "description": "是否将libra节点当作普通RO节点", "example": "true" }, { "name": "ApQueryToOtherNode", "type": "string", "required": false, "description": "libra节点故障，是否转发给其他节点", "example": "true" } ], "required": [ "ProxyGroupId", "WeightMode", "IsKickOut", "MinCount", "MaxDelay", "FailOver", "AutoAddRo", "ReadOnly", "ProxyAddressId" ] }, { "name": "AnalyzeAuditLogs", "description": "本接口（AnalyzeAuditLogs）用于在不同过滤条件下的审计日志结果集中，选定特定的数据列进行聚合统计。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-r9bpb9gs" }, { "name": "StartTime", "type": "string", "required": true, "description": "要分析的日志开始时间，格式为：\"2023-02-16 00:00:20\"。", "example": "2023-02-16 00:00:20" }, { "name": "EndTime", "type": "string", "required": true, "description": "要分析的日志结束时间，格式为：\"2023-02-16 00:10:20\"。", "example": "2023-02-16 00:10:20" }, { "name": "AggregationConditions", "type": "array", "required": true, "description": "聚合维度的排序条件。", "example": "[{\"AggregationField\": \"host\",\"Offset\": 0,\"Limit\": 3}]", "item_type": "object", "children": [ { "name": "AggregationField", "type": "string", "required": true, "description": "聚合字段。目前仅支持host-源IP、user-用户名、dbName-数据库名、sqlType-sql类型。", "example": "host" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "该聚合字段下要返回聚合桶的数量，最大100。", "example": "100" } ] }, { "name": "LogFilter", "type": "array", "required": false, "description": "该过滤条件下的审计日志结果集作为分析日志。", "example": "[{\"Type\": \"sqlType\",\"Compare\": \"EQS\",\"Value\": [\"delete\"]}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "过滤项。目前支持以下搜索条件： 包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称； 等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID； 范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - ...", "example": "host" }, { "name": "Compare", "type": "string", "required": false, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "EXC" }, { "name": "Value", "type": "array", "required": false, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系", "example": "10.0.", "item_type": "string" } ] } ], "required": [ "InstanceId", "StartTime", "EndTime", "AggregationConditions" ] }, { "name": "AssociateSecurityGroups", "description": "本接口(AssociateSecurityGroups)用于安全组批量绑定实例。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组 ID。可通过 [DescribeDBSecurityGroups](https://cloud.tencent.com/document/api/236/15854) 接口获取。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，一个或者多个实例 ID 组成的数组。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "[\"cdb-eb2w7dto\"]", "item_type": "string" }, { "name": "ForReadonlyInstance", "type": "boolean", "required": false, "description": "当传入只读实例ID时，默认操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True", "example": "False" } ], "required": [ "SecurityGroupId", "InstanceIds" ] }, { "name": "BalanceRoGroupLoad", "description": "本接口(BalanceRoGroupLoad)用于重新均衡 RO 组内实例的负载。注意，RO 组内 RO 实例会有一次数据库连接瞬断，请确保应用程序能重连数据库，谨慎操作。", "status": "online", "parameters": [ { "name": "RoGroupId", "type": "string", "required": true, "description": "RO 组的 ID，格式如：cdbrg-c1nl9rpv。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 获取。", "example": "cdbrg-eb2w7dto" } ], "required": [ "RoGroupId" ] }, { "name": "CheckMigrateCluster", "description": "本接口（CheckMigrateCluster）用于高可用实例一键迁移到云盘版校验。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-2wpip111" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例 CPU 核数。当 InstanceId 为主实例时必传。", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例内存大小，单位：MB。当 InstanceId 为主实例时必传。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": false, "description": "实例硬盘大小，单位：GB。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型。 CLOUD_SSD: SSD 云硬盘; CLOUD_HSSD: 增强型 SSD 云硬盘。", "example": "CLOUD_SSD" }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版节点拓扑配置。当 InstanceId 为主实例时必传。", "example": "{\"ReadWriteNode\":{\"Zone\":\"ap-beijing-6\"},\"ReadOnlyNodes\":[{\"Zone\":\"ap-beijing-6\"}]}", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] }, { "name": "DeviceType", "type": "string", "required": false, "description": "迁移实例类型。支持值包括： \"CLOUD_NATIVE_CLUSTER\" - 标准型云盘版实例， \"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 加强型云盘版实例。", "example": "CLOUD_NATIVE_CLUSTER" }, { "name": "RoInfo", "type": "array", "required": false, "description": "只读实例信息。", "example": "{\"InstanceRole\": \"ro\",\"MasterInstanceId\": \"cdb-fn3f9xpx\",\"Period\": \"1\",\"Volume\": 100,\"Memory\": 4000}", "item_type": "object", "children": [ { "name": "RoInstanceId", "type": "string", "required": false, "description": "只读实例名称", "example": "cdbro-khe2cddd" }, { "name": "Cpu", "type": "integer", "required": false, "description": "只读实例CPU核数", "example": "2" }, { "name": "Memory", "type": "integer", "required": false, "description": "只读实例内存大小，单位：MB", "example": "4000" }, { "name": "Volume", "type": "integer", "required": false, "description": "只读实例硬盘大小，单位：GB", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型。 CLOUD_SSD: SSD云硬盘; CLOUD_HSSD: 增强型SSD云硬盘", "example": "CLOUD_HSSD" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区", "example": "ap-beijing-3" }, { "name": "DeviceType", "type": "string", "required": false, "description": "迁移实例类型。支持值包括： \"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型实例， \"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型实例。", "example": "CLOUD_NATIVE_CLUSTER" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读实例所在ro组，例：cdbrg-xxx", "example": "cdbrg-yehsjf" }, { "name": "SrcAlarmPolicyList", "type": "array", "required": false, "description": "实例当前告警策略id数组", "example": "[1432]", "item_type": "integer" } ] } ], "required": [ "InstanceId" ] }, { "name": "CloseAuditService", "description": "实例关闭审计服务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-22dhn3e3" } ], "required": [ "InstanceId" ] }, { "name": "CloseCDBProxy", "description": "本接口（CloseCDBProxy）用于关闭数据库代理。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-93hvfedd" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-ixw3ll2d" }, { "name": "OnlyCloseRW", "type": "boolean", "required": false, "description": "是否只关闭读写分离，取值：\"true\" | \"false\"，默认为\"false\"", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "CloseCdbProxyAddress", "description": "本接口（CloseCdbProxyAddress）用于请求关闭数据库代理地址。", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-aykuksx3" }, { "name": "ProxyAddressId", "type": "string", "required": true, "description": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxyaddr-aykuksx3" } ], "required": [ "ProxyGroupId", "ProxyAddressId" ] }, { "name": "CloseSSL", "description": "本接口（CloseSSL）用于关闭 SSL 连接功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-je5egmdl" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。", "example": "cdbrg-k9a6gup3" } ], "required": [] }, { "name": "CloseWanService", "description": "本接口(CloseWanService)用于关闭云数据库实例的外网访问。关闭外网访问后，外网地址将不可访问。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。可传入只读组 ID 关闭只读组外网访问。", "example": "cdb-ezq1vzem" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "变更云盘版实例只读组时，InstanceId 传实例 ID，需要额外指定该参数表示操作只读组。如果操作读写节点则不需指定该参数。", "example": "cdb-xxx|readonly" } ], "required": [ "InstanceId" ] }, { "name": "CreateAccounts", "description": "本接口（CreateAccounts）用于创建云数据库的账户，需要指定新的账户名和域名，以及所对应的密码，同时可以设置账号的备注信息以及最大可用连接数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Accounts", "type": "array", "required": true, "description": "云数据库账号。", "example": "无", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] }, { "name": "Password", "type": "string", "required": true, "description": "新账户的密码。 说明： 1. 在8 ～ 64位字符数以内（推荐12位以上）。 2. 至少包含其中两项：小写字母 a ~ z 或 大写字母 A ～ Z。数字0 ～ 9。_+-,\u0026=!@#$%^*().|。 3. 不能包含非法字符。", "example": "fsdgfdgfd" }, { "name": "Description", "type": "string", "required": false, "description": "备注信息。最多支持输入255个字符。", "example": "test description" }, { "name": "MaxUserConnections", "type": "integer", "required": false, "description": "新账户最大可用连接数，默认值为10240，最大可设置值为10240。", "example": "1" } ], "required": [ "InstanceId", "Accounts", "Password" ] }, { "name": "CreateAuditLogFile", "description": "本接口（CreateAuditLogFile）用于创建云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-cdtkp3hr" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间(建议开始到结束时间区间最大7天)。", "example": "2023-06-07 15:59:45" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(建议开始到结束时间区间最大7天）。", "example": "2023-06-16 14:27:00" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序，默认降序排序。", "example": "DESC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。支持值包括(默认按照时间戳排序)： \"timestamp\" - 时间戳； \"affectRows\" - 影响行数； \"execTime\" - 执行时间。", "example": "timestamp" }, { "name": "LogFilter", "type": "array", "required": false, "description": "过滤条件。可按设置的过滤条件过滤日志。", "example": "[{\"Type\": \"host\", \"Compare\": \"EXC\",\"Value\": \"10.0.\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "过滤项。目前支持以下搜索条件： 包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称； 等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID； 范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - ...", "example": "host" }, { "name": "Compare", "type": "string", "required": false, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "EXC" }, { "name": "Value", "type": "array", "required": false, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系", "example": "10.0.", "item_type": "string" } ] }, { "name": "ColumnFilter", "type": "array", "required": false, "description": "下载筛选列", "example": "{\"ColumnFilter\": [\"AffectRows\", \"ErrCode\", \"SqlType\", \"TableName\", \"DBName\", \"Sql\", \"Host\", \"User\", \"ExecTime\", \"CheckRows\", \"SentRows\", \"ThreadId\", \"NsTime\", \"IoWaitTime\", \"TrxLivingTime\", \"Timestamp\", \"Result\",\"RiskLevel\",\"TrxId\"]}", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "CreateAuditPolicy", "description": "本接口(CreateAuditPolicy)用于创建云数据库实例的审计策略，即将审计规则绑定到具体的云数据库实例上。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "审计策略名称。", "example": "audit_policy_1" }, { "name": "RuleId", "type": "string", "required": true, "description": "审计规则 ID。", "example": "cdbrule-asdfghjk" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-qwerasdf" }, { "name": "LogExpireDay", "type": "integer", "required": false, "description": "审计日志保存时长。支持值包括： 7 - 一周 30 - 一个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年； 实例首次开通审计策略时，可传该值，用于设置存储日志保存天数，默认为 30 天。若实例已存在审计策略，则此参数无效，可使用 更改审计服务配置 接口修改日志存储时长。", "example": "7" } ], "required": [ "Name", "RuleId", "InstanceId" ] }, { "name": "CreateAuditRule", "description": "不再支持审计规则创建 本接口(CreateAuditRule)用于创建用户在当前地域的审计规则。", "status": "deprecated", "parameters": [ { "name": "RuleName", "type": "string", "required": true, "description": "审计规则名称。", "example": "audit1" }, { "name": "Description", "type": "string", "required": false, "description": "审计规则描述。", "example": "audit_test" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "审计规则过滤条件。若设置了过滤条件，则不会开启全审计。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤条件参数名称。目前支持： SrcIp – 客户端 IP； User – 数据库账户； DB – 数据库名称；", "example": "User" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件匹配类型。目前支持： INC – 包含； EXC – 不包含； EQ – 等于； NEQ – 不等于；", "example": "INC" }, { "name": "Value", "type": "string", "required": true, "description": "过滤条件匹配值。", "example": "andy" } ] }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "是否开启全审计。支持值包括：false – 不开启全审计，true – 开启全审计。用户未设置审计规则过滤条件时，默认开启全审计。", "example": "true" } ], "required": [ "RuleName" ] }, { "name": "CreateAuditRuleTemplate", "description": "本接口（CreateAuditRuleTemplate）用于创建审计规则模板。", "status": "online", "parameters": [ { "name": "RuleFilters", "type": "array", "required": true, "description": "审计规则。", "example": "[{\"Type\": \"host\",\"Compare\": \"EQS\",\"Value\": [\"100.122.76.176\",\"10.0.0.9\"]}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。", "example": "sqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "审计规则过滤条件的匹配值。sqlType条件的Value需在以下选择\"alter\", \"changeuser\", \"create\", \"delete\", \"drop\", \"execute\", \"insert\", \"login\", \"logout\", \"other\", \"replace\", \"select\", \"set\", \"update\"。", "example": "UPDATE", "item_type": "string" } ] }, { "name": "RuleTemplateName", "type": "string", "required": true, "description": "规则模板名称。最多支持输入30个字符。", "example": "andy" }, { "name": "Description", "type": "string", "required": false, "description": "规则模板描述。最多支持输入200个字符。", "example": "用于测试的规则模板" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1 - 低风险，2 - 中风险，3 - 高风险。默认值为1。", "example": "3" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0 - 不告警，1 - 告警。默认值为0。", "example": "1" } ], "required": [ "RuleFilters", "RuleTemplateName" ] }, { "name": "CreateBackup", "description": "本接口（CreateBackup）用于创建数据库备份。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "BackupMethod", "type": "string", "required": true, "description": "目标备份方法，可选的值：logical - 逻辑冷备，physical - 物理冷备，snapshot - 快照备份。基础版实例仅支持快照备份。", "example": "physical" }, { "name": "BackupDBTableList", "type": "array", "required": false, "description": "需要备份的库表信息，如果不设置该参数，则默认整实例备份。在 BackupMethod=logical 逻辑备份中才可设置该参数。指定的库表必须存在，否则可能导致备份失败。 例：如果需要备份 db1 库的 tb1、tb2 表 和 db2 库。则该参数设置为 [{\"Db\": \"db1\", \"Table\": \"tb1\"}, {\"Db\": \"db1\", \"Table\": \"tb2\"}, {\"Db\": \"db2\"}]。", "example": "[{\"Db\": \"db1\", \"Table\": \"tb1\"}, {\"Db\": \"db1\", \"Table\": \"tb2\"}, {\"Db\": \"db2\"}]", "item_type": "object", "children": [ { "name": "Db", "type": "string", "required": true, "description": "需要备份的库名", "example": "db1" }, { "name": "Table", "type": "string", "required": false, "description": "需要备份的表名。 如果传该参数，表示备份该库中的指定表。如果不传该参数则备份该db库", "example": "andy_table1" } ] }, { "name": "ManualBackupName", "type": "string", "required": false, "description": "手动备份别名，输入长度请在60个字符内。", "example": "手动备份1" }, { "name": "EncryptionFlag", "type": "string", "required": false, "description": "是否需要加密物理备份，可选值为：on - 是，off - 否。当 BackupMethod 为 physical 时，该值才有意义。不指定则使用实例备份默认加密策略，这里的默认加密策略指通过 [DescribeBackupEncryptionStatus](https://cloud.tencent.com/document/product/236/86508) 接口查询出的实例当前加密策略。", "example": "on" } ], "required": [ "InstanceId", "BackupMethod" ] }, { "name": "CreateCdbProxy", "description": "本接口（CreateCdbProxy）用于主实例创建数据库代理。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-aykuksx3" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "vpc-ixw3ll2d" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "subnet-0z3r56vq" }, { "name": "ProxyNodeCustom", "type": "array", "required": true, "description": "节点规格配置。 示例中参数说明： NodeCount：节点个数。 Region：节点地域。 Zone：节点可用区。 Cpu：单个代理节点核数（单位：核）。 Mem：单个代理节点内存数（单位：MB）。 备注： 1. 数据库代理支持的节点规格为：2C4000MB、4C8000MB、8C16000MB。 2. 上述参数项（如节点个数、可用区等）均为必填，在调用接口时如未填写完整，可能会创建失败。", "example": "{\"NodeCount\": 2,\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"Cpu\": 2,\"Mem\": 4000}", "item_type": "object", "children": [ { "name": "NodeCount", "type": "integer", "required": true, "description": "节点个数", "example": "2" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "8" }, { "name": "Mem", "type": "integer", "required": true, "description": "内存大小", "example": "1000" }, { "name": "Region", "type": "string", "required": true, "description": "地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-1" } ] }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组", "example": "[\"security\"]", "item_type": "string" }, { "name": "Desc", "type": "string", "required": false, "description": "描述", "example": "andy_proxy" }, { "name": "ConnectionPoolLimit", "type": "integer", "required": false, "description": "连接池阈值 注意：如需使用数据库代理连接池能力，MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。", "example": "10" }, { "name": "ProxyVersion", "type": "string", "required": false, "description": "指定要购买的 proxy 内核版本。不填则默认发货最新版本的 proxy。", "example": "1.4.1" } ], "required": [ "InstanceId", "UniqVpcId", "UniqSubnetId", "ProxyNodeCustom" ] }, { "name": "CreateCdbProxyAddress", "description": "本接口（CreateCdbProxyAddress）用于数据库代理增加代理地址。", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-kti9m7m1" }, { "name": "WeightMode", "type": "string", "required": true, "description": "权重分配模式， 系统自动分配：\"system\"， 自定义：\"custom\"", "example": "system" }, { "name": "IsKickOut", "type": "boolean", "required": true, "description": "是否开启延迟剔除，取值：\"true\" | \"false\"", "example": "true" }, { "name": "MinCount", "type": "integer", "required": true, "description": "最小保留数量，最小取值：0", "example": "2" }, { "name": "MaxDelay", "type": "integer", "required": true, "description": "延迟剔除阈值，最小取值：1，范围：1 - 10000，整数。", "example": "100" }, { "name": "FailOver", "type": "boolean", "required": true, "description": "是否开启故障转移，取值：\"true\" | \"false\"", "example": "true" }, { "name": "AutoAddRo", "type": "boolean", "required": true, "description": "是否自动添加RO，取值：\"true\" | \"false\"", "example": "true" }, { "name": "ReadOnly", "type": "boolean", "required": true, "description": "是否是只读，取值：\"true\" | \"false\"", "example": "true" }, { "name": "TransSplit", "type": "boolean", "required": true, "description": "是否开启事务分离，取值：\"true\" | \"false\"", "example": "true" }, { "name": "ProxyAllocation", "type": "array", "required": true, "description": "读写权重分配", "example": "[{\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-2\",\"ProxyInstance\": [{\"InstanceId\": \"cdb-aykuksx3\",\"Weight\": 100}]}]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "代理节点所属地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": true, "description": "代理节点所属可用区", "example": "ap-guangzhou-1" }, { "name": "ProxyInstance", "type": "array", "required": true, "description": "代理实例分布", "example": "[{\"InstanceId\": \"cdb-aykuksx3\",\"InstanceName\": \"cdb37262\",\"InstanceType\": \"1\",\"Status\": \"1\",\"Weight\": \"100\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\",\"InstNodeId\": \"cbn-ehjshe\",\"InstNodeRole\": \"master\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID", "example": "cdb-aykuksx3" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "cdb3874" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "实例类型：1 master 主实例; 2 ro 只读实例; 3 dr 灾备实例; 4 sdr 小灾备实例", "example": "1" }, { "name": "Status", "type": "integer", "required": false, "description": "实例状态，可能的返回值：0-创建中；1-运行中；4-隔离中；5-已隔离", "example": "1" }, { "name": "Weight", "type": "integer", "required": false, "description": "只读权重,如果权重为系统自动分配，改值不生效，只代表是否启用该实例", "example": "100" }, { "name": "Region", "type": "string", "required": false, "description": "实例所属地域", "example": "ap-guangzhou" }, { "name": "Zone", "type": "string", "required": false, "description": "实例所属可用区", "example": "ap-guangzhou-1" }, { "name": "InstNodeId", "type": "string", "required": false, "description": "实例节点ID", "example": "cbn-test" }, { "name": "InstNodeRole", "type": "string", "required": false, "description": "节点角色", "example": "master" } ] } ] }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "vpc-ixw3ll2d" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "subnet-0z3r56vq" }, { "name": "ConnectionPool", "type": "boolean", "required": false, "description": "是否开启连接池。默认关闭。 注意：如需使用数据库代理连接池能力，MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。", "example": "true" }, { "name": "Desc", "type": "string", "required": false, "description": "描述", "example": "andy_proxy" }, { "name": "Vip", "type": "string", "required": false, "description": "IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。", "example": "192.0.0.1" }, { "name": "VPort", "type": "integer", "required": false, "description": "端口。默认值3306。", "example": "80" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组", "example": "sg-4qvsxc1a", "item_type": "string" }, { "name": "ConnectionPoolType", "type": "string", "required": false, "description": "连接池类型。可选值 transaction（事务级别连接池），connection（会话级别连接池），ConnectionPool 为 true 时生效。默认值：connection。", "example": "connection" }, { "name": "AutoLoadBalance", "type": "boolean", "required": false, "description": "是否开启自适应负载均衡。默认关闭。", "example": "false" }, { "name": "AccessMode", "type": "string", "required": false, "description": "接入模式。nearBy - 就近访问，balance - 均衡分配，默认值：nearBy。", "example": "nearBy" } ], "required": [ "ProxyGroupId", "WeightMode", "IsKickOut", "MinCount", "MaxDelay", "FailOver", "AutoAddRo", "ReadOnly", "TransSplit", "ProxyAllocation", "UniqVpcId", "UniqSubnetId" ] }, { "name": "CreateCloneInstance", "description": "本接口（CreateCloneInstance）用于从目标源实例创建一个克隆实例，可以指定克隆实例回档到源实例的指定物理备份文件或者指定的回档时间点。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "克隆源实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/api/236/15872) 接口获取。", "example": "cdb-9303wd4x" }, { "name": "SpecifiedRollbackTime", "type": "string", "required": false, "description": "如果需要克隆实例回档到指定时间，则指定该值。时间格式为：yyyy-mm-dd hh:mm:ss。 说明：此参数和 SpecifiedBackupId 参数需要2选1进行设置。", "example": "2020-01-28 20:47:26" }, { "name": "SpecifiedBackupId", "type": "integer", "required": false, "description": "如果需要克隆实例回档到指定备份集，则指定该值为备份文件的 Id。请使用 [查询数据备份文件列表](/document/api/236/15842)。 说明：如果是克隆双节点、三节点实例，备份文件为物理备份，如果是克隆单节点、云盘版实例，备份文件为快照备份。", "example": "118127" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络 ID，请使用 [查询私有网络列表](/document/api/215/15778)。", "example": "vpc-594gwq4l" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "私有网络下的子网 ID，如果设置了 UniqVpcId，则 UniqSubnetId 必填，请使用 [查询子网列表](/document/api/215/15784)。", "example": "subnet-dz5pj862" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例内存大小，单位：MB，需要不低于克隆源实例，默认和源实例相同。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": false, "description": "实例硬盘大小，单位：GB，需要不低于克隆源实例，默认和源实例相同。", "example": "50" }, { "name": "InstanceName", "type": "string", "required": false, "description": "新产生的克隆实例名称。支持输入最大60个字符。", "example": "Instance_andy" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组参数，可使用 [查询项目安全组信息](https://cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。", "example": "[\"sg-xxx\"]", "item_type": "string" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "实例标签信息。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签值", "example": "[\"zhang\",\"li\"]", "item_type": "string" } ] }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例Cpu核数，需要不低于克隆源实例，默认和源实例相同。", "example": "1" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。", "example": "0" }, { "name": "DeployMode", "type": "integer", "required": false, "description": "多可用区域，默认为 0，支持值包括：0 - 表示单可用区，1 - 表示多可用区。", "example": "0" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "新产生的克隆实例备库 1 的可用区信息，默认同源实例 Zone 的值。", "example": "ap-guangzhou-1" }, { "name": "BackupZone", "type": "string", "required": false, "description": "备库 2 的可用区信息，默认为空，克隆强同步主实例时可指定该参数。", "example": "ap-guangzhou-2" }, { "name": "DeviceType", "type": "string", "required": false, "description": "克隆实例类型。支持值包括：\"UNIVERSAL\" - 通用型实例，\"EXCLUSIVE\" - 独享型实例，\"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型，\"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型。不指定则默认为通用型。", "example": "UNIVERSAL" }, { "name": "InstanceNodes", "type": "integer", "required": false, "description": "新克隆实例节点数。如果需要克隆出三节点实例， 请将该值设置为3 或指定 BackupZone 参数。如果需要克隆出两节点实例，请将该值设置为2。默认克隆出两节点实例。", "example": "2" }, { "name": "DeployGroupId", "type": "string", "required": false, "description": "置放群组 ID。", "example": "ps-7t11vrwf" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制等。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.默认为false：发送正常请求，通过检查后直接创建实例。", "example": "true" }, { "name": "CageId", "type": "string", "required": false, "description": "金融围拢 ID 。", "example": "cage-test" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID，默认项目ID0", "example": "0" }, { "name": "PayType", "type": "string", "required": false, "description": "付费类型，PRE_PAID：包年包月，USED_PAID：按量计费。默认为按量计费", "example": "PRE_PAID" }, { "name": "Period", "type": "integer", "required": false, "description": "实例时长，PayType为PRE_PAID时必传，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "1" }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版节点拓扑配置。", "example": "无", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] }, { "name": "SrcRegion", "type": "string", "required": false, "description": "原实例所在地域名，当传入异地备份时为必选项，例：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "SpecifiedSubBackupId", "type": "integer", "required": false, "description": "异地数据备份id", "example": "12445233" }, { "name": "Zone", "type": "string", "required": false, "description": "新产生的克隆实例主库的可用区信息，默认同源实例 Zone 的值。", "example": "ap-guangzhou-3" } ], "required": [ "InstanceId" ] }, { "name": "CreateDBImportJob", "description": "本接口（CreateDBImportJob）用于创建云数据库数据导入任务。 注意，用户进行数据导入任务的文件，必须提前上传到腾讯云。用户须在控制台进行文件导入。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例的 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-ids6j1b3" }, { "name": "User", "type": "string", "required": true, "description": "云数据库的用户名。", "example": "andy" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名称。该文件是指用户已上传到腾讯云的文件，仅支持.sql文件。", "example": "andy.sql" }, { "name": "Password", "type": "string", "required": false, "description": "云数据库实例 User 账号的密码。", "example": "Andy454545" }, { "name": "DbName", "type": "string", "required": false, "description": "导入的目标数据库名，不传表示不指定数据库。", "example": "db1" }, { "name": "CosUrl", "type": "string", "required": false, "description": "腾讯云COS文件链接。 用户需要指定 FileName 或者 CosUrl 其中一个。 COS文件需要是 .sql 文件。", "example": "https://test-bulk-XXXXX.cos.ap-chengdu.myqcloud.com/myFile/create_db.sql" } ], "required": [ "InstanceId", "User" ] }, { "name": "CreateDBInstance", "description": "本接口（CreateDBInstance）用于创建包年包月的云数据库实例（包括主实例、灾备实例和只读实例），可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。 该接口为异步接口，您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为1，且 TaskStatus 为0，表示实例已经发货成功。 1. 首先请使用 [\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位：MB，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": true, "description": "实例硬盘大小，单位：GB，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。", "example": "50" }, { "name": "Period", "type": "integer", "required": true, "description": "实例时长，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "1" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，默认值为1, 最小值1，最大值为100。", "example": "1" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区信息，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。 说明：若您创建单节点、双节点、三节点实例，此参数为必填项，请指定可用区，若不指定可用区，则系统会自动选择一个可用区（可能不是您希望部署的可用区）；若您创建云盘版实例，此参数不填，请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配\ufffd\ufffd...", "example": "ap-beijing-3" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络 ID，请使用 [查询私有网络列表](/document/api/215/15778)。 说明：如果创建的是云盘版实例，此参数为必填且为私有网络类型。若此项不填，则系统会选择默认的 VPC。", "example": "vpc-5l7l5q11" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "私有网络下的子网 ID，如果设置了 UniqVpcId，则 UniqSubnetId 必填，请使用 [查询子网列表](/document/api/215/15784)。 说明：若此项不填，则系统会选择默认 VPC 下的默认子网。", "example": "subnet-b5v6i111" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，不填为默认项目。购买只读实例和灾备实例时，项目 ID 默认和主实例保持一致。", "example": "0" }, { "name": "Port", "type": "integer", "required": false, "description": "自定义端口，端口支持范围：[ 1024-65535 ]。 说明：若此项不填，则默认为3306。", "example": "3306" }, { "name": "InstanceRole", "type": "string", "required": false, "description": "实例类型，支持值包括：master - 表示主实例，dr - 表示灾备实例，ro - 表示只读实例。 说明：请选择实例类型，不填会默认选择 master。", "example": "master" }, { "name": "MasterInstanceId", "type": "string", "required": false, "description": "实例 ID，购买只读实例或灾备实例时必填，该字段表示只读实例或灾备实例的主实例 ID，请使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。", "example": "cdb-q72dnodd" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "MySQL 版本，值包括：5.5、5.6、5.7和8.0，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。 说明：创建非云盘版实例时，请根据需要指定实例版本（推荐5.7或8.0），若此参数不填，则默认值为8.0；若创建的是云盘版实例，则此参数仅能指定为5.7或8.0。", "example": "5.7" }, { "name": "Password", "type": "string", "required": false, "description": "设置 root 账号密码，密码规则：8 - 64 个字符，至少包含字母、数字、字符（支持的字符：_+-\u0026=!@#$%^*()）中的两种，购买主实例时可指定该参数，购买只读实例或者灾备实例时指定该参数无意义。", "example": "your_password" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。", "example": "0" }, { "name": "DeployMode", "type": "integer", "required": false, "description": "多可用区域，默认为 0，支持值包括：0 - 表示单可用区，1 - 表示多可用区。", "example": "0" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "备库 1 的可用区信息。 说明：双节点、三节点实例请指定此参数值，若不指定，则默认为 Zone 的值；云盘版实例此参数可不填，请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置；单节点实例为单可用区，无需指定此参数。", "example": "ap-beijing-3" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表，参数格式如 ParamList.0.Name=auto_increment\u0026ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](https://cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。 说明：表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置，参数值为0表示开启，参数值为1表示关闭，若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例，则需要在创建实例时通过设置 ...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "参数名", "example": "auto_increment" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "1" } ] }, { "name": "BackupZone", "type": "string", "required": false, "description": "备库 2 的可用区信息，默认为空，购买三节点主实例时可指定该参数。", "example": "ap-beijing-3" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标记，可选值为：0 - 不自动续费；1 - 自动续费。默认为0。", "example": "1" }, { "name": "MasterRegion", "type": "string", "required": false, "description": "主实例地域信息，购买灾备、RO实例时，该字段必填。", "example": "ap-guangzhou" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组参数，可使用 [查询项目安全组信息](https://cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。", "example": "[\"sg-9stjvjn1\"]", "item_type": "string" }, { "name": "RoGroup", "type": "object", "required": false, "description": "只读实例参数。购买只读实例时，该参数必传。", "example": "无", "children": [ { "name": "RoGroupMode", "type": "string", "required": true, "description": "只读组模式，可选值为：alone-系统自动分配只读组；allinone-新建只读组；join-使用现有只读组。", "example": "alone" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读组 ID。说明：若此数据结构在购买实例操作中被使用，则当只读组模式选择 join 时，此项为必填。", "example": "cdbrg-92zkeaq2" }, { "name": "RoGroupName", "type": "string", "required": false, "description": "只读组名称。", "example": "your_group_name" }, { "name": "RoOfflineDelay", "type": "integer", "required": false, "description": "是否启用延迟超限剔除功能，启用该功能后，只读实例与主实例的延迟超过延迟阈值，只读实例将被隔离。可选值：1-启用；0-不启用。", "example": "0" }, { "name": "RoMaxDelayTime", "type": "integer", "required": false, "description": "延迟阈值。单位：秒。值范围：1-10000，整数。", "example": "1" }, { "name": "MinRoInGroup", "type": "integer", "required": false, "description": "最少实例保留个数，若购买只读实例数量小于设置数量将不做剔除。", "example": "1" }, { "name": "WeightMode", "type": "string", "required": false, "description": "读写权重分配模式，可选值：system-系统自动分配；custom-自定义。", "example": "system" }, { "name": "Weight", "type": "integer", "required": false, "description": "该字段已经废弃，无意义。查看只读实例的权重，请查看 RoInstances 字段里的 Weight 值。", "example": "0" }, { "name": "RoInstances", "type": "array", "required": false, "description": "只读组中的只读实例详情。", "example": "无", "item_type": "object", "children": [ { "name": "MasterInstanceId", "type": "string", "required": false, "description": "RO组对应的主实例的ID", "example": "cdb-***" }, { "name": "RoStatus", "type": "string", "required": false, "description": "RO实例在RO组内的状态，可能的值：online-在线，offline-下线", "example": "online" }, { "name": "OfflineTime", "type": "string", "required": false, "description": "RO实例在RO组内上一次下线的时间", "example": "2024-09-09 16:40:30" }, { "name": "Weight", "type": "integer", "required": false, "description": "RO实例在RO组内的权重", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "RO实例所在区域名称，如ap-shanghai", "example": "ap-shanghai" }, { "name": "Zone", "type": "string", "required": false, "description": "RO可用区的正式名称，如 ap-shanghai-2", "example": "ap-shanghai-2" }, { "name": "InstanceId", "type": "string", "required": false, "description": "RO实例ID，格式如：cdbro-c1nl9rpv", "example": "cdbro-***" }, { "name": "Status", "type": "integer", "required": false, "description": "RO实例状态，可能返回值：0-创建中，1-运行中，3-异地RO（仅在使用DescribeDBInstances查询主实例信息时，返回值中异地RO的状态恒等于3，其他场景下无此值），4-删除中", "example": "1" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "实例类型，可能返回值：1-主实例，2-灾备实例，3-只读实例", "example": "3" }, { "name": "InstanceName", "type": "string", "required": false, "description": "RO实例名称", "example": "cdbro-khe2c111" }, { "name": "HourFeeStatus", "type": "integer", "required": false, "description": "按量计费状态，可能的取值：1-正常，2-欠费", "example": "1" }, { "name": "TaskStatus", "type": "integer", "required": false, "description": "RO实例任务状态，可能返回值：0-没有任务1-升级中2-数据导入中3-开放Slave中4-外网访问开通中5-批量操作执行中6-回档中7-外网访问关闭中8-密码修改中9-实例名修改中10-重启中12-自建迁移中13-删除库表中14-灾备实例创建同步中", "example": "0" }, { "name": "Memory", "type": "integer", "required": false, "description": "RO实例内存大小，单位：MB", "example": "1000" }, { "name": "Volume", "type": "integer", "required": false, "description": "RO实例硬盘大小，单位：GB", "example": "1" }, { "name": "Qps", "type": "integer", "required": false, "description": "每次查询数量", "example": "0" }, { "name": "Vip", "type": "string", "required": false, "description": "RO实例的内网IP地址", "example": "1.2.3.4" }, { "name": "Vport", "type": "integer", "required": false, "description": "RO实例访问端口", "example": "3306" }, { "name": "VpcId", "type": "integer", "required": false, "description": "RO实例所在私有网络ID", "example": "246100" }, { "name": "SubnetId", "type": "integer", "required": false, "description": "RO实例所在私有网络子网ID", "example": "995192" }, { "name": "DeviceType", "type": "string", "required": false, "description": "RO实例规格描述，目前可取值 CUSTOM", "example": "CUSTOM" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "RO实例数据库引擎版本，可能返回值：5.1、5.5、5.6、5.7、8.0", "example": "5.7" }, { "name": "DeadlineTime", "type": "string", "required": false, "description": "RO实例到期时间，时间格式：yyyy-mm-dd hh:mm:ss，如实例为按量计费模式，则此字段值为0000-00-00 00:00:00", "example": "2024-09-09 16:40:30" }, { "name": "PayType", "type": "integer", "required": false, "description": "RO实例计费类型，可能返回值：0-包年包月，1-按量计费，2-后付费月结", "example": "0" }, { "name": "ReplicationStatus", "type": "string", "required": false, "description": "RO延迟复制状态。", "example": "RUNNING" } ] }, { "name": "Vip", "type": "string", "required": false, "description": "只读组的内网 IP。", "example": "10.89.90.66" }, { "name": "Vport", "type": "integer", "required": false, "description": "只读组的内网端口号。", "example": "3306" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络 ID。", "example": "vpc-ja6ts123" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "子网 ID。", "example": "subnet-njh2bc99" }, { "name": "RoGroupRegion", "type": "string", "required": false, "description": "只读组所在的地域。", "example": "ap-beijing" }, { "name": "RoGroupZone", "type": "string", "required": false, "description": "只读组所在的可用区。", "example": "ap-beijing-3" }, { "name": "DelayReplicationTime", "type": "integer", "required": false, "description": "延迟复制时间。单位：秒。值范围：1-259200，整数。", "example": "1000" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。一次购买多个实例命名会用后缀数字区分，例instnaceName=db，goodsNum=3，实例命名分别为db1，db2，db3。", "example": "cdbzhang" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "实例标签信息。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签值", "example": "[\"zhang\",\"li\"]", "item_type": "string" } ] }, { "name": "DeployGroupId", "type": "string", "required": false, "description": "置放群组 ID。", "example": "ps-7t11vrwf" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间在48小时内唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "********" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例隔离类型。支持值包括：\"UNIVERSAL\" - 通用型实例，\"EXCLUSIVE\" - 独享型实例，\"BASIC_V2\" - ONTKE 单节点实例，\"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型，\"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型。不指定则默认为通用型实例。 说明：如果创建的是云盘版实例，此参数为必填。", "example": "UNIVERSAL" }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板 id。 备注：如您使用自定义参数模板 id，可传入自定义参数模板 id；如您计划使用默认参数模板，该参数模板 id 传入 id 无效，需设置 ParamTemplateType。", "example": "0" }, { "name": "AlarmPolicyList", "type": "array", "required": false, "description": "告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。", "example": "[7957756]", "item_type": "integer" }, { "name": "InstanceNodes", "type": "integer", "required": false, "description": "实例节点数。对于 RO 和 基础版实例， 该值默认为1。 如果需要购买三节点实例， 请将该值设置为3 或指定 BackupZone 参数。当购买主实例，且未指定该参数和 BackupZone 参数时，该值默认是 2， 即购买两节点实例。", "example": "2" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例cpu核数， 如果不传将根据memory指定的内存值自动填充对应的cpu值。", "example": "1" }, { "name": "AutoSyncFlag", "type": "integer", "required": false, "description": "是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为：0 - 不自动发起灾备同步；1 - 自动发起灾备同步。该值默认为0。", "example": "1" }, { "name": "CageId", "type": "string", "required": false, "description": "金融围拢 ID。", "example": "cage-test" }, { "name": "ParamTemplateType", "type": "string", "required": false, "description": "默认参数模板类型。支持值包括：\"HIGH_STABILITY\" - 高稳定模板，\"HIGH_PERFORMANCE\" - 高性能模板。 备注：如您需使用云数据库 MySQL 默认参数模板，请设置 ParamTemplateType。", "example": "HIGH_STABILITY" }, { "name": "AlarmPolicyIdList", "type": "array", "required": false, "description": "告警策略名数组，例如:[\"policy-uyoee9wg\"]，AlarmPolicyList不为空时该参数无效。", "example": "[\"policy-uyoee9wg\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制等。如果检查不通过，则返回对应错误码；如果检查通过，则返回 RequestId。false：发送正常请求，通过检查后直接创建实例。 默认为 false。", "example": "true" }, { "name": "EngineType", "type": "string", "required": false, "description": "实例引擎类型，默认为\"InnoDB\"，支持值包括：\"InnoDB\"，\"RocksDB\"。", "example": "InnoDB" }, { "name": "Vips", "type": "array", "required": false, "description": "指定实例的IP列表。仅支持主实例指定，按实例顺序，不足则按未指定处理。", "example": "[\"172.1.1.1\"]", "item_type": "string" }, { "name": "DataProtectVolume", "type": "integer", "required": false, "description": "云盘版实例的数据保护空间大小，单位 GB，设置范围1 - 10。", "example": "1" }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版节点拓扑配置。 说明：若购买的是云盘版实例，此参数为必填，需设置云盘版实例的 RW 和 RO 节点拓扑，RO 节点范围是1 - 5个，请至少设置1个 RO 节点。", "example": "无", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型，单节点（云盘版）或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘，CLOUD_HSSD 表示增强型 SSD 云硬盘，CLOUD_PREMIUM 表示高性能云硬盘。 说明：单节点（云盘版）、云盘版实例硬盘类型所支持的地域略有不同，具体支持情况请参考 [地域和可用区](https://cloud.tencent.com/document/product/236/8458)。", "example": "CLOUD_SSD" }, { "name": "DestroyProtect", "type": "string", "required": false, "description": "开启或关闭实例销毁保护。on-开启，off-关闭", "example": "on" } ], "required": [ "Memory", "Volume", "Period", "GoodsNum" ] }, { "name": "CreateDBInstanceHour", "description": "本接口（CreateDBInstanceHour）用于创建按量计费的实例，可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例，支持主实例、灾备实例和只读实例的创建。 该接口为异步接口，您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为 1，且 TaskStatus 为 0，表示实例已经发货成功。 1. 首先请使用 [获取云数据\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，默认值为 1，最小值 1，最大值为 100。", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位：MB，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的内存规格。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": true, "description": "实例硬盘大小，单位：GB，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的硬盘范围。", "example": "50" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "MySQL 版本，值包括：5.5、5.6、5.7和8.0，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的实例版本。 说明：创建非云盘版实例时，请根据需要指定实例版本（推荐5.7或8.0），若此参数不填，则默认值为8.0；若创建的是云盘版实例，则此参数仅能指定为5.7或8.0。", "example": "5.7" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络 ID，请使用 [查询私有网络列表](/document/api/215/15778)。 说明：如果创建的是云盘版实例，此参数为必填且为私有网络类型。若此项不填，则系统会选择默认的 VPC。", "example": "vpc-5l7l5q11" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "私有网络下的子网 ID，如果设置了 UniqVpcId，则 UniqSubnetId 必填，请使用 [查询子网列表](/document/api/215/15784)。 说明：若此项不填，则系统会选择默认 VPC 下的默认子网。", "example": "subnet-b5v6i111" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，不填为默认项目。", "example": "0" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区信息，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/api/236/17229) 接口获取可创建的可用区。 说明：若您创建单节点、双节点、三节点实例，此参数为必填项，请指定可用区，若不指定可用区，则系统会自动选择一个可用区（可能不是您希望部署的可用区）；若您创建云盘版实例，此参数不填，请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配\ufffd\ufffd...", "example": "ap-beijing-3" }, { "name": "MasterInstanceId", "type": "string", "required": false, "description": "实例 ID，购买只读实例或者灾备实例时必填，该字段表示只读实例或者灾备实例的主实例 ID，请使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询云数据库实例 ID。", "example": "cdb-q72dno11" }, { "name": "InstanceRole", "type": "string", "required": false, "description": "实例类型，支持值包括：master - 表示主实例，dr - 表示灾备实例，ro - 表示只读实例。 说明：请选择实例类型，不填会默认选择 master。", "example": "master" }, { "name": "MasterRegion", "type": "string", "required": false, "description": "主实例地域信息，购买灾备、RO实例时，该字段必填。", "example": "ap-beijing" }, { "name": "Port", "type": "integer", "required": false, "description": "自定义端口，端口支持范围：[1024 - 65535]。 说明：不填则默认为3306。", "example": "3306" }, { "name": "Password", "type": "string", "required": false, "description": "设置 root 账号密码，密码规则：8 - 64 个字符，至少包含字母、数字、字符（支持的字符：_+-\u0026=!@#$%^*()）中的两种，购买主实例时可指定该参数，购买只读实例或者灾备实例时指定该参数无意义。", "example": "your_password" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表，参数格式如 ParamList.0.Name=auto_increment\u0026ParamList.0.Value=1。可通过 [查询默认的可设置参数列表](https://cloud.tencent.com/document/api/236/32662) 查询支持设置的参数。 说明：表名大小写敏感的开启和关闭可通过参数 lower_case_table_names 进行设置，参数值为0表示开启，参数值为1表示关闭，若不设置则此参数默认值为0。若您创建的是 MySQL 8.0 版本的实例，则需要在创建实例时通过设置 ...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "参数名", "example": "auto_increment" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "1" } ] }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制，购买主实例时可指定该参数，购买只读实例或者灾备实例时指定该参数无意义。", "example": "0" }, { "name": "DeployMode", "type": "integer", "required": false, "description": "多可用区域，默认为 0，支持值包括：0 - 表示单可用区，1 - 表示多可用区，购买主实例时可指定该参数，购买只读实例或者灾备实例时指定该参数无意义。", "example": "0" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "备库 1 的可用区信息。 说明：双节点、三节点实例请指定此参数值，若不指定，则默认为 Zone 的值；云盘版实例此参数可不填，请通过参数 ClusterTopology 进行读写节点和只读节点的可用区配置；单节点实例为单可用区，无需指定此参数。", "example": "ap-beijing-3" }, { "name": "BackupZone", "type": "string", "required": false, "description": "备库 2 的可用区信息，默认为空，购买三节点主实例时可指定该参数。", "example": "ap-beijing-4" }, { "name": "SecurityGroup", "type": "array", "required": false, "description": "安全组参数，可使用 [查询项目安全组信息](https://cloud.tencent.com/document/api/236/15850) 接口查询某个项目的安全组详情。", "example": "[\"sg-9stjvjn1\"]", "item_type": "string" }, { "name": "RoGroup", "type": "object", "required": false, "description": "只读实例信息。购买只读实例时，该参数必传。", "example": "无", "children": [ { "name": "RoGroupMode", "type": "string", "required": true, "description": "只读组模式，可选值为：alone-系统自动分配只读组；allinone-新建只读组；join-使用现有只读组。", "example": "alone" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读组 ID。说明：若此数据结构在购买实例操作中被使用，则当只读组模式选择 join 时，此项为必填。", "example": "cdbrg-92zkeaq2" }, { "name": "RoGroupName", "type": "string", "required": false, "description": "只读组名称。", "example": "your_group_name" }, { "name": "RoOfflineDelay", "type": "integer", "required": false, "description": "是否启用延迟超限剔除功能，启用该功能后，只读实例与主实例的延迟超过延迟阈值，只读实例将被隔离。可选值：1-启用；0-不启用。", "example": "0" }, { "name": "RoMaxDelayTime", "type": "integer", "required": false, "description": "延迟阈值。单位：秒。值范围：1-10000，整数。", "example": "1" }, { "name": "MinRoInGroup", "type": "integer", "required": false, "description": "最少实例保留个数，若购买只读实例数量小于设置数量将不做剔除。", "example": "1" }, { "name": "WeightMode", "type": "string", "required": false, "description": "读写权重分配模式，可选值：system-系统自动分配；custom-自定义。", "example": "system" }, { "name": "Weight", "type": "integer", "required": false, "description": "该字段已经废弃，无意义。查看只读实例的权重，请查看 RoInstances 字段里的 Weight 值。", "example": "0" }, { "name": "RoInstances", "type": "array", "required": false, "description": "只读组中的只读实例详情。", "example": "无", "item_type": "object", "children": [ { "name": "MasterInstanceId", "type": "string", "required": false, "description": "RO组对应的主实例的ID", "example": "cdb-***" }, { "name": "RoStatus", "type": "string", "required": false, "description": "RO实例在RO组内的状态，可能的值：online-在线，offline-下线", "example": "online" }, { "name": "OfflineTime", "type": "string", "required": false, "description": "RO实例在RO组内上一次下线的时间", "example": "2024-09-09 16:40:30" }, { "name": "Weight", "type": "integer", "required": false, "description": "RO实例在RO组内的权重", "example": "1" }, { "name": "Region", "type": "string", "required": false, "description": "RO实例所在区域名称，如ap-shanghai", "example": "ap-shanghai" }, { "name": "Zone", "type": "string", "required": false, "description": "RO可用区的正式名称，如 ap-shanghai-2", "example": "ap-shanghai-2" }, { "name": "InstanceId", "type": "string", "required": false, "description": "RO实例ID，格式如：cdbro-c1nl9rpv", "example": "cdbro-***" }, { "name": "Status", "type": "integer", "required": false, "description": "RO实例状态，可能返回值：0-创建中，1-运行中，3-异地RO（仅在使用DescribeDBInstances查询主实例信息时，返回值中异地RO的状态恒等于3，其他场景下无此值），4-删除中", "example": "1" }, { "name": "InstanceType", "type": "integer", "required": false, "description": "实例类型，可能返回值：1-主实例，2-灾备实例，3-只读实例", "example": "3" }, { "name": "InstanceName", "type": "string", "required": false, "description": "RO实例名称", "example": "cdbro-khe2c111" }, { "name": "HourFeeStatus", "type": "integer", "required": false, "description": "按量计费状态，可能的取值：1-正常，2-欠费", "example": "1" }, { "name": "TaskStatus", "type": "integer", "required": false, "description": "RO实例任务状态，可能返回值：0-没有任务1-升级中2-数据导入中3-开放Slave中4-外网访问开通中5-批量操作执行中6-回档中7-外网访问关闭中8-密码修改中9-实例名修改中10-重启中12-自建迁移中13-删除库表中14-灾备实例创建同步中", "example": "0" }, { "name": "Memory", "type": "integer", "required": false, "description": "RO实例内存大小，单位：MB", "example": "1000" }, { "name": "Volume", "type": "integer", "required": false, "description": "RO实例硬盘大小，单位：GB", "example": "1" }, { "name": "Qps", "type": "integer", "required": false, "description": "每次查询数量", "example": "0" }, { "name": "Vip", "type": "string", "required": false, "description": "RO实例的内网IP地址", "example": "1.2.3.4" }, { "name": "Vport", "type": "integer", "required": false, "description": "RO实例访问端口", "example": "3306" }, { "name": "VpcId", "type": "integer", "required": false, "description": "RO实例所在私有网络ID", "example": "246100" }, { "name": "SubnetId", "type": "integer", "required": false, "description": "RO实例所在私有网络子网ID", "example": "995192" }, { "name": "DeviceType", "type": "string", "required": false, "description": "RO实例规格描述，目前可取值 CUSTOM", "example": "CUSTOM" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "RO实例数据库引擎版本，可能返回值：5.1、5.5、5.6、5.7、8.0", "example": "5.7" }, { "name": "DeadlineTime", "type": "string", "required": false, "description": "RO实例到期时间，时间格式：yyyy-mm-dd hh:mm:ss，如实例为按量计费模式，则此字段值为0000-00-00 00:00:00", "example": "2024-09-09 16:40:30" }, { "name": "PayType", "type": "integer", "required": false, "description": "RO实例计费类型，可能返回值：0-包年包月，1-按量计费，2-后付费月结", "example": "0" }, { "name": "ReplicationStatus", "type": "string", "required": false, "description": "RO延迟复制状态。", "example": "RUNNING" } ] }, { "name": "Vip", "type": "string", "required": false, "description": "只读组的内网 IP。", "example": "10.89.90.66" }, { "name": "Vport", "type": "integer", "required": false, "description": "只读组的内网端口号。", "example": "3306" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络 ID。", "example": "vpc-ja6ts123" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "子网 ID。", "example": "subnet-njh2bc99" }, { "name": "RoGroupRegion", "type": "string", "required": false, "description": "只读组所在的地域。", "example": "ap-beijing" }, { "name": "RoGroupZone", "type": "string", "required": false, "description": "只读组所在的可用区。", "example": "ap-beijing-3" }, { "name": "DelayReplicationTime", "type": "integer", "required": false, "description": "延迟复制时间。单位：秒。值范围：1-259200，整数。", "example": "1000" } ] }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "购买按量计费实例该字段无意义。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。一次购买多个实例命名会用后缀数字区分，例instanceName=db，goodsNum=3，实例命名分别为db1，db2，db3。", "example": "cdbzhang" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "实例标签信息。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签值", "example": "[\"zhang\",\"li\"]", "item_type": "string" } ] }, { "name": "DeployGroupId", "type": "string", "required": false, "description": "置放群组 ID。", "example": "ps-7t11vrwf" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间在48小时内唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "*******" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例隔离类型。支持值包括：\"UNIVERSAL\" - 通用型实例，\"EXCLUSIVE\" - 独享型实例，\"BASIC_V2\" - ONTKE 单节点实例，\"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型，\"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型。不指定则默认为通用型实例。 说明：如果创建的是云盘版实例，此参数为必填。", "example": "UNIVERSAL" }, { "name": "ParamTemplateId", "type": "integer", "required": false, "description": "参数模板 id。 备注：如您使用自定义参数模板 id，可传入自定义参数模板 id；如您计划使用默认参数模板，该参数模板 id 传入 id 无效，需设置 ParamTemplateType。", "example": "0" }, { "name": "AlarmPolicyList", "type": "array", "required": false, "description": "告警策略id数组。腾讯云可观测平台DescribeAlarmPolicy接口返回的OriginId。", "example": "[7957756]", "item_type": "integer" }, { "name": "InstanceNodes", "type": "integer", "required": false, "description": "实例节点数。对于 RO 和 基础版实例， 该值默认为1。 如果需要购买三节点实例， 请将该值设置为3 或指定 BackupZone 参数。当购买主实例，且未指定该参数和 BackupZone 参数时，该值默认是 2， 即购买两节点实例。", "example": "2" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例cpu核数， 如果不传将根据memory指定的内存值自动填充对应的cpu值。", "example": "1" }, { "name": "AutoSyncFlag", "type": "integer", "required": false, "description": "是否自动发起灾备同步功能。该参数仅对购买灾备实例生效。 可选值为：0 - 不自动发起灾备同步；1 - 自动发起灾备同步。该值默认为0。", "example": "1" }, { "name": "CageId", "type": "string", "required": false, "description": "金融围拢 ID 。", "example": "cage-test" }, { "name": "ParamTemplateType", "type": "string", "required": false, "description": "默认参数模板类型。支持值包括：\"HIGH_STABILITY\" - 高稳定模板，\"HIGH_PERFORMANCE\" - 高性能模板，默认值是：\"HIGH_STABILITY\"。 备注：如您需使用云数据库 MySQL 默认参数模板，请设置 ParamTemplateType。", "example": "HIGH_STABILITY" }, { "name": "AlarmPolicyIdList", "type": "array", "required": false, "description": "告警策略名数组，例如:[\"policy-uyoee9wg\"]，AlarmPolicyList不为空时该参数无效。", "example": "[\"policy-uyoee9wg\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制等。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.默认为false：发送正常请求，通过检查后直接创建实例。", "example": "true" }, { "name": "EngineType", "type": "string", "required": false, "description": "实例引擎类型，默认为\"InnoDB\"，支持值包括：\"InnoDB\"，\"RocksDB\"。", "example": "InnoDB" }, { "name": "Vips", "type": "array", "required": false, "description": "指定实例的IP列表。仅支持主实例指定，按实例顺序，不足则按未指定处理。", "example": "[\"172.1.1.1\"]", "item_type": "string" }, { "name": "DataProtectVolume", "type": "integer", "required": false, "description": "云盘版实例的数据保护空间大小，单位 GB，设置范围1 - 10。", "example": "1" }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版节点拓扑配置。 说明：若购买的是云盘版实例，此参数为必填，需设置云盘版实例的 RW 和 RO 节点拓扑，RO 节点范围是1 - 5个，请至少设置1个 RO 节点。", "example": "无", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] }, { "name": "DiskType", "type": "string", "required": false, "description": "硬盘类型，单节点（云盘）或者云盘版实例可以指定此参数。CLOUD_SSD 表示 SSD 云硬盘，CLOUD_HSSD 表示增强型 SSD 云硬盘，CLOUD_PREMIUM 表示高性能云硬盘。 说明：单节点（云盘）、云盘版实例硬盘类型所支持的地域略有不同，具体支持情况请参考 [地域和可用区](https://cloud.tencent.com/document/product/236/8458)。", "example": "CLOUD_SSD" }, { "name": "ClusterType", "type": "string", "required": false, "description": "集群类型:cage——金融围拢，cdc——CDB ON CDC；dedicate——独享集群", "example": "cage" }, { "name": "DestroyProtect", "type": "string", "required": false, "description": "开启或关闭实例销毁保护。on-开启，off-关闭", "example": "on" } ], "required": [ "GoodsNum", "Memory", "Volume" ] }, { "name": "CreateDatabase", "description": "本接口(CreateDatabase)用于在云数据库实例中创建数据库。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "DBName", "type": "string", "required": true, "description": "数据库名称，长度不超过64。", "example": "db_test" }, { "name": "CharacterSetName", "type": "string", "required": true, "description": "字符集，可选值：utf8，gbk，latin1，utf8mb4。", "example": "utf8" } ], "required": [ "InstanceId", "DBName", "CharacterSetName" ] }, { "name": "CreateDeployGroup", "description": "本接口（CreateDeployGroup）用于创建放置实例的置放群组。", "status": "online", "parameters": [ { "name": "DeployGroupName", "type": "string", "required": true, "description": "置放群组名称，最长不能超过60个字符。", "example": "cdb-ezq1vzem" }, { "name": "Description", "type": "string", "required": false, "description": "置放群组描述，最长不能超过200个字符。", "example": "1区群组" }, { "name": "Affinity", "type": "array", "required": false, "description": "置放群组的亲和性策略，目前仅支持取值为1，策略1表示同台物理机上限制实例的个数。", "example": "0", "item_type": "integer" }, { "name": "LimitNum", "type": "integer", "required": false, "description": "置放群组亲和性策略1中同台物理机上实例的限制个数。", "example": "0" }, { "name": "DevClass", "type": "array", "required": false, "description": "置放群组机型属性，可选参数：SH12+SH02、TS85。", "example": "TS85", "item_type": "string" } ], "required": [ "DeployGroupName" ] }, { "name": "CreateParamTemplate", "description": "该接口（CreateParamTemplate）用于创建参数模板。 说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "参数模板名称。支持输入最大60个字符。", "example": "mysql1" }, { "name": "Description", "type": "string", "required": false, "description": "参数模板描述。", "example": "1区使用" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "MySQL 版本号。可选值：5.6、5.7、8.0。", "example": "5.7" }, { "name": "TemplateId", "type": "integer", "required": false, "description": "源参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。", "example": "17192" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表。", "example": "[{\"CurrentValue\": \"59\",\"OldValue\": \"60\",\"ParamName\": \"authentication_timeout\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": false, "description": "参数值", "example": "1" } ] }, { "name": "TemplateType", "type": "string", "required": false, "description": "默认参数模板类型。支持值包括：\"HIGH_STABILITY\" - 高稳定模板，\"HIGH_PERFORMANCE\" - 高性能模板。", "example": "HIGH_STABILITY" }, { "name": "EngineType", "type": "string", "required": false, "description": "实例引擎类型，默认为\"InnoDB\"，支持值包括：\"InnoDB\"，\"RocksDB\"。 说明：数据库版本 MySQL 5.7、MySQL 8.0才支持 RocksDB。", "example": "InnoDB" } ], "required": [ "Name" ] }, { "name": "CreateRoInstanceIp", "description": "本接口(CreateRoInstanceIp)用于创建云数据库只读实例的独立VIP。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "只读实例ID，格式如：cdbro-3i70uj0k，与云数据库控制台页面中显示的只读实例ID相同。", "example": "cdbro-c1nl9rpv" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "子网描述符，例如：subnet-1typ0s7d。", "example": "subnet-1typ0s7d" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpc描述符，例如：vpc-a23yt67j,如果传了该字段则UniqSubnetId必传", "example": "vpc-a23yt67j" } ], "required": [ "InstanceId" ] }, { "name": "CreateRotationPassword", "description": "本接口（CreateRotationPassword）用于开启密码轮转。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Accounts", "type": "array", "required": true, "description": "当前需开启密码轮转的账号信息，包含账户名与主机名", "example": "[{\"User\": \"andy\",\"Host\": \"192.1.1.1\"}]", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "DeleteAccounts", "description": "本接口（DeleteAccounts）用于删除云数据库的账户。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Accounts", "type": "array", "required": true, "description": "云数据库账号。", "example": "[{\"User\": \"andy\",\"Host\": \"192.1.1.1\"}]", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "DeleteAuditLogFile", "description": "本接口(DeleteAuditLogFile)用于删除云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "FileName", "type": "string", "required": true, "description": "审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。", "example": "13123**346_cdb-0ej6n21d_1734**9765_42322441.csv" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-0ej6n21d" } ], "required": [ "FileName", "InstanceId" ] }, { "name": "DeleteAuditPolicy", "description": "本接口(DeleteAuditPolicy)用于删除用户的审计策略。", "status": "online", "parameters": [ { "name": "PolicyId", "type": "string", "required": true, "description": "审计策略 ID。", "example": "cdbpolicy-234" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID。", "example": "cdb-0ej6n21d" } ], "required": [ "PolicyId" ] }, { "name": "DeleteAuditRule", "description": "不再支持审计规则创建 本接口(DeleteAuditRule)用于删除用户的审计规则。", "status": "deprecated", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "审计规则 ID。", "example": "cdbrule-qwerasdf" } ], "required": [ "RuleId" ] }, { "name": "DeleteAuditRuleTemplates", "description": "本接口（DeleteAuditRuleTemplates）用于删除审计规则模板。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": true, "description": "审计规则模板 ID，可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取，单次允许最多删除5个规则模板。", "example": "cdb-art-l1mlbo59", "item_type": "string" } ], "required": [ "RuleTemplateIds" ] }, { "name": "DeleteBackup", "description": "本接口（DeleteBackup）用于删除数据库备份。本接口只支持删除手动发起的备份。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "BackupId", "type": "integer", "required": true, "description": "备份任务 ID。您可通过 [查询数据备份文件列表](https://cloud.tencent.com/document/api/236/15842) 来获取目标备份任务 ID。", "example": "173381" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "DeleteDatabase", "description": "本接口(DeleteDatabase)用于在云数据库实例中删除数据库。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "DBName", "type": "string", "required": true, "description": "数据库名称，长度不超过64。", "example": "db_test" } ], "required": [ "InstanceId", "DBName" ] }, { "name": "DeleteDeployGroups", "description": "根据置放群组ID删除置放群组（置放群组中有资源存在时不能删除该置放群组）", "status": "online", "parameters": [ { "name": "DeployGroupIds", "type": "array", "required": true, "description": "要删除的置放群组 ID 列表。", "example": "[\"andy\\r\\n\"]", "item_type": "string" } ], "required": [ "DeployGroupIds" ] }, { "name": "DeleteParamTemplate", "description": "该接口（DeleteParamTemplate）用于删除参数模板。 说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。", "example": "17192" } ], "required": [ "TemplateId" ] }, { "name": "DeleteRotationPassword", "description": "本接口（DeleteRotationPassword）用于关闭实例账户密码轮转。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同", "example": "cdb-c1nl9rpv" }, { "name": "User", "type": "string", "required": true, "description": "关闭密码轮转的实例账户名,例如root", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "关闭密码轮转的实例账户域名，例如%", "example": "192.1.1.1" }, { "name": "Password", "type": "string", "required": true, "description": "关闭密码轮转后实例账户的最新密码", "example": "Andy454545" }, { "name": "EncryptMethod", "type": "string", "required": false, "description": "传入不为空则对密码进行了加密处理", "example": "134531" } ], "required": [ "InstanceId", "User", "Host", "Password" ] }, { "name": "DeleteTimeWindow", "description": "本接口（DeleteTimeWindow）用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为每天的03:00-04:00，数据校验延迟阈值为10秒，即当选择在维护时间窗口内切换访问新实例时，默认会在03:00-04:00点进行切换访问新实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-eb2w7dto" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAccountPrivileges", "description": "本接口（DescribeAccountPrivileges）用于查询云数据库账户支持的权限信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "User", "type": "string", "required": true, "description": "数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "ajnnw" }, { "name": "Host", "type": "string", "required": true, "description": "数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "127.0.0.1" } ], "required": [ "InstanceId", "User", "Host" ] }, { "name": "DescribeAccounts", "description": "本接口（DescribeAccounts）用于查询云数据库的所有账户信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为20，最小值为1，最大值为100。", "example": "1" }, { "name": "AccountRegexp", "type": "string", "required": false, "description": "匹配账号名的正则表达式，规则同 MySQL 官网。", "example": "^[a-zA-Z0-9_]{3,20}$" }, { "name": "SortBy", "type": "string", "required": false, "description": "默认无排序，支持：ASC、DESC、asc、desc", "example": "desc" }, { "name": "OrderBy", "type": "string", "required": false, "description": "待排序的时间字段，可选：CreateTime(账号创建时间)、ModifyTime(账号更新时间)、ModifyPasswordTime(密码修改时间)", "example": "CreateTime" }, { "name": "HostRegexp", "type": "string", "required": false, "description": "匹配账号主机地址（Host）的正则表达式，规则同 MySQL 官网", "example": "%" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAsyncRequestInfo", "description": "本接口(DescribeAsyncRequestInfo)用于查询云数据库实例异步任务的执行结果。", "status": "online", "parameters": [ { "name": "AsyncRequestId", "type": "string", "required": true, "description": "异步任务的请求 ID。", "example": "f96e4f3c-8fc96c86-2ec79ac8-cb63a7a7" } ], "required": [ "AsyncRequestId" ] }, { "name": "DescribeAuditConfig", "description": "本接口(DescribeAuditConfig)用于查询云数据库审计策略的服务配置，包括审计日志保存时长等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-txcniupi" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAuditInstanceList", "description": "本接口（DescribeAuditInstanceList）用于获取审计实例列表。", "status": "online", "parameters": [ { "name": "AuditSwitch", "type": "integer", "required": false, "description": "实例审计开启的状态。1-已开启审计；0-未开启审计。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "查询实例列表的过滤条件。", "example": "[{\"Values\": [\"cdb-euu5fkcj\"], \"Name\": \"InstanceId\",\"ExactMatch\": true}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤条件名。支持InstanceId-实例ID，InstanceName-实例名称，ProjectId-项目ID，TagKey-标签键，Tag-标签（以竖线分割，例：Tagkey|Tagvalue）。", "example": "InstanceId" }, { "name": "ExactMatch", "type": "boolean", "required": true, "description": "true表示精确查找，false表示模糊匹配。", "example": "true" }, { "name": "Values", "type": "array", "required": true, "description": "筛选值", "example": "cdb-euu5fkcj", "item_type": "string" } ] }, { "name": "AuditMode", "type": "integer", "required": false, "description": "实例的审计规则模式。1-规则审计；0-全审计。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。默认值为30，最大值为 20000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为 0。", "example": "1" } ], "required": [] }, { "name": "DescribeAuditLogFiles", "description": "本接口（DescribeAuditLogFiles）用于查询云数据库实例的审计日志文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-qwerasdf" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小参数。默认值为20，最小值为1，最大值为300。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "0" }, { "name": "FileName", "type": "string", "required": false, "description": "审计日志文件名。", "example": "shenji_andy" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAuditLogs", "description": "本接口（DescribeAuditLogs）用于查询数据库审计日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-of5qmu1b" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间(建议开始到结束时间区间最大7天)。", "example": "2023-06-18 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(建议开始到结束时间区间最大7天）。", "example": "2023-06-19 00:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，单次返回的数据条数。默认值为100，最大值为100。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "日志偏移量，最多支持偏移查询65535条日志。可填写范围：0 - 65535。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式。支持值包括：\"ASC\" - 升序，\"DESC\" - 降序，默认降序排序。", "example": "DESC" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段。支持值包括(默认按照时间戳排序)： \"timestamp\" - 时间戳； \"affectRows\" - 影响行数； \"execTime\" - 执行时间。", "example": "timestamp" }, { "name": "LogFilter", "type": "array", "required": false, "description": "过滤条件。多个值之前是且的关系。", "example": "[{\"Type\": \"host\", \"Compare\": \"EXC\",\"Value\": \t\"10.0.\"}]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "过滤项。目前支持以下搜索条件： 包含、不包含、包含（分词维度）、不包含（分词维度）: sql - SQL详情；alarmLevel - 告警等级；ruleTemplateId - 规则模板Id 等于、不等于、包含、不包含： host - 客户端地址； user - 用户名； dbName - 数据库名称； 等于、不等于： sqlType - SQL类型； errCode - 错误码； threadId - 线程ID； 范围搜索（时间类型统一为微秒）： execTime - 执行时间； lockWaitTime - ...", "example": "host" }, { "name": "Compare", "type": "string", "required": false, "description": "过滤条件。支持以下条件： WINC-包含（分词维度）， WEXC-不包含（分词维度）, INC - 包含, EXC - 不包含, EQS - 等于, NEQ - 不等于, RA - 范围。", "example": "EXC" }, { "name": "Value", "type": "array", "required": false, "description": "过滤的值。反向查询时，多个值之前是且的关系，正向查询多个值是或的关系", "example": "10.0.", "item_type": "string" } ] } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeAuditPolicies", "description": "本接口（DescribeAuditPolicies）用于查询云数据库实例的审计策略。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-qwerasdf" }, { "name": "PolicyId", "type": "string", "required": false, "description": "审计策略 ID。", "example": "cdbpolicy-asdfqwer" }, { "name": "PolicyName", "type": "string", "required": false, "description": "审计策略名称。支持按审计策略名称进行模糊匹配查询。", "example": "full" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小参数。默认值为 20，最小值为 1，最大值为 100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "0" }, { "name": "RuleId", "type": "string", "required": false, "description": "审计规则 ID。可使用该审计规则 ID 查询到其关联的审计策略。 注意，参数 RuleId，InstanceId，PolicyId，PolicyName 必须至少传一个。", "example": "cdbrule-asdfqwer" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称", "example": "cdb" } ], "required": [] }, { "name": "DescribeAuditRuleTemplateModifyHistory", "description": "本接口（DescribeAuditRuleTemplateModifyHistory）用于查询规则模板变更记录。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "审计规则模板ID,可通过[DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811)接口获取。", "example": "[\"cdb-art-8qx2kcr7\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询范围的开始时间。", "example": "2023-08-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询范围的结束时间。", "example": "2023-08-02 00:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回条数,默认值-20，最大值-1000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，DESC-按修改时间倒排，ASC-正序，默认：DESC。", "example": "DESC" } ], "required": [] }, { "name": "DescribeAuditRuleTemplates", "description": "本接口（DescribeAuditRuleTemplates）用于查询审计规则模板信息。", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板ID。", "example": "cdb-art-nuzwpha1", "item_type": "string" }, { "name": "RuleTemplateNames", "type": "array", "required": false, "description": "规则模板名称。", "example": "测试template", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量。默认值20，最大值为1000。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为 0。", "example": "0" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1-低风险，2-中风险，3-高风险。", "example": "3" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0-不告警，1-告警。", "example": "1" } ], "required": [] }, { "name": "DescribeAuditRules", "description": "不再支持审计规则创建 本接口(DescribeAuditRules)用于查询用户在当前地域的审计规则。", "status": "deprecated", "parameters": [ { "name": "RuleId", "type": "string", "required": false, "description": "审计规则 ID。", "example": "rule_123" }, { "name": "RuleName", "type": "string", "required": false, "description": "审计规则名称。支持按审计规则名称进行模糊匹配查询。", "example": "rule_name" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小参数。默认值为 20，最小值为 1，最大值为 100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。默认值为0。", "example": "0" } ], "required": [] }, { "name": "DescribeBackupConfig", "description": "本接口（DescribeBackupConfig）用于查询数据库备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupDecryptionKey", "description": "本接口（DescribeBackupDecryptionKey）用于查询备份文件解密密钥。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-fybaegd8。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-fybaegd8" }, { "name": "BackupId", "type": "integer", "required": true, "description": "实例的备份 ID，可通过 [DescribeBackups](https://cloud.tencent.com/document/api/236/15842) 接口查询备份的 ID。", "example": "12445233" }, { "name": "BackupType", "type": "string", "required": false, "description": "备份类型。data-数据备份，binlog-日志备份，默认为 data。", "example": "binlog" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "DescribeBackupDownloadRestriction", "description": "该接口用户查询当前地域用户设置的默认备份下载来源限制。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBackupEncryptionStatus", "description": "本接口(DescribeBackupEncryptionStatus)用于查询实例默认备份加密状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-XXXX。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-XXXX" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupOverview", "description": "本接口(DescribeBackupOverview)用于查询用户的备份概览。返回用户当前备份总个数、备份总的占用容量、赠送的免费容量、计费容量（容量单位为字节）。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "需要查询备份概览的云数据库产品类型。可取值为：mysql 指双节点/三节点的高可用实例，mysql-basic 指单节点（云盘）实例，mysql-cluster 指云盘版实例。", "example": "mysql" } ], "required": [ "Product" ] }, { "name": "DescribeBackupSummaries", "description": "本接口（DescribeBackupSummaries）用于查询备份的统计情况，返回以实例为维度的备份占用容量，以及每个实例的数据备份和日志备份的个数和容量（容量单位为字节）。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "需要查询备份实时统计的云数据库产品类型。可取值为：mysql 指双节点/三节点的高可用实例，mysql-basic 指单节点（云盘）实例，mysql-cluster 指云盘版实例。", "example": "mysql" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询数据的偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询数据的条目限制，默认值为20。最小值为1，最大值为100。", "example": "1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "指定按某一项排序，可选值包括： BackupVolume: 备份容量， DataBackupVolume: 数据备份容量， BinlogBackupVolume: 日志备份容量， AutoBackupVolume: 自动备份容量， ManualBackupVolume: 手动备份容量。默认按照BackupVolume排序。", "example": "BackupVolume" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "指定排序方向，可选值包括： ASC: 正序， DESC: 逆序。默认值为 ASC。", "example": "ASC" } ], "required": [ "Product" ] }, { "name": "DescribeBackups", "description": "本接口(DescribeBackups)用于查询云数据库实例的备份数据。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认值为20，最小值为1，最大值为1000。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBinlogBackupOverview", "description": "本接口(DescribeBinlogBackupOverview)用于查询用户在当前地域总的日志备份概览。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "需要查询日志备份概览的云数据库产品类型。可取值为：mysql 指双节点/三节点的高可用实例，mysql-basic 指单节点（云盘）实例，mysql-cluster 指云盘版实例。", "example": "mysql" } ], "required": [ "Product" ] }, { "name": "DescribeBinlogs", "description": "本接口(DescribeBinlogs)用于查询云数据库实例的 binlog 文件列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认值为20，最小值为1，最大值为1000。", "example": "20" }, { "name": "MinStartTime", "type": "string", "required": false, "description": "binlog最早开始时间，时间格式：2016-03-17 02:10:37", "example": "2024-03-17 02:10:37" }, { "name": "MaxStartTime", "type": "string", "required": false, "description": "binlog最晚开始时间，时间格式：2016-03-17 02:10:37", "example": "2024-03-18 02:10:37" }, { "name": "ContainsMinStartTime", "type": "boolean", "required": false, "description": "返回binlog列表是否包含MinStartTime起始节点，默认为否", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCPUExpandStrategyInfo", "description": "通过该 API 可以查询实例的 CPU 弹性扩容信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-xxdasd" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCdbProxyInfo", "description": "本接口（DescribeCdbProxyInfo）用于查询数据库代理详情信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-aykuksx3" }, { "name": "ProxyGroupId", "type": "string", "required": false, "description": "代理组 ID。", "example": "proxy-ixw3ll2d" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCdbZoneConfig", "description": "本接口(DescribeCdbZoneConfig)用于查询云数据库各地域可售卖的规格配置。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCloneList", "description": "本接口（DescribeCloneList）用于查询用户实例的克隆任务列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "查询指定源实例的克隆任务列表。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/api/236/15872) 接口获取实例 ID。", "example": "cdb-9303wd4x" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页查询时的偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页查询时的每页条目数，默认值为20，建议最大取值100。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeClusterInfo", "description": "本接口（DescribeClusterInfo）用于查询云盘版实例信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 说明：仅能输入实例架构为云盘版的实例 ID，对应控制台实例配置显示为“云盘版（云盘）”的实例。", "example": "cdb-dctw4edd" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCpuExpandHistory", "description": "本接口（DescribeCpuExpandHistory）用于查询扩容历史。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-dctw4edd" }, { "name": "ExpandStrategy", "type": "string", "required": false, "description": "扩容策略，值包括：all，manual，auto", "example": "manual" }, { "name": "Status", "type": "string", "required": false, "description": "扩容状态，值包括：all，extend，reduce，extend_failed", "example": "extend" }, { "name": "StartTime", "type": "integer", "required": false, "description": "查询的开始时间。只能查看30天内的扩容历史，格式为 Integer 的时间戳（秒级）。", "example": "1750994217" }, { "name": "EndTime", "type": "integer", "required": false, "description": "查询的结束时间，默认为当前时间。只能查看30天内的扩容历史，格式为 Integer 的时间戳（秒级）。", "example": "1750994218" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页入参", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页入参，默认20", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBFeatures", "description": "本接口（DescribeDBFeatures）用于查询云数据库版本属性，包括是否支持数据库加密、数据库审计等功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-qwerasdf" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBImportRecords", "description": "本接口(DescribeDBImportRecords)用于查询云数据库导入任务操作日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-7r8h0h61" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，时间格式如：2016-01-01 00:00:01。", "example": "2016-01-01 00:00:01" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，时间格式如：2016-01-01 23:59:59。", "example": "2017-08-24 15:03:01" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数，偏移量，默认值为0。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，单次请求返回的数量，默认值为20，最小值为1，最大值为100。", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceCharset", "description": "本接口(DescribeDBInstanceCharset)用于查询云数据库实例的字符集，获取字符集的名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceConfig", "description": "本接口（DescribeDBInstanceConfig）用于查询云数据库实例的配置信息，包括同步模式，部署模式等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceGTID", "description": "本接口(DescribeDBInstanceGTID)用于查询云数据库实例是否开通了 GTID，不支持版本为 5.5 以及以下的实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceInfo", "description": "本接口（DescribeDBInstanceInfo）用于查询实例基本信息（实例 ID，实例名称，是否开通加密），只读实例不支持查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 说明：仅主实例支持查询，此项仅支持输入主实例 ID。", "example": "cdb-59dm059k" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceLogToCLS", "description": "本接口（DescribeDBInstanceLogToCLS）用于查询实例慢日志、错误日志投递CLS的配置，通过AppId、Region以及实例ID过滤出当前实例日志投递CLS的配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-r1ok5w15" }, { "name": "ClsRegion", "type": "string", "required": false, "description": "CLS服务所在地域", "example": "ap-guangzhou" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceRebootTime", "description": "本接口（DescribeDBInstanceRebootTime）用于查询云数据库实例重启预计所需的时间。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例的 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。 说明：可输入多个实例 ID 进行查询，json 格式如下。 [ \"cdb-30z11v8s\", \"cdb-93h11efg\" ]", "example": "cdb-f35wr6wj", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeDBInstances", "description": "本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目 ID、实例 ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。 说明：通过本接口返回的可用区情况为购买时的情况，不随主动 HA 切换变化。如需了解实时可用区情况，请通过 [DescribeDBInstanceConfig](https://cloud.tencent.com/document/product/236/17491) 接口进行查询。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。", "example": "0" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。", "example": "[1]", "item_type": "integer" }, { "name": "Vips", "type": "array", "required": false, "description": "实例的内网 IP 地址。", "example": "[\"172.1.1.1\"]", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "实例状态，可取值：0 - 创建中1 - 运行中4 - 正在进行隔离操作5 - 已隔离（可在回收站恢复开机）", "example": "[1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为 20，最大值为 2000。", "example": "1" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。", "example": "sg-ajr1jzgj" }, { "name": "PayTypes", "type": "array", "required": false, "description": "付费类型，可取值：0 - 包年包月，1 - 小时计费。", "example": "[1]", "item_type": "integer" }, { "name": "InstanceNames", "type": "array", "required": false, "description": "实例名称。", "example": "[\"cdb27418\"]", "item_type": "string" }, { "name": "TaskStatus", "type": "array", "required": false, "description": "实例任务状态，可能取值：0 - 没有任务1 - 升级中2 - 数据导入中3 - 开放Slave中4 - 外网访问开通中5 - 批量操作执行中6 - 回档中7 - 外网访问关闭中8 - 密码修改中9 - 实例名修改中10 - 重启中12 - 自建迁移中13 - 删除库表中14 - 灾备实例创建同步中15 - 升级待切换16 - 升级切换中17 - 升级切换完成19 - 参数设置待执行34 - 原地升级待执行", "example": "[0]", "item_type": "integer" }, { "name": "EngineVersions", "type": "array", "required": false, "description": "实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。", "example": "[\"5.7\",\"8.0\"]", "item_type": "string" }, { "name": "VpcIds", "type": "array", "required": false, "description": "私有网络的 ID。", "example": "[0]", "item_type": "integer" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区的 ID。", "example": "[720001]", "item_type": "integer" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网 ID。", "example": "[0]", "item_type": "integer" }, { "name": "CdbErrors", "type": "array", "required": false, "description": "是否锁定标记，可选值：0 - 不锁定，1 - 锁定，默认为0。", "example": "[0]", "item_type": "integer" }, { "name": "OrderBy", "type": "string", "required": false, "description": "返回结果集排序的字段，目前支持：\"instanceId\"，\"instanceName\"，\"createTime\"，\"deadlineTime\"。", "example": "instanceId" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "返回结果集排序方式。目前支持值：\"ASC\" - 表示升序，\"DESC\" - 表示降序，默认为 \"DESC\"。", "example": "\"DESC\"" }, { "name": "WithSecurityGroup", "type": "integer", "required": false, "description": "是否以安全组 ID 为过滤条件。 说明：0表示否，1表示是。", "example": "0" }, { "name": "WithExCluster", "type": "integer", "required": false, "description": "是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。", "example": "0" }, { "name": "ExClusterId", "type": "string", "required": false, "description": "独享集群 ID。", "example": "cdb-g2ql0j11" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID。", "example": "[\"cdb-70zdmgg1\"]", "item_type": "string" }, { "name": "InitFlag", "type": "integer", "required": false, "description": "初始化标记，可取值：0 - 未初始化，1 - 初始化。", "example": "0" }, { "name": "WithDr", "type": "integer", "required": false, "description": "是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中， 如果拉取灾备实例， 则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。", "example": "0" }, { "name": "WithRo", "type": "integer", "required": false, "description": "是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。", "example": "0" }, { "name": "WithMaster", "type": "integer", "required": false, "description": "是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。", "example": "0" }, { "name": "DeployGroupIds", "type": "array", "required": false, "description": "置放群组ID列表。", "example": "[\"ps-7t11vrwf\"]", "item_type": "string" }, { "name": "TagKeysForSearch", "type": "array", "required": false, "description": "是否以标签键为过滤条件。", "example": "[\"tagKey\"]", "item_type": "string" }, { "name": "CageIds", "type": "array", "required": false, "description": "金融围拢 ID 。", "example": "[\"cage-dhges\"]", "item_type": "string" }, { "name": "TagValues", "type": "array", "required": false, "description": "标签值", "example": "[\"a12\",\"v22\"]", "item_type": "string" }, { "name": "UniqueVpcIds", "type": "array", "required": false, "description": "私有网络字符型vpcId", "example": "[\"vpc-saxa\",\"vpc-sss\"]", "item_type": "string" }, { "name": "UniqSubnetIds", "type": "array", "required": false, "description": "私有网络字符型subnetId", "example": "[\"subnet-kkai\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键值 请注意，创建中的实例无法查询到标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "zhang" } ] }, { "name": "ProxyVips", "type": "array", "required": false, "description": "数据库代理 IP 。", "example": "[\"127.0.0.1\"]", "item_type": "string" }, { "name": "ProxyIds", "type": "array", "required": false, "description": "数据库代理 ID 。", "example": "[\"proxynode-xxxx\"]", "item_type": "string" }, { "name": "EngineTypes", "type": "array", "required": false, "description": "数据库引擎类型。可选值为：InnoDB、RocksDB。", "example": "[\"InnoDB\"]", "item_type": "string" }, { "name": "QueryClusterInfo", "type": "boolean", "required": false, "description": "是否获取云盘版实例节点信息，可填：true 或 false。默认为 false。", "example": "false" } ], "required": [] }, { "name": "DescribeDBPrice", "description": "本接口（DescribeDBPrice）用于查询购买或续费云数据库实例的价格，支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。可传入实例名称来查询实例续费价格。 注意：对某个地域进行询价，请使用对应地域的接入点，接入点信息请参照 服务地址 文档。例如：对广州地域进行询价，请把请求发到\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "Period", "type": "integer", "required": true, "description": "实例时长，单位：月，最小值 1，最大值为 36；查询按量计费价格时，该字段无效。", "example": "1" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区信息，格式如 \"ap-guangzhou-2\"。具体能设置的值请通过 DescribeDBZoneConfig 接口查询。InstanceId为空时该参数为必填项。", "example": "ap-guangzhou-2" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "实例数量，默认值为 1，最小值 1，最大值为 100。InstanceId为空时该参数为必填项。", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例内存大小，单位：MB。InstanceId 为空时该参数为必填项。为保证传入值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可售卖的实例内存大小范围。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": false, "description": "实例硬盘大小，单位：GB。InstanceId 为空时该参数为必填项。为保证传入值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可售卖的硬盘大小范围。", "example": "50" }, { "name": "InstanceRole", "type": "string", "required": false, "description": "实例类型，默认为 master，支持值包括：master - 表示主实例，ro - 表示只读实例，dr - 表示灾备实例。InstanceId为空时该参数为必填项。", "example": "master" }, { "name": "PayType", "type": "string", "required": false, "description": "付费类型，支持值包括：PRE_PAID - 包年包月，HOUR_PAID - 按量计费。InstanceId为空时该参数为必填项。", "example": "PRE_PAID" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。", "example": "0" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例隔离类型。支持值包括： \"UNIVERSAL\" - 通用型实例， \"EXCLUSIVE\" - 独享型实例， \"BASIC_V2\" - 单节点云盘版实例。 \"CLOUD_NATIVE_CLUSTER\" - 集群版标准型， \"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 集群版加强型。 不指定则默认为通用型实例。", "example": "UNIVERSAL" }, { "name": "InstanceNodes", "type": "integer", "required": false, "description": "实例节点数。对于 RO 和 基础版实例， 该值默认为1。 如果需要询价三节点实例， 请将该值设置为3。其余主实例该值默认为2。", "example": "2" }, { "name": "Cpu", "type": "integer", "required": false, "description": "询价实例的CPU核心数目，单位：核，为保证传入 CPU 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可售卖的核心数目，当未指定该值时，将按照 Memory 大小补全一个默认值。", "example": "4" }, { "name": "InstanceId", "type": "string", "required": false, "description": "询价续费实例ID。如需查询实例续费价格，填写InstanceId和Period即可。", "example": "\"cdb-xxx\"" }, { "name": "Ladder", "type": "integer", "required": false, "description": "按量计费阶梯。仅PayType=HOUR_PAID有效，支持值包括：1，2，3。阶梯时长见https://cloud.tencent.com/document/product/236/18335。", "example": "1" }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型，查询集群版、单节点云盘版实例价格可以指定该参数。支持值包括： \"CLOUD_SSD\" - SSD云硬盘， \"CLOUD_HSSD\" - 增强型SSD云硬盘。 默认为 SSD云硬盘。", "example": "CLOUD_SSD" } ], "required": [ "Period" ] }, { "name": "DescribeDBSecurityGroups", "description": "本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-c1nl9rpv或者cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。", "example": "cdb-eb2w7dto" }, { "name": "ForReadonlyInstance", "type": "boolean", "required": false, "description": "该值默认为False，表示当传入只读实例ID时，查询操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组， 需要将该入参置为True。", "example": "False" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。", "example": "cdb-xxx|readonly" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBSwitchRecords", "description": "本接口(DescribeDBSwitchRecords)用于查询云数据库实例切换记录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-nrdbtr5o" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认值为50，最小值为1，最大值为1000。", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDataBackupOverview", "description": "本接口(DescribeDataBackupOverview)用于查询用户在当前地域总的数据备份概览。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "需要查询数据备份概览的云数据库产品类型。可取值为：mysql 指双节点/三节点的高可用实例，mysql-basic 指单节点（云盘）实例，mysql-cluster 指云盘版实例。", "example": "mysql" } ], "required": [ "Product" ] }, { "name": "DescribeDatabases", "description": "本接口(DescribeDatabases)用于查询云数据库实例的数据库信息，仅支持主实例和灾备实例，不支持只读实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，最小值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求数量，默认值为20，最小值为1，最大值为5000。", "example": "100" }, { "name": "DatabaseRegexp", "type": "string", "required": false, "description": "匹配数据库库名的正则表达式。", "example": "^database.*" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDefaultParams", "description": "该接口（DescribeDefaultParams）用于查询默认的可设置参数列表。", "status": "online", "parameters": [ { "name": "EngineVersion", "type": "string", "required": false, "description": "引擎版本，目前支持 [\"5.1\", \"5.5\", \"5.6\", \"5.7\", \"8.0\"]。 说明：引擎版本为必填。", "example": "8.0" }, { "name": "TemplateType", "type": "string", "required": false, "description": "默认参数模板类型。支持值包括：\"HIGH_STABILITY\" - 高稳定模板，\"HIGH_PERFORMANCE\" - 高性能模板。默认值为：HIGH_STABILITY。", "example": "HIGH_STABILITY" }, { "name": "EngineType", "type": "string", "required": false, "description": "参数模板引擎，默认值：InnoDB，可取值：InnoDB、RocksDB。", "example": "InnoDB" } ], "required": [] }, { "name": "DescribeDeployGroupList", "description": "本接口(DescribeDeployGroupList)用于查询用户的置放群组列表，可以指定置放群组 ID 或置放群组名称。", "status": "online", "parameters": [ { "name": "DeployGroupId", "type": "string", "required": false, "description": "置放群组 ID。", "example": "ps-7t11vrwf" }, { "name": "DeployGroupName", "type": "string", "required": false, "description": "置放群组名称。", "example": "andy" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" } ], "required": [] }, { "name": "DescribeDeviceMonitorInfo", "description": "本接口（DescribeDeviceMonitorInfo）用于查询云数据库物理机当天的监控信息，暂只支持内存488G、硬盘6T的实例查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。", "example": "cdb-uns231ns" }, { "name": "Count", "type": "integer", "required": false, "description": "返回当天最近Count个5分钟粒度的监控数据。最小值1，最大值288，不传该参数默认返回当天所有5分钟粒度监控数据。", "example": "2" } ], "required": [ "InstanceId" ] }, { "name": "DescribeErrorLogData", "description": "根据检索条件查询实例错误日志详情。只能查询一个月之内的错误日志。 使用时需要注意：可能存在单条错误日志太大，导致整个http请求的回包太大，进而引发接口超时。一旦发生超时，建议您缩小查询时的Limit参数值，从而降低包的大小，让接口能够及时返回内容。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间戳。例如1585142640，秒级。", "example": "1585142640" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间戳。例如1585142640，秒级。", "example": "1585142640" }, { "name": "KeyWords", "type": "array", "required": false, "description": "要匹配的关键字列表，最多支持15个关键字，支持模糊匹配。", "example": "[\"keywords\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页的返回数量，默认为100，最大为400。", "example": "400" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "InstType", "type": "string", "required": false, "description": "仅在实例为主实例或者灾备实例时生效，可选值：slave，代表拉取从机的日志。", "example": "slave" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeInstanceAlarmEvents", "description": "本接口（DescribeInstanceAlarmEvents）用于查询实例发生的事件信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-0mu6taqx" }, { "name": "StartTime", "type": "string", "required": true, "description": "事件查询范围开始时间，闭区间。", "example": "2024-01-15 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "事件查询范围截止时间，闭区间。", "example": "2024-01-30 00:00:00" }, { "name": "EventName", "type": "array", "required": false, "description": "事件名称。 Outofmemory - 内存OOM（有状态事件）; Switch - 主从切换（有状态事件）; Roremove - 只读实例剔除（有状态事件）; MemoryUsedHigh - 内存使用率过高（有状态事件）; CPUExpansion - CPU性能扩容（无状态事件）; CPUExpansionFailed - CPU性能扩容失败（无状态事件）; CPUContraction - CPU性能回缩（无状态事件）; Restart - 实例重启（有状态事件）; ServerFailureNodeMigration - ServerFailureNodeMigration（有\ufffd\ufffd...", "example": "[\"Switch\"]", "item_type": "string" }, { "name": "EventStatus", "type": "string", "required": false, "description": "事件状态。\"1\" - 发生事件；\"0\" - 恢复事件；\"-\" - 无状态事件。", "example": "1" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式。按事件发生事件进行排序，\"DESC\"-倒排；”ASC“-正序，默认倒排。", "example": "DESC" }, { "name": "Limit", "type": "string", "required": false, "description": "事件展示数量。默认为100，最大为200。", "example": "10" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量。", "example": "0" }, { "name": "NodeId", "type": "string", "required": false, "description": "节点 ID。", "example": "dbn-it3iv15s" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeInstanceParamRecords", "description": "该接口（DescribeInstanceParamRecords）用于查询实例参数修改历史。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-f35wr6wj" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认值：20，最大值为100。", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParams", "description": "该接口（DescribeInstanceParams）用于查询实例的参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-ezq1vzem" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstancePasswordComplexity", "description": "该接口（DescribeInstancePasswordComplexity）用于查询实例的密码复杂度参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "\"cdb-1urqrvpf\"" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceUpgradeCheckJob", "description": "该接口（DescribeInstanceUpgradeCheckJob）查询实例版本升级校验任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "\"cdb-g3rbtabc\"" }, { "name": "DstMysqlVersion", "type": "string", "required": true, "description": "目标数据库版本。 说明：可选值5.6、5.7、8.0，不支持跨版本升级，升级后不支持版本降级。", "example": "\"8.0\"" } ], "required": [ "InstanceId", "DstMysqlVersion" ] }, { "name": "DescribeInstanceUpgradeType", "description": "本接口（DescribeInstanceUpgradeType）用于查询数据库实例升级类型。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-2wpip1dd" }, { "name": "DstCpu", "type": "float", "required": true, "description": "目标实例 CPU 的核数。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的 CPU 值范围。", "example": "2.0" }, { "name": "DstMemory", "type": "integer", "required": true, "description": "目标实例内存大小，单位：MB。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的内存大小范围。", "example": "4000" }, { "name": "DstDisk", "type": "integer", "required": true, "description": "目标实例磁盘大小，单位：GB。为保证传入值有效，请使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取实例可售卖的磁盘大小范围。", "example": "1000" }, { "name": "DstVersion", "type": "string", "required": false, "description": "目标实例数据库版本。可选值：5.6，5.7，8.0。", "example": "5.7" }, { "name": "DstDeployMode", "type": "integer", "required": false, "description": "目标实例部署模型。默认为0，支持值包括：0 - 表示单可用区，1 - 表示多可用区。", "example": "0" }, { "name": "DstProtectMode", "type": "integer", "required": false, "description": "目标实例复制类型，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。", "example": "0" }, { "name": "DstSlaveZone", "type": "integer", "required": false, "description": "目标实例备机1可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。", "example": "100001" }, { "name": "DstBackupZone", "type": "integer", "required": false, "description": "目标实例备机2可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。", "example": "100001" }, { "name": "DstCdbType", "type": "string", "required": false, "description": "目标实例类型。支持值包括：\"CUSTOM\" - 通用型实例，\"EXCLUSIVE\" - 独享型实例，\"ONTKE\" - ONTKE 单节点实例，\"CLOUD_NATIVE_CLUSTER\" - 云盘版标准型，\"CLOUD_NATIVE_CLUSTER_EXCLUSIVE\" - 云盘版加强型。", "example": "CUSTOM" }, { "name": "DstZoneId", "type": "integer", "required": false, "description": "目标实例主可用区 ID。可使用 [DescribeCdbZoneConfig](https://cloud.tencent.com/document/product/236/80281) 获取可用区 ID。", "example": "100001" }, { "name": "NodeDistribution", "type": "object", "required": false, "description": "独享集群 CDB 实例的节点分布情况。", "example": "无", "children": [ { "name": "Node", "type": "string", "required": true, "description": "主实例Master节点所在主机ID或者只读实例所在主机ID", "example": "dch-fexbu7pp" }, { "name": "SlaveNodeOne", "type": "string", "required": true, "description": "主实例第一Slave节点所在主机ID", "example": "dch-cawss6q" }, { "name": "SlaveNodeTwo", "type": "string", "required": true, "description": "主实例第二Slave节点所在主机ID", "example": "dch-bsxj39l" } ] }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版的节点拓扑配置。Nodeld 信息可通过 [DescribeClusterInfo](https://cloud.tencent.com/document/api/236/105116) 接口获取。", "example": "无", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] } ], "required": [ "InstanceId", "DstCpu", "DstMemory", "DstDisk" ] }, { "name": "DescribeLocalBinlogConfig", "description": "该接口用于查询实例本地binlog保留策略。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同。", "example": "cdb-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeParamTemplateInfo", "description": "该接口（DescribeParamTemplateInfo）用于查询参数模板详情。 说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "参数模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。", "example": "233" } ], "required": [ "TemplateId" ] }, { "name": "DescribeParamTemplates", "description": "该接口（DescribeParamTemplates）查询参数模板列表。 说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。", "status": "online", "parameters": [ { "name": "EngineVersions", "type": "array", "required": false, "description": "引擎版本，缺省则查询所有。可取值为：5.5、5.6、5.7、8.0。", "example": "[\"5.5\"]", "item_type": "string" }, { "name": "EngineTypes", "type": "array", "required": false, "description": "引擎类型，缺省则查询所有。可取值为：InnoDB、RocksDB，不区分大小写。", "example": "[\"innodb\"]", "item_type": "string" }, { "name": "TemplateNames", "type": "array", "required": false, "description": "模板名称，缺省则查询所有。支持模糊匹配。", "example": "[\"5.7\"]", "item_type": "string" }, { "name": "TemplateIds", "type": "array", "required": false, "description": "模板 ID，缺省则查询所有。", "example": "[17008]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。", "example": "11954" } ], "required": [] }, { "name": "DescribeProxyCustomConf", "description": "查询代理规格配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-2wpip1dd" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "100" } ], "required": [ "InstanceId" ] }, { "name": "DescribeProxySupportParam", "description": "本接口（DescribeProxySupportParam）用于查询实例支持代理版本和参数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-aykuksx3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRemoteBackupConfig", "description": "本接口(DescribeRemoteBackupConfig)用于查询数据库异地备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRoGroups", "description": "本接口（DescribeRoGroups）用于查询云数据库实例的所有的 RO 组的信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-eggz8oj5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRoMinScale", "description": "本接口(DescribeRoMinScale)用于获取只读实例购买、升级时的最小规格。", "status": "online", "parameters": [ { "name": "RoInstanceId", "type": "string", "required": false, "description": "只读实例ID，格式如：cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，该参数与MasterInstanceId参数不能同时为空。", "example": "cdbro-831kwfnh" }, { "name": "MasterInstanceId", "type": "string", "required": false, "description": "主实例ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，该参数与RoInstanceId参数不能同时为空。注意，当传入参数包含RoInstanceId时，返回值为只读实例升级时的最小规格；当传入参数只包含MasterInstanceId时，返回值为只读实例购买时的最小规格。", "example": "cdb-r66ityd5" } ], "required": [] }, { "name": "DescribeRollbackRangeTime", "description": "本接口(DescribeRollbackRangeTime)用于查询云数据库实例可回档的时间范围。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，单个实例 ID 的格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "[\"cdb-fix44sxh\",\"cdb-bdf7h3j1\"]", "item_type": "string" }, { "name": "IsRemoteZone", "type": "string", "required": false, "description": "克隆实例与源实例是否在异地可用区，是:\"true\"，否:\"false\"", "example": "false" }, { "name": "BackupRegion", "type": "string", "required": false, "description": "克隆实例与源实例不在同一地域时需填写克隆实例所在地域，例：\"ap-guangzhou\"", "example": "ap-guangzhou" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeRollbackTaskDetail", "description": "本接口（DescribeRollbackTaskDetail）用于查询云数据库实例回档任务详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872)。", "example": "cdb-qwer1234" }, { "name": "AsyncRequestId", "type": "string", "required": false, "description": "异步任务 ID。", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数，每次请求返回的记录数。默认值为20，建议最大取值为100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。默认为 0。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSSLStatus", "description": "本接口（DescribeSSLStatus）用于查询 SSL 开通情况。如果已经开通 SSL ，会同步返回证书下载链接。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 说明：实例 ID 和只读组 ID 两个参数选其一填写即可。若要查询双节点、三节点实例 SSL 开通情况，请填写实例 ID 参数进行查询。单节点（云盘）、云盘版实例不支持开启 SSL，因此不支持查询。", "example": "cdb-test" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读组 ID。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。 说明：实例 ID 和只读组 ID 两个参数选其一填写即可。若要查询只读实例或只读组 SSL 开通情况，请填写 RoGroupId 参数，并注意填写的都是只读组 ID。单节点（云盘）、云盘版实例不支持开启 SSL，因此不支持查询。", "example": "cdbrg-test" } ], "required": [] }, { "name": "DescribeSlowLogData", "description": "本接口（DescribeSlowLogData）用于使用条件检索实例的慢日志。只允许查看一个月之内的慢日志。 使用时需要注意：可能存在单条慢日志太大，导致整个http请求的回包太大，进而引发接口超时。一旦发生超时，建议您缩小查询时的Limit参数值，从而降低包的大小，让接口能够及时返回内容。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-c1nl9rpv" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间戳。例如 1585142640。 说明：此参数单位为秒的时间戳。", "example": "1585142640" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间戳。例如 1585142640。 说明：此参数单位为秒的时间戳。", "example": "1585142640" }, { "name": "UserHosts", "type": "array", "required": false, "description": "客户端 Host 列表。", "example": "[\"userhosts\"]", "item_type": "string" }, { "name": "UserNames", "type": "array", "required": false, "description": "客户端 用户名 列表。", "example": "[\"usename\"]", "item_type": "string" }, { "name": "DataBases", "type": "array", "required": false, "description": "访问的 数据库 列表。", "example": "[\"database\"]", "item_type": "string" }, { "name": "SortBy", "type": "string", "required": false, "description": "排序字段，当前支持字段及含义如下，默认值为 Timestamp。 1. Timestamp：SQL 的执行时间 2. QueryTime：SQL 的执行时长（秒） 3. LockTime：锁时长（秒） 4. RowsExamined：扫描行数 5. RowsSent：结果集行数", "example": "RowsSent" }, { "name": "OrderBy", "type": "string", "required": false, "description": "升序还是降序排列。当前支持值为 ASC - 升序，DESC - 降序 ，默认值为 ASC。", "example": "DESC" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0，最大为9999。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "一次性返回的记录数量，默认为100，最大为800。", "example": "400" }, { "name": "InstType", "type": "string", "required": false, "description": "仅在实例为主实例或者灾备实例时生效，可选值：slave，代表拉取从机的日志。", "example": "master" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "节点ID", "example": "dbn-j57njp5s" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSlowLogs", "description": "本接口（DescribeSlowLogs）用于获取云数据库实例的慢查询日志。 说明：若单次查询数据量过大，则有可能响应超时，建议缩短单次查询时间范围，如一小时，避免导致超时。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0，最小值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认值为20，最小值为1，最大值为1000。", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSupportedPrivileges", "description": "本接口(DescribeSupportedPrivileges)用于查询云数据库的支持的权限信息，包括全局权限，数据库权限，表权限以及列权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "DescribeTableColumns", "description": "本接口（DescribeTableColumns）用于查询云数据库实例的指定数据库表的列信息，仅支持主实例和灾备实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-c1nl9rpv" }, { "name": "Database", "type": "string", "required": true, "description": "数据库名称，可使用 [查询数据库](https://cloud.tencent.com/document/api/236/17493) 接口获得。", "example": "test_data_base" }, { "name": "Table", "type": "string", "required": true, "description": "数据库中的表的名称。", "example": "test_table" } ], "required": [ "InstanceId", "Database", "Table" ] }, { "name": "DescribeTables", "description": "本接口(DescribeTables)用于查询云数据库实例的数据库表信息，仅支持主实例和灾备实例，不支持只读实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "Database", "type": "string", "required": true, "description": "数据库的名称。", "example": "test_data_base" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为20，最大值为5000。", "example": "100" }, { "name": "TableRegexp", "type": "string", "required": false, "description": "匹配数据库表名的正则表达式，规则同 MySQL 官网", "example": "^table.*" } ], "required": [ "InstanceId", "Database" ] }, { "name": "DescribeTagsOfInstanceIds", "description": "本接口（DescribeTagsOfInstanceIds）用于获取云数据库实例的标签信息。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例列表。实例 ID 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。可传入的数组长度暂无限制。", "example": "[\"cdb-uns231ns\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小。默认为15。", "example": "10" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeTasks", "description": "本接口(DescribeTasks)用于查询云数据库实例任务列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-c1nl9rpv" }, { "name": "AsyncRequestId", "type": "string", "required": false, "description": "异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。", "example": "a6040589-3b098df5-b551d9e5-81c6bfdc" }, { "name": "TaskTypes", "type": "array", "required": false, "description": "任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。", "example": "1", "item_type": "integer" }, { "name": "TaskStatus", "type": "array", "required": false, "description": "任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。", "example": "1", "item_type": "integer" }, { "name": "StartTimeBegin", "type": "string", "required": false, "description": "第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。", "example": "2017-12-31 10:40:01" }, { "name": "StartTimeEnd", "type": "string", "required": false, "description": "最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。", "example": "2017-12-31 10:40:01" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeTimeWindow", "description": "本接口(DescribeTimeWindow)用于查询云数据库实例的维护时间窗口。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-c1nl9rpv或者cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。", "example": "cdb-eb2w7dto" } ], "required": [ "InstanceId" ] }, { "name": "DescribeUploadedFiles", "description": "本接口(DescribeUploadedFiles)用于查询用户导入的SQL文件列表，全地域公共参数Region均为ap-shanghai。", "status": "online", "parameters": [ { "name": "Path", "type": "string", "required": true, "description": "文件路径。该字段应填用户主账号的OwnerUin信息。", "example": "100000983328" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次请求返回的数量，默认值为20。", "example": "1" } ], "required": [ "Path" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组 ID。可通过 [DescribeDBSecurityGroups](https://cloud.tencent.com/document/api/236/15854) 接口获取。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，一个或者多个实例 ID 组成的数组。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "[\"cdb-eb2w7dto\"]", "item_type": "string" }, { "name": "ForReadonlyInstance", "type": "boolean", "required": false, "description": "当传入只读实例 ID 时，默认操作的是对应只读组的安全组。如果需要操作只读实例 ID 的安全组，需要将该入参置为 True，默认为 False。", "example": "False" } ], "required": [ "SecurityGroupId", "InstanceIds" ] }, { "name": "InquiryPriceUpgradeInstances", "description": "本接口（InquiryPriceUpgradeInstances）用于查询云数据库实例升级的价格，支持查询按量计费或者包年包月实例的升级价格，实例类型支持主实例、灾备实例和只读实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-***" }, { "name": "Memory", "type": "integer", "required": true, "description": "升级后的内存大小，单位：MB，为保证传入 Memory 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。", "example": "1000" }, { "name": "Volume", "type": "integer", "required": true, "description": "升级后的硬盘大小，单位：GB，为保证传入 Volume 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。", "example": "50" }, { "name": "Cpu", "type": "integer", "required": false, "description": "升级后的核心数目，单位：核，为保证传入 CPU 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的核心数目，当未指定该值时，将按照 Memory 大小补全一个默认值。", "example": "1" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，支持值包括：0 - 异步复制，1 - 半同步复制，2 - 强同步复制，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。", "example": "0" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例隔离类型。支持值包括： \"UNIVERSAL\" - 通用型实例， \"EXCLUSIVE\" - 独享型实例， \"BASIC\" - 基础版实例。 不指定则默认为通用型实例。", "example": "UNIVERSAL" }, { "name": "InstanceNodes", "type": "integer", "required": false, "description": "实例节点数。对于 RO 和 基础版实例， 该值默认为1。 如果需要询价三节点实例， 请将该值设置为3。其余主实例该值默认为2。", "example": "2" } ], "required": [ "InstanceId", "Memory", "Volume" ] }, { "name": "IsolateDBInstance", "description": "本接口（IsolateDBInstance）用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-ezq1vzem" } ], "required": [ "InstanceId" ] }, { "name": "ModifyAccountDescription", "description": "本接口(ModifyAccountDescription)用于修改云数据库账户的备注信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Accounts", "type": "array", "required": true, "description": "云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "andy", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] }, { "name": "Description", "type": "string", "required": false, "description": "数据库账号的备注信息。最多支持输入255个字符。", "example": "new" } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyAccountHost", "description": "本接口(ModifyAccountHost)用于修改云数据库账户的主机。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "User", "type": "string", "required": true, "description": "账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账户的旧主机。格式：IP 形式，支持单个 IP 地址或者%。", "example": "172.1.1.1" }, { "name": "NewHost", "type": "string", "required": true, "description": "账户的新主机。格式：IP 形式，支持单个 IP 地址或者%。", "example": "172.1.1.2" } ], "required": [ "InstanceId", "User", "Host", "NewHost" ] }, { "name": "ModifyAccountMaxUserConnections", "description": "本接口（ModifyAccountMaxUserConnections）用于修改云数据库账户最大可用连接数。", "status": "online", "parameters": [ { "name": "Accounts", "type": "array", "required": true, "description": "云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "andy", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "MaxUserConnections", "type": "integer", "required": true, "description": "设置账户最大可用连接数，最大可设置值为10240。", "example": "1" } ], "required": [ "Accounts", "InstanceId", "MaxUserConnections" ] }, { "name": "ModifyAccountPassword", "description": "本接口(ModifyAccountPassword)用于修改云数据库账户的密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "NewPassword", "type": "string", "required": true, "description": "数据库账号的新密码。密码应至少包含字母、数字和字符（_+-\u0026=!@#$%^*()）中的两种，长度为8-64个字符。", "example": "Gx18ux23F^X" }, { "name": "Accounts", "type": "array", "required": true, "description": "云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] } ], "required": [ "InstanceId", "NewPassword", "Accounts" ] }, { "name": "ModifyAccountPrivileges", "description": "本接口(ModifyAccountPrivileges)用于修改云数据库的账户的权限信息。 注意，修改账号权限时，需要传入该账号下的全量权限信息。用户可以先通过 [查询云数据库账户的权限信息 ](https://cloud.tencent.com/document/api/236/17500) 查询该账号下的全量权限信息，然后进行权限修改。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Accounts", "type": "array", "required": true, "description": "数据库的账号，包括用户名和域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。", "example": "[{\"User\": \"andy\",\"Host\": \"%\"}]", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账号名，可输入1 - 32个字符。", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "账号的主机。 说明： 1. IP 形式，支持填入%。 2. 多个主机以分隔符分隔，分隔符支持;,|换行符和空格。", "example": "172.1.1.1" } ] }, { "name": "GlobalPrivileges", "type": "array", "required": false, "description": "全局权限。其中，GlobalPrivileges 中权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"PROCESS\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"SHOW DATABASES\",\"CREATE TEMPORARY TABLES\",\"LOCK TABLES\",\"EXECUTE\",\"CREATE VIEW\",\"SHOW VIEW\",\"CREATE ROUTINE\",\"ALTER ROUTINE\",\"EVENT\",\"TRIGGER\",\"CREATE USER\",\"RELOAD\",\"REPLICATION CLIENT\",\"REPLICATION SLAVE\"。 注意，ModifyAction为空时，不传该参数表示清除该权限。", "example": "[\"SELECT\"]", "item_type": "string" }, { "name": "DatabasePrivileges", "type": "array", "required": false, "description": "数据库的权限。Privileges 权限的可选值为：\"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\"。 注意，ModifyAction为空时，不传该参数表示清除该权限。", "example": "[\"SELECT\",\"INSERT\"]", "item_type": "object", "children": [ { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"CREATE\",\"DROP\"]", "item_type": "string" }, { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "db1" } ] }, { "name": "TablePrivileges", "type": "array", "required": false, "description": "数据库中表的权限。Privileges 权限的可选值为：权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"CREATE VIEW\",\"SHOW VIEW\", \"TRIGGER\"。 注意，ModifyAction为空时，不传该参数表示清除该权限。", "example": "[\"SELECT\",\"INSERT\"]", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "Table", "type": "string", "required": true, "description": "数据库表名", "example": "table1" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[{\"Table\": \"user\",\"Privileges\": [\"SELECT\",\"INSERT\"],\"Database\": \"mysql\"}]", "item_type": "string" } ] }, { "name": "ColumnPrivileges", "type": "array", "required": false, "description": "数据库表中列的权限。Privileges 权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"REFERENCES\"。 注意，ModifyAction为空时，不传该参数表示清除该权限。", "example": "[\"SELECT\",\"INSERT\"]", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "Table", "type": "string", "required": true, "description": "数据库表名", "example": "andy_table1" }, { "name": "Column", "type": "string", "required": true, "description": "数据库列名", "example": "user_email_address" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"SELECT\",\"INSERT\"]", "item_type": "string" } ] }, { "name": "ModifyAction", "type": "string", "required": false, "description": "该参数不为空时，为批量修改权限。可选值为：grant - 授予权限，revoke - 回收权限。", "example": "grant " } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyAuditConfig", "description": "本接口(ModifyAuditConfig)用于修改云数据库审计策略的服务配置，包括审计日志保存时长等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-txcniupi" }, { "name": "LogExpireDay", "type": "integer", "required": false, "description": "审计日志保存时长。支持值包括： 7 - 一周 30 - 一个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年；", "example": "365" }, { "name": "CloseAudit", "type": "boolean", "required": false, "description": "是否关闭审计服务。可选值：true - 关闭审计服务；false - 不关闭审计服务。默认值为 false。 说明： 1. 当关闭审计服务时，会删除用户的审计日志和文件，并删除该实例的所有审计策略。 2. CloseAudit、LogExpireDay 必须至少提供一个，如果两个都提供则按照 CloseAudit 优先的逻辑处理。 3. 可通过设置此参数来关闭审计服务，已关闭后不能通过此接口来开启审计服务。", "example": "true" }, { "name": "HighLogExpireDay", "type": "integer", "required": false, "description": "高频审计日志保存时长。支持值包括： 7 - 一周 30 - 一个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年；", "example": "7" } ], "required": [ "InstanceId" ] }, { "name": "ModifyAuditRule", "description": "不再支持审计规则创建 本接口(ModifyAuditRule)用于修改用户的审计规则。", "status": "deprecated", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "审计规则 ID。", "example": "cdbrule-234" }, { "name": "RuleName", "type": "string", "required": false, "description": "审计规则名称。", "example": "test" }, { "name": "Description", "type": "string", "required": false, "description": "审计规则描述。", "example": "audit_test2" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "审计规则过滤条件。若设置了过滤条件，则不会开启全审计。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤条件参数名称。目前支持： SrcIp – 客户端 IP； User – 数据库账户； DB – 数据库名称；", "example": "User" }, { "name": "Compare", "type": "string", "required": true, "description": "过滤条件匹配类型。目前支持： INC – 包含； EXC – 不包含； EQ – 等于； NEQ – 不等于；", "example": "INC" }, { "name": "Value", "type": "string", "required": true, "description": "过滤条件匹配值。", "example": "andy" } ] }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "是否开启全审计。支持值包括：false – 不开启全审计，true – 开启全审计。用户未设置审计规则过滤条件时，默认开启全审计。", "example": "true" } ], "required": [ "RuleId" ] }, { "name": "ModifyAuditRuleTemplates", "description": "修改审计规则模板", "status": "online", "parameters": [ { "name": "RuleTemplateIds", "type": "array", "required": true, "description": "审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。", "example": "cdb-art-l1mlbo59", "item_type": "string" }, { "name": "RuleFilters", "type": "array", "required": false, "description": "修改后的审计规则。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "审计规则过滤条件的参数名称。可选值：host – 客户端 IP；user – 数据库账户；dbName – 数据库名称；sqlType-SQL类型；sql-sql语句；affectRows -影响行数；sentRows-返回行数；checkRows-扫描行数；execTime-执行时间。", "example": "sqlType" }, { "name": "Compare", "type": "string", "required": true, "description": "审计规则过滤条件的匹配类型。可选值：INC – 包含；EXC – 不包含；EQS – 等于；NEQ – 不等于；REG-正则；GT-大于；LT-小于。", "example": "INC" }, { "name": "Value", "type": "array", "required": true, "description": "审计规则过滤条件的匹配值。sqlType条件的Value需在以下选择\"alter\", \"changeuser\", \"create\", \"delete\", \"drop\", \"execute\", \"insert\", \"login\", \"logout\", \"other\", \"replace\", \"select\", \"set\", \"update\"。", "example": "UPDATE", "item_type": "string" } ] }, { "name": "RuleTemplateName", "type": "string", "required": false, "description": "修改后的规则模板名称。", "example": "新规则模板名称" }, { "name": "Description", "type": "string", "required": false, "description": "修改后的规则模板描述。", "example": "新规则模板名称" }, { "name": "AlarmLevel", "type": "integer", "required": false, "description": "告警等级。1-低风险，2-中风险，3-高风险。", "example": "3" }, { "name": "AlarmPolicy", "type": "integer", "required": false, "description": "告警策略。0-不告警，1-告警。", "example": "1" } ], "required": [ "RuleTemplateIds" ] }, { "name": "ModifyAuditService", "description": "本接口(ModifyAuditService)用于修改云数据库审计日志保存时长、审计规则等服务配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-22dhn3e3" }, { "name": "LogExpireDay", "type": "integer", "required": false, "description": "日志保留时长。支持值包括： 7 - 一周； 30 - 一个月； 90 - 三个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年。", "example": "30" }, { "name": "HighLogExpireDay", "type": "integer", "required": false, "description": "高频日志保留时长。默认值为7，此项取值需小于等于 LogExpireDay，支持值包括： 3 - 3天； 7 - 一周； 30 - 一个月； 90 - 三个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年。", "example": "7" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "修改实例审计规则为全审计。", "example": "true" }, { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。", "example": "[\"cdb-art-nuf7e111\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "ModifyAutoRenewFlag", "description": "本接口（ModifyAutoRenewFlag）用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例的 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。 说明：可输入多个实例 ID 进行修改，json 格式如下。 [ \"cdb-30z11v8s\", \"cdb-93h11efg\" ]", "example": "cdb-f35wr6wj", "item_type": "string" }, { "name": "AutoRenew", "type": "integer", "required": true, "description": "自动续费标记，可取值的有：0 - 不自动续费，1 - 自动续费。", "example": "1" } ], "required": [ "InstanceIds", "AutoRenew" ] }, { "name": "ModifyBackupConfig", "description": "本接口（ModifyBackupConfig）用于修改数据库备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "ExpireDays", "type": "integer", "required": false, "description": "数据备份文件的保留时间，单位为天。 1. MySQL 双节点、三节点、云盘版数据备份文件可以保留7天 - 1830天。 2. MySQL 单节点（云盘）数据备份文件可以保留7天 - 30天。", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "(将废弃，建议使用 BackupTimeWindow 参数) 备份时间范围，格式为：02:00-06:00，起点和终点时间目前限制为整点，目前可以选择的范围为： 00:00-12:00，02:00-06:00，06：00-10：00，10:00-14:00，14:00-18:00，18:00-22:00，22:00-02:00。", "example": "02:00-06:00" }, { "name": "BackupMethod", "type": "string", "required": false, "description": "自动备份方式，仅支持：physical - 物理冷备", "example": "physical" }, { "name": "BinlogExpireDays", "type": "integer", "required": false, "description": "binlog 的保留时间，单位为天。 1. MySQL 双节点、三节点、云盘版日志备份文件可以保留7天 - 3650天。 2. MySQL 单节点（云盘）日志备份文件可以保留7天 - 30天。", "example": "8" }, { "name": "BackupTimeWindow", "type": "object", "required": false, "description": "备份时间窗，比如要设置每周二和周日 10:00-14:00之间备份，该参数如下：{\"Monday\": \"\", \"Tuesday\": \"10:00-14:00\", \"Wednesday\": \"\", \"Thursday\": \"\", \"Friday\": \"\", \"Saturday\": \"\", \"Sunday\": \"10:00-14:00\"} （注：可以设置一周的某几天备份，但是每天的备份时间需要设置为相同的时间段。 如果设置了该字段，将忽略StartTime字段的设置）", "example": "无", "children": [ { "name": "Monday", "type": "string", "required": false, "description": "周一的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Tuesday", "type": "string", "required": false, "description": "周二的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Wednesday", "type": "string", "required": false, "description": "周三的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Thursday", "type": "string", "required": false, "description": "周四的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Friday", "type": "string", "required": false, "description": "周五的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Saturday", "type": "string", "required": false, "description": "周六的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "Sunday", "type": "string", "required": false, "description": "周日的时间窗，格式如： 02:00-06:00", "example": "02:00-06:00" }, { "name": "BackupPeriodStrategy", "type": "string", "required": false, "description": "常规备份保留策略，weekly-按周备份，monthly-按月备份，默认为weekly", "example": "weekly" }, { "name": "Days", "type": "array", "required": false, "description": "如果设置为按月备份，需填入每月具体备份日期，相邻备份天数不得超过两天。例[1,4,7,9,11,14,17,19,22,25,28,30,31]", "example": "[1,4,7,9,11,14,17,19,22,25,28,30,31]", "item_type": "integer" }, { "name": "BackupPeriodTime", "type": "string", "required": false, "description": "月度备份时间窗，BackupPeriodStrategy为monthly时必填。格式如： 02:00-06:00", "example": "02:00-06:00" } ] }, { "name": "EnableBackupPeriodSave", "type": "string", "required": false, "description": "定期保留开关，off - 不开启定期保留策略，on - 开启定期保留策略，默认为off。", "example": "off" }, { "name": "EnableBackupPeriodLongTermSave", "type": "string", "required": false, "description": "长期保留开关,该字段功能暂未上线，可忽略。off - 不开启长期保留策略，on - 开启长期保留策略，默认为off，如果开启，则BackupPeriodSaveDays，BackupPeriodSaveInterval，BackupPeriodSaveCount参数无效", "example": "off" }, { "name": "BackupPeriodSaveDays", "type": "integer", "required": false, "description": "定期保留最长天数，最小值：90，最大值：3650，默认值：1080", "example": "1080" }, { "name": "BackupPeriodSaveInterval", "type": "string", "required": false, "description": "定期保留策略周期，可取值：weekly - 周，monthly - 月， quarterly - 季度，yearly - 年，默认为monthly", "example": "weekly" }, { "name": "BackupPeriodSaveCount", "type": "integer", "required": false, "description": "定期保留的备份数量，最小值为1，最大值不超过定期保留策略周期内常规备份个数，默认值为1", "example": "1" }, { "name": "StartBackupPeriodSaveDate", "type": "string", "required": false, "description": "定期保留策略周期起始日期，格式：YYYY-MM-dd HH:mm:ss", "example": "1970-01-01 00:00:01" }, { "name": "EnableBackupArchive", "type": "string", "required": false, "description": "是否开启数据备份归档策略，off-关闭，on-打开，如果不指定该入参， 则保持不变。", "example": "off" }, { "name": "BackupArchiveDays", "type": "integer", "required": false, "description": "数据备份归档起始天数，数据备份达到归档起始天数时进行归档，最小为180天，不得大于数据备份保留天数", "example": "30" }, { "name": "BinlogArchiveDays", "type": "integer", "required": false, "description": "日志备份归档起始天数，日志备份达到归档起始天数时进行归档，最小为180天，不得大于日志备份保留天数", "example": "30" }, { "name": "EnableBinlogArchive", "type": "string", "required": false, "description": "是否开启日志备份归档策略，off-关闭，on-打开，如果不指定该入参， 则保持不变。", "example": "off" }, { "name": "EnableBackupStandby", "type": "string", "required": false, "description": "是否开启数据备份标准存储策略，off-关闭，on-打开，如果不指定该入参， 则保持不变。", "example": "off" }, { "name": "BackupStandbyDays", "type": "integer", "required": false, "description": "数据备份标准存储起始天数，数据备份达到标准存储起始天数时进行转换，最小为30天，不得大于数据备份保留天数。如果开启备份归档，不得大于等于备份归档天数", "example": "30" }, { "name": "EnableBinlogStandby", "type": "string", "required": false, "description": "是否开启日志备份标准存储策略，off-关闭，on-打开，如果不指定该入参， 则保持不变。", "example": "off" }, { "name": "BinlogStandbyDays", "type": "integer", "required": false, "description": "日志备份标准存储起始天数，日志备份达到标准存储起始天数时进行转换，最小为30天，不得大于日志备份保留天数。如果开启备份归档，不得大于等于备份归档天数", "example": "30" } ], "required": [ "InstanceId" ] }, { "name": "ModifyBackupDownloadRestriction", "description": "该接口用于修改用户当前地域的备份文件限制下载来源，可以设置内外网均可下载、仅内网可下载，或内网指定的vpc、ip可以下载。", "status": "online", "parameters": [ { "name": "LimitType", "type": "string", "required": true, "description": "NoLimit 不限制,内外网都可以下载； LimitOnlyIntranet 仅内网可下载； Customize 用户自定义vpc:ip可下载。 只有该值为 Customize 时，才可以设置 LimitVpc 和 LimitIp 。", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持 In， 表示 LimitVpc 指定的vpc可以下载。默认为In。", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "In: 指定的ip可以下载； NotIn: 指定的ip不可以下载。 默认为In。", "example": "In" }, { "name": "LimitVpc", "type": "array", "required": false, "description": "限制下载的vpc设置。", "example": "[{\"Region\": \"ap-guangzhou\", \"VpcList\": [\"vpc-XX1\"] } ]", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "限制下载来源的地域。目前仅支持当前地域。", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": true, "description": "限制下载的vpc列表。", "example": "[\"vpc-XX1\", \"vpc-XX2\"]", "item_type": "string" } ] }, { "name": "LimitIp", "type": "array", "required": false, "description": "限制下载的ip设置", "example": "[\"1.2.3.4\",\"4.3.2.1\"]", "item_type": "string" } ], "required": [ "LimitType" ] }, { "name": "ModifyBackupEncryptionStatus", "description": "本接口(ModifyBackupEncryptionStatus)用于设置实例备份文件是否加密。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-XXXX。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-XXXX" }, { "name": "EncryptionStatus", "type": "string", "required": true, "description": "设置实例新增的自动物理备份文件默认加密状态。可选值为 on或者off。", "example": "on" }, { "name": "BinlogEncryptionStatus", "type": "string", "required": false, "description": "设置实例新增的自动日志备份文件默认加密状态。可选值为 on或者off。", "example": "on" } ], "required": [ "InstanceId", "EncryptionStatus" ] }, { "name": "ModifyCdbProxyAddressDesc", "description": "本接口（ModifyCdbProxyAddressDesc）用于修改代理地址描述信息。", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-ixw3ll2d" }, { "name": "ProxyAddressId", "type": "string", "required": true, "description": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxyaddr-ixw3ll2d" }, { "name": "Desc", "type": "string", "required": false, "description": "描述", "example": "一区代理" } ], "required": [ "ProxyGroupId", "ProxyAddressId" ] }, { "name": "ModifyCdbProxyAddressVipAndVPort", "description": "本接口（ModifyCdbProxyAddressVipAndVPort）用于修改数据库代理地址VPC信息。", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-ixw3ll2d" }, { "name": "ProxyAddressId", "type": "string", "required": true, "description": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxyaddr-ixw3ll2d" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "vpc-ixw3ll2d" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "subnet-ixw3ll2d" }, { "name": "Vip", "type": "string", "required": false, "description": "IP 地址。若不填写则自动分配子网下的可用 IP。", "example": "192.0.0.1" }, { "name": "VPort", "type": "integer", "required": false, "description": "端口。默认值3306，取值范围：1024 - 65535。", "example": "80" }, { "name": "ReleaseDuration", "type": "integer", "required": false, "description": "旧 IP 地址回收时间。单位：小时，默认值：24，取值范围：0 - 168。", "example": "10" } ], "required": [ "ProxyGroupId", "ProxyAddressId", "UniqVpcId", "UniqSubnetId" ] }, { "name": "ModifyCdbProxyParam", "description": "本接口（ModifyCdbProxyParam）用于配置数据库代理参数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-aykuksx3" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-ixw3ll2d" }, { "name": "ConnectionPoolLimit", "type": "integer", "required": true, "description": "连接池阈值。取值范围：大于0，小于等于300。 注意：如需使用数据库代理连接池能力，MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。", "example": "10" } ], "required": [ "InstanceId", "ProxyGroupId", "ConnectionPoolLimit" ] }, { "name": "ModifyDBInstanceLogToCLS", "description": "开启/关闭CDB慢日志、错误日志投递CLS", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-234rsta" }, { "name": "LogType", "type": "string", "required": true, "description": "日志类型。error：错误日志，slowlog：慢日志。", "example": "error" }, { "name": "Status", "type": "string", "required": true, "description": "投递状态。ON：开启，OFF：关闭。", "example": "ON" }, { "name": "CreateLogset", "type": "boolean", "required": false, "description": "是否需要创建日志集。默认为 false。", "example": "true" }, { "name": "Logset", "type": "string", "required": false, "description": "需要创建日志集时为日志集名称；选择已有日志集时，为日志集 ID。默认为空。 说明：当参数 Status 的值为 ON 时，Logset 和 LogTopic 参数必须填一个。", "example": "my_test" }, { "name": "CreateLogTopic", "type": "boolean", "required": false, "description": "是否需要创建日志主题。默认为 false。", "example": "true" }, { "name": "LogTopic", "type": "string", "required": false, "description": "需要创建日志主题时为日志主题名称；选择已有日志主题时，为日志主题 ID。默认为空。 说明：当参数 Status 的值为 ON 时，Logset 和 LogTopic 参数必须填一个。", "example": "my_test" }, { "name": "Period", "type": "integer", "required": false, "description": "日志主题有效期，不填写时，默认30天，最大值3600。", "example": "30" }, { "name": "CreateIndex", "type": "boolean", "required": false, "description": "创建日志主题时，是否创建索引，默认为 false。", "example": "true" }, { "name": "ClsRegion", "type": "string", "required": false, "description": "CLS 所在地域，不填择默认为 Region 的参数值。", "example": "ap-guangzhou" } ], "required": [ "InstanceId", "LogType", "Status" ] }, { "name": "ModifyDBInstanceModes", "description": "该接口（ModifyDBInstanceModes）用于更改云数据库的模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。", "example": "cdb-eb2w7dto" }, { "name": "Mode", "type": "string", "required": true, "description": "云数据库的模式，目前仅支持传入 \"protectMode\" 表示修改主从同步方式。", "example": "protectMode" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据同步方式，可选值：0-异步复制，1-半同步复制，2-强同步复制。", "example": "1" } ], "required": [ "InstanceId", "Mode" ] }, { "name": "ModifyDBInstanceName", "description": "本接口(ModifyDBInstanceName)用于修改云数据库实例的名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-f35wr6wj" }, { "name": "InstanceName", "type": "string", "required": true, "description": "修改后的实例名称，仅支持数字,英文大小写字母、中文以及特殊字符-_./()[]（）+=:：@ 且长度不能超过60。", "example": "我是中文" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyDBInstanceProject", "description": "本接口(ModifyDBInstanceProject)用于修改云数据库实例的所属项目。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。 说明：可输入多个实例 ID 进行修改，json 格式如下。 [ \"cdb-30z11v8s\", \"cdb-93h11efg\" ]", "example": "cdb-f35wr6wj", "item_type": "string" }, { "name": "NewProjectId", "type": "integer", "required": false, "description": "实例所属项目的 ID，可在账号中心下的项目管理页面查询。 说明：此项为必填。", "example": "11954" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyDBInstanceReadOnlyStatus", "description": "本接口（ModifyDBInstanceReadOnlyStatus）用户设置MySQL云数据库实例为只读", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同，可使用[查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-uns231ns" }, { "name": "ReadOnly", "type": "integer", "required": true, "description": "是否设置为只读。其中：1表示设置实例为只读，0表示解除只读状态", "example": "0" } ], "required": [ "InstanceId", "ReadOnly" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-eb2w7dto" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。可通过 [DescribeDBSecurityGroups](https://cloud.tencent.com/document/product/236/15854) 接口获取。输入的安全组 ID 数组无长度限制。 注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" }, { "name": "ForReadonlyInstance", "type": "boolean", "required": false, "description": "当传入只读实例 ID 时，默认操作的是对应只读组的安全组。如果需要操作只读实例 ID 的安全组， 需要将该入参置为 True。默认为 False。", "example": "false" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "变更云盘版实例只读组时，InstanceId 传实例 ID，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。", "example": "cdb-xxx|readonly" } ], "required": [ "InstanceId", "SecurityGroupIds" ] }, { "name": "ModifyDBInstanceVipVport", "description": "本接口（ModifyDBInstanceVipVport）用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c2nl9rpv 或者 cdbrg-c3nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-f35wr6wj" }, { "name": "DstIp", "type": "string", "required": false, "description": "目标 IP。", "example": "10.0.1.1" }, { "name": "DstPort", "type": "integer", "required": false, "description": "目标端口，支持范围为：[1024-65535]。", "example": "1025" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "私有网络统一 ID。", "example": "vpc-73o91172" }, { "name": "UniqSubnetId", "type": "string", "required": false, "description": "子网统一 ID。", "example": "subnet-o2g4e1dh" }, { "name": "ReleaseDuration", "type": "integer", "required": false, "description": "进行基础网络转 VPC 网络和 VPC 网络下的子网变更时，原网络中旧IP的回收时间，单位为小时，取值范围为0-168，默认值为24小时。", "example": "24" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。", "example": "cdb-xxx|readonly" } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstanceParam", "description": "本接口(ModifyInstanceParam)用于修改云数据库实例的参数。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "[\"cdb-atjl8gns\"]", "item_type": "string" }, { "name": "ParamList", "type": "array", "required": false, "description": "要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名，CurrentValue 是要修改成的值。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": false, "description": "参数值", "example": "1" } ] }, { "name": "TemplateId", "type": "integer", "required": false, "description": "模板 ID，ParamList 和 TemplateId 必须至少传其中之一。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。", "example": "99" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "执行参数调整任务的方式，默认为 0。支持值包括：0 - 立刻执行，1 - 时间窗执行；当该值为 1 时，每次只能传一个实例（InstanceIds数量为1）", "example": "0" }, { "name": "NotSyncRo", "type": "boolean", "required": false, "description": "参数是否同步到主实例下的只读实例。true 为不同步，false 为同步。默认为 false。", "example": "true" }, { "name": "NotSyncDr", "type": "boolean", "required": false, "description": "参数是否同步到主实例下的灾备实例。true 为不同步，false 为同步。默认为 false。", "example": "true" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyInstancePasswordComplexity", "description": "本接口（ModifyInstancePasswordComplexity）用于修改云数据库实例的密码复杂度。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "要修改密码复杂度的实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。 说明：支持输入多个实例 ID 进行修改。", "example": "[\"cdb-93hvfe1d\"]", "item_type": "string" }, { "name": "ParamList", "type": "array", "required": false, "description": "要修改的密码复杂度的选项。每一个选项是以组合形式写入的，一个组合包括 Name 和 CurrentValue，其中 Name 表示对应选项的参数名，CurrentValue 表示参数值。例如：[{\"Name\": \"validate_password.length\", \"CurrentValue\": \"10\"}]，表示将密码的最小字符数修改为10。 说明：不同数据库版本的实例，支持修改的密码复杂度的选项如下。 1. MySQL 8.0： 选项 validate_password.policy，表示密码复杂度的开关，值...", "example": "[{\"Name\": \"validate_password.length\",\"CurrentValue\": \"10\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": false, "description": "参数值", "example": "1" } ] } ], "required": [ "InstanceIds" ] }, { "name": "ModifyInstanceTag", "description": "本接口(ModifyInstanceTag)用于对实例标签进行添加、修改或者删除。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-uns231ns" }, { "name": "ReplaceTags", "type": "array", "required": false, "description": "要增加或修改的标签。ReplaceTags 和 DeleteTags 必填一个。", "example": "[{\"TagKey\": \"march\",\"TagValue\": \"march1\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签值", "example": "[\"zhang\",\"li\"]", "item_type": "string" } ] }, { "name": "DeleteTags", "type": "array", "required": false, "description": "要删除的标签。ReplaceTags 和 DeleteTags 必填一个。", "example": "[{\"TagKey\": \"andy\",\"TagValue\": \"andy1\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签值", "example": "[\"zhang\",\"li\"]", "item_type": "string" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyLocalBinlogConfig", "description": "本接口（ModifyLocalBinlogConfig）用于修改实例本地 binlog 保留策略。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "SaveHours", "type": "integer", "required": true, "description": "本地 binlog 保留时长。不同实例的可取值如下： 1. 云盘版实例、双节点实例、三节点实例的本地 binlog 保留时长（小时）默认为120，范围：6 - 168。 2. 灾备实例的本地 binlog 保留时长（小时）默认为120，范围：120 - 168。 3. 单节点云盘实例的本地 binlog 保留时长（小时）默认为120，范围：0 - 168。 4. 若双节点实例、三节点实例下无灾备实例，则该主实例的本地 binlog 保留时长（小时\ufffd...", "example": "100" }, { "name": "MaxUsage", "type": "integer", "required": true, "description": "本地 binlog 空间使用率，可取值范围：[30,50]。", "example": "30" } ], "required": [ "InstanceId", "SaveHours", "MaxUsage" ] }, { "name": "ModifyNameOrDescByDpId", "description": "修改置放群组的名称或者描述", "status": "online", "parameters": [ { "name": "DeployGroupId", "type": "string", "required": true, "description": "置放群组 ID。", "example": "172837" }, { "name": "DeployGroupName", "type": "string", "required": false, "description": "置放群组名称，最长不能超过60个字符。置放群组名和置放群组描述不能都为空。", "example": "cdb-ezq1vzem" }, { "name": "Description", "type": "string", "required": false, "description": "置放群组描述，最长不能超过200个字符。置放群组名和置放群组描述不能都为空。", "example": "一区群组" } ], "required": [ "DeployGroupId" ] }, { "name": "ModifyParamTemplate", "description": "该接口（ModifyParamTemplate）用于修改参数模板。 说明：参数模板为公共组件，配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。可通过 [DescribeParamTemplates](https://cloud.tencent.com/document/api/236/32659) 接口获取。", "example": "11231" }, { "name": "Name", "type": "string", "required": false, "description": "模板名称，仅支持数字、英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@,且长度不能超过60。", "example": "andy5.7" }, { "name": "Description", "type": "string", "required": false, "description": "模板描述，长度不超过255。", "example": "andy使用" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "auto_increment_increment" }, { "name": "CurrentValue", "type": "string", "required": false, "description": "参数值", "example": "1" } ] } ], "required": [ "TemplateId" ] }, { "name": "ModifyProtectMode", "description": "该接口（ModifyProtectMode）用于修改实例的同步方式。 说明：仅专属集群可调用，该接口即将下线。", "status": "online", "parameters": [ { "name": "ProtectMode", "type": "integer", "required": true, "description": "数据复制方式，默认为 0，支持值包括：0 - 表示异步复制，1 - 表示半同步复制，2 - 表示强同步复制。", "example": "1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "cdb-ezq1vzem" } ], "required": [ "ProtectMode", "InstanceId" ] }, { "name": "ModifyRemoteBackupConfig", "description": "本接口(ModifyRemoteBackupConfig)用于修改数据库异地备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "RemoteBackupSave", "type": "string", "required": true, "description": "异地数据备份开关，off - 关闭异地备份，on-开启异地备份", "example": "on" }, { "name": "RemoteBinlogSave", "type": "string", "required": true, "description": "异地日志备份开关，off - 关闭异地备份，on-开启异地备份，只有在参数RemoteBackupSave为on时，RemoteBinlogSave参数才可设置为on", "example": "on" }, { "name": "RemoteRegion", "type": "array", "required": true, "description": "用户设置异地备份地域列表", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "ExpireDays", "type": "integer", "required": true, "description": "异地备份保留时间，单位为天", "example": "7" } ], "required": [ "InstanceId", "RemoteBackupSave", "RemoteBinlogSave", "RemoteRegion", "ExpireDays" ] }, { "name": "ModifyRoGroupInfo", "description": "本接口（ModifyRoGroupInfo）用于更新云数据库只读组的信息。包括设置实例延迟超限剔除策略，设置只读实例读权重，设置复制延迟时间等。", "status": "online", "parameters": [ { "name": "RoGroupId", "type": "string", "required": true, "description": "RO 组的 ID。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。", "example": "cdbrg-iup41a4t" }, { "name": "RoGroupInfo", "type": "object", "required": false, "description": "RO 组的详细信息。", "example": "{\"RoOfflineDelay\": 1,\"MinRoInGroup\": 1,\"RoMaxDelayTime\": 10}", "children": [ { "name": "RoGroupName", "type": "string", "required": false, "description": "RO 组名称。", "example": "test_rogroup" }, { "name": "RoMaxDelayTime", "type": "integer", "required": false, "description": "RO 实例最大延迟阈值。单位为秒，最小值为 1。范围：[1,10000]，整数。 注意：RO 组必须设置了开启实例延迟剔除策略，该值才有效。", "example": "10" }, { "name": "RoOfflineDelay", "type": "integer", "required": false, "description": "是否开启实例延迟剔除。支持的值包括：1 - 开启；0 - 不开启。注意，若设置开启实例延迟剔除，则必须设置延迟阈值（RoMaxDelayTime）参数。", "example": "1" }, { "name": "MinRoInGroup", "type": "integer", "required": false, "description": "最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。 注意：若设置值大于 RO 实例数量将不做剔除；若设置为 0，所有实例延迟超限都会被剔除。", "example": "1" }, { "name": "WeightMode", "type": "string", "required": false, "description": "权重模式。支持值包括：\"system\" - 系统自动分配； \"custom\" - 用户自定义设置。注意，若设置 \"custom\" 模式，则必须设置 RO 实例权重配置（RoWeightValues）参数。", "example": "system" }, { "name": "ReplicationDelayTime", "type": "integer", "required": false, "description": "延迟复制时间。单位：秒，范围：1 - 259200秒，不传此参数表示不开启实例延迟复制。", "example": "100" } ] }, { "name": "RoWeightValues", "type": "array", "required": false, "description": "RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式（custom），则必须设置该参数，且需要设置每个 RO 实例的权重值。RO 实例 ID 可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。", "example": " [{\"InstanceId\": \"cdbr0-test1234\",\"Weight\": 70},{\"InstanceId\": \"cdbr0-iup41a4t\",\"Weight\": 30}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "RO 实例 ID。", "example": "cdbro-khe2c111" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值。取值范围为 [0, 100]。", "example": "5" } ] }, { "name": "IsBalanceRoLoad", "type": "integer", "required": false, "description": "是否重新均衡 RO 组内的 RO 实例的负载。支持值包括：1 - 重新均衡负载；0 - 不重新均衡负载。默认值为 0。注意，设置为重新均衡负载时，RO 组内 RO 实例会有一次数据库连接瞬断，请确保应用程序能重连数据库。", "example": "1" } ], "required": [ "RoGroupId" ] }, { "name": "ModifyRoGroupVipVport", "description": "该接口（ModifyRoGroupVipVport）用于修改Ro组的vip和vport。", "status": "online", "parameters": [ { "name": "UGroupId", "type": "string", "required": true, "description": "RO组的ID。", "example": "cdbrg-***" }, { "name": "DstIp", "type": "string", "required": false, "description": "目标IP。", "example": "1.2.3.4" }, { "name": "DstPort", "type": "integer", "required": false, "description": "目标Port。", "example": "3307" } ], "required": [ "UGroupId" ] }, { "name": "ModifyTimeWindow", "description": "本接口(ModifyTimeWindow)用于更新云数据库实例的维护时间窗口。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-eb2w7dto" }, { "name": "TimeRanges", "type": "array", "required": true, "description": "修改后的可维护时间段，其中每一个时间段的格式形如：10:00-12:00；起止时间按半个小时对齐；最短半个小时，最长三个小时；最多设置两个时间段；起止时间范围为：[00:00, 24:00]。 说明：设置两个时间段的 json 示例如下。 [ \"01:00-01:30\", \"02:00-02:30\" ]", "example": "00:00-01:30", "item_type": "string" }, { "name": "Weekdays", "type": "array", "required": false, "description": "指定修改哪一天的可维护时间段，可能的取值为：monday，tuesday，wednesday，thursday，friday，saturday，sunday。如果不指定该值或者为空，则默认一周七天都修改。 说明：指定修改多天的 json 示例如下。 [ \"monday\", \"tuesday\" ]", "example": "monday", "item_type": "string" }, { "name": "MaxDelayTime", "type": "integer", "required": false, "description": "数据延迟阈值（秒），仅对主实例和灾备实例有效。不传默认不修改，保持原来的阈值，取值范围：1-10的整数。", "example": "10" } ], "required": [ "InstanceId", "TimeRanges" ] }, { "name": "OfflineIsolatedInstances", "description": "本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态，即通过 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询到 Status 值为 5 的实例。 该接口为异步操作，部分资源的回收可能存在延迟。您可以通过使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口，指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "[\"cdb-70zdmgg1\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "OpenAuditService", "description": "本接口（OpenAuditService）用 CDB 实例开通审计服务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-etxaaa12" }, { "name": "LogExpireDay", "type": "integer", "required": true, "description": "审计日志保存时长。支持值包括： 7 - 一周； 30 - 一个月； 90 - 三个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年。", "example": "30" }, { "name": "HighLogExpireDay", "type": "integer", "required": false, "description": "高频审计日志保存时长。默认值为7，此项取值需小于等于 LogExpireDay，支持值包括： 3 - 3天； 7 - 一周； 30 - 一个月； 90 - 三个月； 180 - 六个月； 365 - 一年； 1095 - 三年； 1825 - 五年。", "example": "7" }, { "name": "RuleTemplateIds", "type": "array", "required": false, "description": "规则模板 ID。", "example": "[\"cdb-art-l1mlbo59\"]", "item_type": "string" }, { "name": "AuditAll", "type": "boolean", "required": false, "description": "审计类型。true - 全审计；默认 false - 规则审计。", "example": "true" } ], "required": [ "InstanceId", "LogExpireDay" ] }, { "name": "OpenDBInstanceEncryption", "description": "本接口（OpenDBInstanceEncryption）用于启用实例数据存储加密功能，支持用户指定自定义密钥。 注意，启用实例数据存储加密之前，需要进行以下操作： 1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作； 2、开启 [KMS服务](https://console.cloud.tencent.com/kms2)； 3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role)，角色名为MySQL_QCSRole，预设策略名...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-qwer1234" }, { "name": "KeyId", "type": "string", "required": false, "description": "用户自定义密钥 ID，CMK 唯一标识符。该值为空时，将使用腾讯云自动生成的密钥 KMS-CDB。", "example": "KMS-CDB" }, { "name": "KeyRegion", "type": "string", "required": false, "description": "用户自定义密钥的存储地域。如：ap-guangzhou 。KeyId 不为空时，该参数必填。", "example": "ap-guangzhou" } ], "required": [ "InstanceId" ] }, { "name": "OpenDBInstanceGTID", "description": "本接口(OpenDBInstanceGTID)用于开启云数据库实例的 GTID，只支持版本为 5.6 以及以上的实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "OpenSSL", "description": "本接口（OpenSSL）用于开启 SSL 连接功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-je5egmdl" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。", "example": "cdbrg-k9a6gup3" } ], "required": [] }, { "name": "OpenWanService", "description": "本接口(OpenWanService)用于开通实例外网访问。 注意，实例开通外网访问之前，需要先将实例进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。", "example": "cdb-ezq1vzem" }, { "name": "OpResourceId", "type": "string", "required": false, "description": "变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。", "example": "cdb-xxx|readonly" } ], "required": [ "InstanceId" ] }, { "name": "ReleaseIsolatedDBInstances", "description": "本接口（ReleaseIsolatedDBInstances）用于恢复已隔离云数据库实例。仅用于按量计费实例的解隔离，包年包月实例的解隔离请使用 RenewDBInstance 。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，单个实例 ID 格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。 说明：可输入多个实例 ID 进行操作，json 格式如下。 [ \"cdb-30z11v8s\", \"cdb-93h11efg\" ]", "example": "cdb-f35wr6wj", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "ReloadBalanceProxyNode", "description": "重新负载均衡数据库代理", "status": "online", "parameters": [ { "name": "ProxyGroupId", "type": "string", "required": true, "description": "代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-ixw3ll2d" }, { "name": "ProxyAddressId", "type": "string", "required": false, "description": "代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。 说明： 1. 对于双节点实例而言，此参数为非必填，如果不传则会对所有代理组地址进行负载均衡。 2. 对于云盘版实例而言，此参数为必填。", "example": " proxyaddr-kti9dddd" } ], "required": [ "ProxyGroupId" ] }, { "name": "RenewDBInstance", "description": "本接口（RenewDBInstance）用于续费云数据库实例，支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待续费的实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872)。", "example": "cdb-ezq1vzem" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "续费时长，单位：月，可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "1" }, { "name": "ModifyPayType", "type": "string", "required": false, "description": "如果需要将按量计费实例续费为包年包月的实例，该入参的值需要指定为 \"PREPAID\" 。", "example": "PREPAID" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "自动续费标记，0表示不自动续费，1表示进行自动续费", "example": "0" } ], "required": [ "InstanceId", "TimeSpan" ] }, { "name": "ResetPassword", "description": "手动刷新轮转密码", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" }, { "name": "User", "type": "string", "required": true, "description": "手动刷新轮转密码的实例账户名，例如root", "example": "andy" }, { "name": "Host", "type": "string", "required": true, "description": "手动刷新轮转密码的实例账户域名，例如%", "example": "172.1.1.1" } ], "required": [ "InstanceId", "User", "Host" ] }, { "name": "ResetRootAccount", "description": "重置实例ROOT账号，初始化账号权限", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-4t34ozl0" } ], "required": [ "InstanceId" ] }, { "name": "RestartDBInstances", "description": "本接口（RestartDBInstances）用于重启云数据库实例。 注意： 1、本接口支持主实例、只读实例、灾备实例进行重启操作。 2、实例状态必须为正常，并且没有其他异步任务在执行中。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 数组，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "[\"cdb-f35wr6wj\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "StartBatchRollback", "description": "该接口（StartBatchRollback）用于批量回档云数据库实例的库表。", "status": "online", "parameters": [ { "name": "Instances", "type": "array", "required": true, "description": "用于回档的实例详情信息。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "云数据库实例 ID。", "example": "cdb-aeti0q11" }, { "name": "Strategy", "type": "string", "required": true, "description": "回档策略。可选值为：table、db、full。table - 极速回档模式，仅导入所选中表级别的备份和binlog，如有跨表操作，且关联表未被同时选中，将会导致回档失败，该模式下参数Databases必须为空；db - 快速模式，仅导入所选中库级别的备份和binlog，如有跨库操作，且关联库未被同时选中，将会导致回档失败；full - 普通回档模式，将导入整个实例的备份和 binlog，速度较慢。", "example": "db" }, { "name": "RollbackTime", "type": "string", "required": true, "description": "数据库回档时间，时间格式为：yyyy-mm-dd hh:mm:ss。", "example": "2024-09-09 16:40:30" }, { "name": "Databases", "type": "array", "required": false, "description": "待回档的数据库信息，表示整库回档。", "example": "[{\"DatabaseName\": \"db1\",\"NewDatabaseName\": \"db2\"}]", "item_type": "object", "children": [ { "name": "DatabaseName", "type": "string", "required": true, "description": "回档前的原数据库名", "example": "db1" }, { "name": "NewDatabaseName", "type": "string", "required": true, "description": "回档后的新数据库名", "example": "dbnew" } ] }, { "name": "Tables", "type": "array", "required": false, "description": "待回档的数据库表信息，表示按表回档。", "example": "[{\"Database\": \"db1\",\"Table\": [{\"TableName\": \"andytable1\",\"NewTableName\": \"andytable2\"}]}]", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "db1" }, { "name": "Table", "type": "array", "required": true, "description": "数据库表详情", "example": "[{\"TableName\": \"table1\",\"NewTableName\": \"table2\"}]", "item_type": "object", "children": [ { "name": "TableName", "type": "string", "required": true, "description": "回档前的原数据库表名", "example": "table1" }, { "name": "NewTableName", "type": "string", "required": true, "description": "回档后的新数据库表名", "example": "table2" } ] } ] } ] } ], "required": [ "Instances" ] }, { "name": "StartCpuExpand", "description": "通过该 API，可以开启 CPU 弹性扩容，包括一次性的手动扩容以及自动弹性扩容。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-himitj11" }, { "name": "Type", "type": "string", "required": true, "description": "扩容类型，支持自动扩容和自定义扩容。 说明：1. auto 表示自动扩容。2. manual 表示自定义扩容，扩容时间为立即生效。3. timeInterval 表示自定义扩容，扩容时间为按时间段。4. period 表示自定义扩容，扩容时间为按周期。", "example": "auto" }, { "name": "ExpandCpu", "type": "integer", "required": false, "description": "自定义扩容时，扩容的 CPU 核心数。 说明：1. Type 为 manual、timeInterval、period 时必传。2. 扩容的 CPU 核心数上限为当前实例 CPU 核心数，比如8核16G最大可手动扩容的 CPU 核心数为8，即范围为1 - 8。", "example": "4" }, { "name": "AutoStrategy", "type": "object", "required": false, "description": "自动扩容策略。Type 为 auto 时必传。", "example": "{\"ExpandThreshold\": 70,\"ShrinkThreshold\": 30,\"ExpandSecondPeriod\": 15,\"ShrinkSecondPeriod\": 300}", "children": [ { "name": "ExpandThreshold", "type": "integer", "required": true, "description": "自动扩容阈值，可选值40、50、60、70、80、90，代表 CPU 利用率达到40%、50%、60%、70%、80%、90%时后台进行自动扩容。", "example": "70" }, { "name": "ShrinkThreshold", "type": "integer", "required": true, "description": "自动缩容阈值，可选值10、20、30，代表CPU利用率达到10%、20%、30%时后台进行自动缩容", "example": "10" }, { "name": "ExpandSecondPeriod", "type": "integer", "required": false, "description": "弹性扩容观测周期（秒级），可取值为：15，30，45，60，180，300，600，900，1800。", "example": "300" }, { "name": "ShrinkSecondPeriod", "type": "integer", "required": false, "description": "缩容观测周期（秒级），可取值为：300、600、900、1800。", "example": "300" } ] }, { "name": "TimeIntervalStrategy", "type": "object", "required": false, "description": "按时间段扩容策略。 说明：当 Type 为 timeInterval 时，TimeIntervalStrategy 必填。", "example": "{\"StartTime\": 1749546000,\"EndTime\": 1749718800}", "children": [ { "name": "StartTime", "type": "integer", "required": false, "description": "开始扩容时间。 说明：此值的格式为 Integer 的时间戳（秒级）。", "example": "1749546000" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束扩容时间。 说明：此值的格式为 Integer 的时间戳（秒级）。", "example": "1749718800" } ] }, { "name": "PeriodStrategy", "type": "object", "required": false, "description": "按周期扩容策略。 说明：当 Type 为 period 时，PeriodStrategy 必填。", "example": "{\"TimeCycle\": {\"Monday\": true,\"Tuesday\": false,\"Wednesday\": false,\"Thursday\": false,\"Friday\": true,\"Saturday\": false,\"Sunday\": false},\"TimeInterval\": {\"StartTime\": \"17:00\",\"EndTime\": \"20:00\"}}", "children": [ { "name": "TimeCycle", "type": "object", "required": false, "description": "扩容周期", "example": "无", "children": [ { "name": "Monday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周一扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Tuesday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周二扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Wednesday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周三扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Thursday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周四扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Friday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周五扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Saturday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周六扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" }, { "name": "Sunday", "type": "boolean", "required": false, "description": "按周期扩容时，是否选择周日扩容。 说明：取值 true，表示选择，取值 false，表示不选择。", "example": "true" } ] }, { "name": "TimeInterval", "type": "object", "required": false, "description": "时间间隔", "example": "无", "children": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。", "example": "02:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。", "example": "03:00" } ] } ] } ], "required": [ "InstanceId", "Type" ] }, { "name": "StartReplication", "description": "本接口（StartReplication）用于开启 RO 复制，从主实例同步数据。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。仅支持只读实例。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdbro-lsjh9i11" } ], "required": [ "InstanceId" ] }, { "name": "StopCpuExpand", "description": "通过该API，可以关闭 CPU 弹性扩容。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-himitj11" } ], "required": [ "InstanceId" ] }, { "name": "StopDBImportJob", "description": "本接口（StopDBImportJob）用于终止数据导入任务。 说明：只有未完成的导入任务支持被终止，且终止后已执行的 SQL 部分会被保留。", "status": "online", "parameters": [ { "name": "AsyncRequestId", "type": "string", "required": true, "description": "异步任务的请求 ID。", "example": "434e366f-beaf56d6-508b7f33-2abdb382" } ], "required": [ "AsyncRequestId" ] }, { "name": "StopReplication", "description": "本接口（StopReplication）用于停止 RO 复制，中断从主实例同步数据。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。仅支持只读实例。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdbro-himitj11" } ], "required": [ "InstanceId" ] }, { "name": "StopRollback", "description": "本接口（StopRollback）用于撤销实例正在进行的回档任务，该接口返回一个异步任务 ID。撤销结果可以通过 [DescribeAsyncRequestInfo](https://cloud.tencent.com/document/api/236/20410) 查询任务的执行情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "撤销回档任务对应的实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/api/236/15872) 接口获取。", "example": "cdb-9303wd4x" } ], "required": [ "InstanceId" ] }, { "name": "SubmitInstanceUpgradeCheckJob", "description": "该接口（SubmitInstanceUpgradeCheckJob）提交实例版本升级校验任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-g3rbtabc" }, { "name": "DstMysqlVersion", "type": "string", "required": true, "description": "目标数据库版本。 说明：可选值5.6、5.7、8.0，不支持跨版本升级，升级后不支持版本降级。", "example": "8.0" } ], "required": [ "InstanceId", "DstMysqlVersion" ] }, { "name": "SwitchCDBProxy", "description": "本接口（SwitchCDBProxy）用于数据库代理配置变更或者升级版本后手动发起立即切换。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-pr1rb3j1" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-p11rb3j9" } ], "required": [ "InstanceId", "ProxyGroupId" ] }, { "name": "SwitchDBInstanceMasterSlave", "description": "该接口 (SwitchDBInstanceMasterSlave) 支持用户主动切换实例主从角色。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。", "example": "cdb-rqd2jndd" }, { "name": "DstSlave", "type": "string", "required": false, "description": "目标从实例。可选值：\"first\" - 第一备机；\"second\" - 第二备机。默认值为 \"first\"，仅多可用区实例支持设置为 \"second\"。", "example": "first" }, { "name": "ForceSwitch", "type": "boolean", "required": false, "description": "是否强制切换。默认为 False。注意，若设置强制切换为 True，实例存在丢失数据的风险，请谨慎使用。", "example": "false" }, { "name": "WaitSwitch", "type": "boolean", "required": false, "description": "是否时间窗内切换。默认为 False，即不在时间窗内切换。注意，如果设置了 ForceSwitch 参数为 True，则该参数不生效。", "example": "false" }, { "name": "DstNodeId", "type": "string", "required": false, "description": "集群版实例指定节点 ID 发起主从切换。", "example": "dbn-iql06r1s" } ], "required": [ "InstanceId" ] }, { "name": "SwitchDrInstanceToMaster", "description": "本接口（SwitchDrInstanceToMaster）用于将云数据库灾备实例切换为主实例，注意请求必须发到灾备实例所在的地域。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "灾备实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-c1nl9rpv" } ], "required": [ "InstanceId" ] }, { "name": "SwitchForUpgrade", "description": "本接口(SwitchForUpgrade)用于切换访问新实例，针对主升级中的实例处于待切换状态时，用户可主动发起该流程。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-eb2w7dto" }, { "name": "IsRelatedSwitch", "type": "boolean", "required": false, "description": "是否开启关联切换，true为开启，false为关闭，默认false", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeCDBProxyVersion", "description": "本接口（UpgradeCDBProxyVersion）用于升级数据库代理版本。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。", "example": "cdb-pr1rb3j1" }, { "name": "ProxyGroupId", "type": "string", "required": true, "description": "数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。", "example": "proxy-p11rb3j9" }, { "name": "SrcProxyVersion", "type": "string", "required": true, "description": "数据库代理当前版本", "example": "1.0.1" }, { "name": "DstProxyVersion", "type": "string", "required": true, "description": "数据库代理升级版本", "example": "1.1.2" }, { "name": "UpgradeTime", "type": "string", "required": true, "description": "升级时间 ：nowTime（升级完成时）timeWindow（实例维护时间）", "example": "nowTime" } ], "required": [ "InstanceId", "ProxyGroupId", "SrcProxyVersion", "DstProxyVersion", "UpgradeTime" ] }, { "name": "UpgradeDBInstance", "description": "本接口（UpgradeDBInstance）用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "\"cdb-c1nl9rpv\"" }, { "name": "Memory", "type": "integer", "required": true, "description": "升级后的内存大小，单位：MB，为保证传入 Memory 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。 说明：如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。", "example": "8000" }, { "name": "Volume", "type": "integer", "required": true, "description": "升级后的硬盘大小，单位：GB，为保证传入 Volume 值有效，请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。", "example": "200" }, { "name": "ProtectMode", "type": "integer", "required": false, "description": "数据复制方式，支持值包括：0 - 异步复制，1 - 半同步复制，2 - 强同步复制，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。", "example": "0" }, { "name": "DeployMode", "type": "integer", "required": false, "description": "部署模式，默认为 0，支持值包括：0 - 单可用区部署，1 - 多可用区部署，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。", "example": "0" }, { "name": "SlaveZone", "type": "string", "required": false, "description": "备库1的可用区信息，默认和实例的 Zone 参数一致，升级主实例为多可用区部署时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。", "example": "ap-guangzhou-1" }, { "name": "EngineVersion", "type": "string", "required": false, "description": "主实例数据库引擎版本，支持值包括：5.5、5.6、5.7、8.0。 说明：升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。", "example": "\"5.7\"" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "切换访问新实例的方式，默认为 0。支持值包括：0 - 立刻切换，1 - 时间窗切换；当该值为 1 时，升级过程中，切换访问新实例的流程将会在时间窗内进行，或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。", "example": "0" }, { "name": "BackupZone", "type": "string", "required": false, "description": "备库2的可用区信息，默认为空，升级主实例时可指定该参数，升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。 备注：如您要将三节点降级至双节点，将该参数设置为空值即可实现。", "example": "ap-guangzhou-2" }, { "name": "InstanceRole", "type": "string", "required": false, "description": "实例类型，默认为 master，支持值包括：master - 表示主实例，dr - 表示灾备实例，ro - 表示只读实例。", "example": "\"master\"" }, { "name": "DeviceType", "type": "string", "required": false, "description": "实例隔离类型。支持值包括： \"UNIVERSAL\" - 通用型实例， \"EXCLUSIVE\" - 独享型实例， \"BASIC\" - 基础版实例。", "example": "\"UNIVERSAL\"" }, { "name": "Cpu", "type": "integer", "required": false, "description": "升级后的实例cpu核数，如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。 说明：如果进行迁移业务，请一定填写实例规格（CPU、内存），不然系统会默认以最小允许规格传参。", "example": "1" }, { "name": "FastUpgrade", "type": "integer", "required": false, "description": "是否极速变配。0-普通升级，1-极速变配，2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配，满足条件则进行极速变配，不满足条件会返回报错信息。", "example": "1" }, { "name": "MaxDelayTime", "type": "integer", "required": false, "description": "延迟阈值。取值范围1~10，默认值为10。", "example": "2" }, { "name": "CrossCluster", "type": "integer", "required": false, "description": "是否跨区迁移。0-普通迁移，1-跨区迁移，默认值为0。该值为1时支持变更实例主节点可用区。", "example": "1" }, { "name": "ZoneId", "type": "string", "required": false, "description": "主节点可用区，该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。", "example": "\"ap-guangzhou-1\"" }, { "name": "RoTransType", "type": "string", "required": false, "description": "针对跨集群搬迁场景，选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区（默认选项），severally-同可用区RO保持原部署模式、不迁移至目标可用区。", "example": "\"together\"" }, { "name": "ClusterTopology", "type": "object", "required": false, "description": "云盘版节点拓扑配置。", "example": "无", "children": [ { "name": "ReadWriteNode", "type": "object", "required": false, "description": "RW 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "RW 节点所在可用区。", "example": "ap-guangzhou-4" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-73ktfl1j" } ] }, { "name": "ReadOnlyNodes", "type": "array", "required": false, "description": "RO 节点拓扑。 说明：NodeId 可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 获取。", "example": "无", "item_type": "object", "children": [ { "name": "IsRandomZone", "type": "string", "required": false, "description": "是否分布在随机可用区。传入YES表示随机可用区。否则使用Zone指定的可用区。", "example": "YES" }, { "name": "Zone", "type": "string", "required": false, "description": "指定该节点分布在哪个可用区。", "example": "ap-beijing-3" }, { "name": "NodeId", "type": "string", "required": false, "description": "升级云盘版实例时，如果要调整只读节点可用区，需要指定节点 ID。", "example": "dbn-h7erp111" } ] } ] }, { "name": "CheckFastUpgradeReboot", "type": "integer", "required": false, "description": "检查原地升级是否需要重启，1 检查， 0 不检查。如果值为1，检查为原地升级需要重启，则会停止升级并进行返回提示，如果为原地升级不重启，则正常执行升级流程。", "example": "1" }, { "name": "DataCheckSensitive", "type": "string", "required": false, "description": "数据校验敏感度，非极速变配时使用此参数，敏感度根据当前实例规格计算迁移过程中的数据对比使用的cpu资源 对应的选项为: \"high\"、\"normal\"、\"low\"，默认为空 参数详解，： \"high\": 对应控制台中的高，数据库负载过高不建议使用 \"normal\"：对应控制台中的标准 \"low\"：对应控制台中的低", "example": "\"low\"" } ], "required": [ "InstanceId", "Memory", "Volume" ] }, { "name": "UpgradeDBInstanceEngineVersion", "description": "本接口（UpgradeDBInstanceEngineVersion）用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例等。升级前请通过 [SubmitInstanceUpgradeCheckJob](https://cloud.tencent.com/document/product/236/110468) 提交升级检查任务，通过后才能升级。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "cdb-8qrg9t04" }, { "name": "EngineVersion", "type": "string", "required": true, "description": "主实例数据库引擎版本，支持值包括：5.6、5.7、8.0。 说明：不支持越级升级，升级后不支持降级。", "example": "5.7" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "切换访问新实例的方式，默认为 0。支持值包括：0 - 立刻切换，1 - 时间窗切换；当该值为 1 时，升级过程中，切换访问新实例的流程将会在时间窗内进行，或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。", "example": "1" }, { "name": "UpgradeSubversion", "type": "integer", "required": false, "description": "是否是内核子版本升级，支持的值：1 - 升级内核子版本；0 - 升级数据库引擎版本。无默认值，请指定要升级的版本类型。", "example": "20201231" }, { "name": "MaxDelayTime", "type": "integer", "required": false, "description": "延迟阈值。取值范围：1 - 10。无默认值，不传此参数时，延迟阈值为0，表示延迟阈值不做设置。", "example": "1" }, { "name": "IgnoreErrKeyword", "type": "integer", "required": false, "description": "5.7升级8.0是否忽略关键字错误，取值范围[0,1]，1表示忽略，0表示不忽略。无默认值，不传此参数表示不做处理。", "example": "1" }, { "name": "ParamList", "type": "array", "required": false, "description": "版本升级支持指定参数", "example": "[{\"Name\": \"default_collation_for_utf8mb4\", \"Value\": \"EXC\",\"Value\": \"utf8mb4_0900_ai_ci\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "default_collation_for_utf8mb4" }, { "name": "Value", "type": "string", "required": false, "description": "参数值", "example": "utf8mb4_0900_ai_ci" } ] } ], "required": [ "InstanceId", "EngineVersion" ] }, { "name": "VerifyRootAccount", "description": "本接口(VerifyRootAccount)用于校验云数据库实例的 ROOT 账号是否有足够的权限进行授权操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "cdb-f35wr6wj" }, { "name": "Password", "type": "string", "required": true, "description": "实例 ROOT 账号的密码。", "example": "sxxxxxx" } ], "required": [ "InstanceId", "Password" ] } ] }