{ "name": "dcdb", "display_name": "TDSQL MySQL 版", "description": "介绍如何使用API对分布式数据库TDSQL进行操作，包括新购分布式数据库实例询价、实例管理等。", "domain": "database", "api_version": "2018-04-11", "endpoint": "dcdb.tencentcloudapi.com", "actions": [ { "name": "ActiveHourDCDBInstance", "description": "解隔离TDSQL按量计费实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待升级的实例ID列表。形如：[\"dcdbt-ow728lmc\"]，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "[\"tdsqlshard-cq3ndzu7\",\"tdsqlshard-m7xhodc5\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "AssociateSecurityGroups", "description": "本接口 (AssociateSecurityGroups) 用于安全组批量绑定云资源。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：dcdb。", "example": "dcdb" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "要绑定的安全组ID，类似sg-efil73jd。", "example": "sg-xxxxxx" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被绑定的实例ID，类似tdsqlshard-lesecurk，支持指定多个实例。", "example": "[\"tdsql-xxxxxx\\n\"]", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "CancelDcnJob", "description": "本接口（CancelDcnJob）用于取消DCN同步", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "灾备实例ID", "example": "tdsql-2rn9lmpx" } ], "required": [ "InstanceId" ] }, { "name": "CancelOnlineDDLJob", "description": "取消 Online DDL 任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "tdsqlshard-8jbp1qpv" }, { "name": "FlowId", "type": "integer", "required": true, "description": "要暂停的 Online DDL 任务对应的流程Id。创建任务时，CreateOnlineDDLJob 会返回此流程Id", "example": "12357" } ], "required": [ "InstanceId", "FlowId" ] }, { "name": "CloneAccount", "description": "本接口（CloneAccount）用于克隆实例账户。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "dcdbt-ovulpcjf" }, { "name": "SrcUser", "type": "string", "required": true, "description": "源用户账户名", "example": "testuser1" }, { "name": "SrcHost", "type": "string", "required": true, "description": "源用户HOST", "example": "172.17.%" }, { "name": "DstUser", "type": "string", "required": true, "description": "目的用户账户名", "example": "testuser1" }, { "name": "DstHost", "type": "string", "required": true, "description": "目的用户HOST", "example": "172.20.%" }, { "name": "DstDesc", "type": "string", "required": false, "description": "目的用户账户描述", "example": "testclone" } ], "required": [ "InstanceId", "SrcUser", "SrcHost", "DstUser", "DstHost" ] }, { "name": "CloseDBExtranetAccess", "description": "本接口(CloseDBExtranetAccess)用于关闭云数据库实例的外网访问。关闭外网访问后，外网地址将不可访问，查询实例列表接口将不返回对应实例的外网域名和端口信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待关闭外网访问的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-avw0207d" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "是否IPv6，默认0", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "CopyAccountPrivileges", "description": "本接口（CopyAccountPrivileges）用于复制云数据库账号的权限。 注意：相同用户名，不同Host是不同的账号，Readonly属性相同的账号之间才能复制权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-fdpjf5zh" }, { "name": "SrcUserName", "type": "string", "required": true, "description": "源用户名", "example": "testuser1" }, { "name": "SrcHost", "type": "string", "required": true, "description": "源用户允许的访问 host", "example": "172.17.%" }, { "name": "DstUserName", "type": "string", "required": true, "description": "目的用户名", "example": "testuser2" }, { "name": "DstHost", "type": "string", "required": true, "description": "目的用户允许的访问 host", "example": "%" }, { "name": "SrcReadOnly", "type": "string", "required": false, "description": "源账号的 ReadOnly 属性", "example": "0" }, { "name": "DstReadOnly", "type": "string", "required": false, "description": "目的账号的 ReadOnly 属性", "example": "0" } ], "required": [ "InstanceId", "SrcUserName", "SrcHost", "DstUserName", "DstHost" ] }, { "name": "CreateAccount", "description": "本接口（CreateAccount）用于创建云数据库账号。一个实例可以创建多个不同的账号，相同的用户名+不同的host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "AccountName", "example": "testuser1" }, { "name": "Host", "type": "string", "required": true, "description": "可以登录的主机，与mysql 账号的 host 格式一致，可以支持通配符，例如 %，10.%，10.20.%。", "example": "172.17.%" }, { "name": "Password", "type": "string", "required": false, "description": "账号密码，密码需要 8-32 个字符，不能以 '/' 开头，并且必须包含小写字母、大写字母、数字和符号()~!@#$%^\u0026*-+=_|{}[]:,.?/。", "example": "1234qweri#" }, { "name": "ReadOnly", "type": "integer", "required": false, "description": "是否创建为只读账号，0：否， 1：该账号的sql请求优先选择备机执行，备机不可用时选择主机执行，2：优先选择备机执行，备机不可用时操作失败，3：只从备机读取。", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "账号备注，可以包含中文、英文字符、常见符号和数字，长度为0~256字符", "example": "测试账号" }, { "name": "DelayThresh", "type": "integer", "required": false, "description": "如果备机延迟超过本参数设置值，系统将认为备机发生故障 建议该参数值大于10。当ReadOnly选择1、2时该参数生效。", "example": "15" }, { "name": "SlaveConst", "type": "integer", "required": false, "description": "针对只读账号，设置策略是否固定备机，0：不固定备机，即备机不满足条件与客户端不断开连接，Proxy选择其他可用备机，1：备机不满足条件断开连接，确保一个连接固定备机。", "example": "0" }, { "name": "MaxUserConnections", "type": "integer", "required": false, "description": "用户最大连接数限制参数。不传或者传0表示为不限制，对应max_user_connections参数，目前10.1内核版本不支持设置。", "example": "0" }, { "name": "EncryptedPassword", "type": "string", "required": false, "description": "使用GetPublicKey返回的RSA2048公钥加密后的密码", "example": "MTIzNDU2Nzg5MTA=" } ], "required": [ "InstanceId", "UserName", "Host" ] }, { "name": "CreateDCDBInstance", "description": "本接口（CreateDCDBInstance）用于创建包年包月的TDSQL实例，可通过传入实例规格、数据库版本号、购买时长等信息创建云数据库实例。", "status": "online", "parameters": [ { "name": "Zones", "type": "array", "required": true, "description": "分片节点可用区分布，可填写多个可用区。 注意当前可售卖的可用区需要通过DescribeDCDBSaleInfo接口拉取。", "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "Period", "type": "integer", "required": true, "description": "欲购买的时长，单位：月。", "example": "1" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储空间大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": true, "description": "单个分片节点个数，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "3" }, { "name": "ShardCount", "type": "integer", "required": true, "description": "实例分片个数，可选范围2-8，可以通过升级实例进行新增分片到最多64个分片。", "example": "2" }, { "name": "Count", "type": "integer", "required": false, "description": "欲购买实例的数量", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，可以通过查看项目列表获取，不传则关联到默认项目", "example": "1077641" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟私有网络 ID，不传或传空表示创建为基础网络", "example": "vpc-qdiqptn3" }, { "name": "SubnetId", "type": "string", "required": false, "description": "虚拟私有网络子网 ID，VpcId不为空时必填", "example": "subnet-0r3bgq4c" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "数据库引擎版本，当前可选：8.0，5.7，10.1，10.0。", "example": "5.7" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "true" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]", "item_type": "string" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组id", "example": "sg-9tfjckm6" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称， 可以通过该字段自主的设置实例的名字", "example": "tdsql_MySQL" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "是否支持IPv6，0:不支持，1:支持", "example": "0" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "标签键值对数组", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键key", "example": "qta-tdsql20" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值value", "example": "tdsql50" } ] }, { "name": "InitParams", "type": "array", "required": false, "description": "参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步可退化）。", "example": "无", "item_type": "object", "children": [ { "name": "Param", "type": "string", "required": true, "description": "参数名称", "example": "autocommit" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "ON" } ] }, { "name": "DcnRegion", "type": "string", "required": false, "description": "DCN源地域", "example": "ap-guangzhou" }, { "name": "DcnInstanceId", "type": "string", "required": false, "description": "DCN源实例ID", "example": "tdsqlshard-b0wbmr9p" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标记，0:默认状态(用户未设置，即初始状态即手动续费，用户开通了预付费不停服特权也会进行自动续费)， 1:自动续费，2:明确不自动续费(用户设置)。若业务无续费概念或无需自动续费，需要设置为0", "example": "0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ids，安全组可以传数组形式，兼容之前SecurityGroupId参数", "example": "[\"sg-5ozc4vtq\"]", "item_type": "string" }, { "name": "DcnSyncMode", "type": "integer", "required": false, "description": "DCN同步模式，0：异步， 1：强同步", "example": "1" }, { "name": "CpuType", "type": "string", "required": false, "description": "Cpu类型，如：英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD", "example": "Intel/AMD" } ], "required": [ "Zones", "Period", "ShardMemory", "ShardStorage", "ShardNodeCount", "ShardCount" ] }, { "name": "CreateDedicatedClusterDCDBInstance", "description": "创建TDSQL独享集群实例", "status": "online", "parameters": [ { "name": "GoodsNum", "type": "integer", "required": true, "description": "分配实例个数", "example": "1" }, { "name": "ShardNum", "type": "integer", "required": true, "description": "分片数量", "example": "0" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片內存大小, 单位GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片磁盘大小, 单位GB", "example": "10" }, { "name": "ClusterId", "type": "string", "required": true, "description": "独享集群集群uuid", "example": "dbdc-xxxx" }, { "name": "Zone", "type": "string", "required": false, "description": "（废弃）可用区", "example": "\"ap-guangzhou-1\"" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1" }, { "name": "Cpu", "type": "integer", "required": false, "description": "（废弃）cpu大小，单位：核", "example": "0" }, { "name": "VpcId", "type": "string", "required": false, "description": "网络ID", "example": "vpc-xxxx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网ID", "example": "subnet-xxxx" }, { "name": "ShardMachine", "type": "string", "required": false, "description": "（废弃）分片机型", "example": "TS85" }, { "name": "ShardNodeNum", "type": "integer", "required": false, "description": "分片的节点个数", "example": "2" }, { "name": "ShardNodeCpu", "type": "integer", "required": false, "description": "（废弃）节点cpu核数，单位：1/100核", "example": "0" }, { "name": "ShardNodeMemory", "type": "integer", "required": false, "description": "（废弃）节点內存大小，单位：GB", "example": "0" }, { "name": "ShardNodeStorage", "type": "integer", "required": false, "description": "（废弃）节点磁盘大小，单位：GB", "example": "0" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "db版本", "example": "5.7.17" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组ID", "example": "sg-xxxx" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID列表", "example": "[\"sg-xxxx\",\"sg-xxxx\"]", "item_type": "string" }, { "name": "DcnInstanceId", "type": "string", "required": false, "description": "DCN源实例ID", "example": "tdsqlshard-xxxx" }, { "name": "DcnRegion", "type": "string", "required": false, "description": "DCN源实例地域名", "example": "ap-guangzhou" }, { "name": "InstanceName", "type": "string", "required": false, "description": "自定义实例名称", "example": "tdsql_mysql" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键key", "example": "qta-tdsql20" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值value", "example": "tdsql50" } ] }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "支持IPv6标志：1 支持， 0 不支持", "example": "0" }, { "name": "Pid", "type": "integer", "required": false, "description": "（废弃）Pid，可通过获取独享集群售卖配置接口得到", "example": "100" }, { "name": "InitParams", "type": "array", "required": false, "description": "参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步可退化）。", "example": "无", "item_type": "object", "children": [ { "name": "Param", "type": "string", "required": true, "description": "参数名称", "example": "autocommit" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "ON" } ] }, { "name": "MasterHostId", "type": "string", "required": false, "description": "指定主节点uuid，不填随机分配", "example": "svr-xxxx" }, { "name": "SlaveHostIds", "type": "array", "required": false, "description": "指定从节点uuid，不填随机分配", "example": "[\"svr-xxx\",\"svr-xxx\"]", "item_type": "string" }, { "name": "RollbackInstanceId", "type": "string", "required": false, "description": "需要回档的源实例ID", "example": "tdsqlshard-xxx" }, { "name": "RollbackTime", "type": "string", "required": false, "description": "回档时间", "example": "2022-05-10 12:00:00" }, { "name": "DcnSyncMode", "type": "integer", "required": false, "description": "DCN同步模式，0：异步， 1：强同步", "example": "1" } ], "required": [ "GoodsNum", "ShardNum", "ShardMemory", "ShardStorage", "ClusterId" ] }, { "name": "CreateHourDCDBInstance", "description": "创建TDSQL按量计费实例", "status": "online", "parameters": [ { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储空间大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": true, "description": "单个分片节点个数，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "2" }, { "name": "ShardCount", "type": "integer", "required": true, "description": "实例分片个数，可选范围2-8，可以通过升级实例进行新增分片到最多64个分片。", "example": "2" }, { "name": "Count", "type": "integer", "required": false, "description": "欲购买实例的数量", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，可以通过查看项目列表获取，不传则关联到默认项目", "example": "0" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟私有网络 ID，不传或传空表示创建为基础网络", "example": "0" }, { "name": "SubnetId", "type": "string", "required": false, "description": "虚拟私有网络子网 ID，VpcId不为空时必填", "example": "0" }, { "name": "ShardCpu", "type": "integer", "required": false, "description": "分片cpu大小，单位：核，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "0" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "数据库引擎版本，当前可选：8.0，5.7，10.1，10.0。", "example": "5.7" }, { "name": "Zones", "type": "array", "required": false, "description": "分片节点可用区分布，可填写多个可用区。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组id", "example": "sg-egre3rqv" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称， 可以通过该字段自主的设置实例的名字", "example": "实例名称" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "是否支持IPv6，0:不支持，1:支持", "example": "0" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "标签键值对数组", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键key", "example": "qta-tdsql20" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值value", "example": "tdsql50" } ] }, { "name": "DcnRegion", "type": "string", "required": false, "description": "DCN源地域", "example": "ap-guangzhou" }, { "name": "DcnInstanceId", "type": "string", "required": false, "description": "DCN源实例ID", "example": "tdsqlshard-123" }, { "name": "InitParams", "type": "array", "required": false, "description": "参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步可退化）。", "example": "无", "item_type": "object", "children": [ { "name": "Param", "type": "string", "required": true, "description": "参数名称", "example": "autocommit" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "ON" } ] }, { "name": "RollbackInstanceId", "type": "string", "required": false, "description": "需要回档的源实例ID", "example": "tdsqlshard-d0uvh7ep" }, { "name": "RollbackTime", "type": "string", "required": false, "description": "回档时间，例如“2021-11-22 00:00:00”", "example": "2024-12-14 12:00:00" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ids，安全组可以传数组形式，兼容之前SecurityGroupId参数", "example": "[\"sg-grefw6tr\"]", "item_type": "string" }, { "name": "DcnSyncMode", "type": "integer", "required": false, "description": "DCN同步模式，0：异步， 1：强同步", "example": "1" }, { "name": "CpuType", "type": "string", "required": false, "description": "Cpu类型，如：英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD", "example": "Intel/AMD" } ], "required": [ "ShardMemory", "ShardStorage", "ShardNodeCount", "ShardCount" ] }, { "name": "CreateOnlineDDLJob", "description": "创建在线DDL任务", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "tdsqlshard-gayfdsflx" }, { "name": "Alter", "type": "string", "required": true, "description": "要执行的 DDL 语句。常用的在线DDL参考此API文档示例部分", "example": "alter table test_tbl add column add_col_2 int not null;" }, { "name": "DbName", "type": "string", "required": true, "description": "要修改的数据库", "example": "test_db" }, { "name": "Table", "type": "string", "required": true, "description": "要修改的表", "example": "test_tbl" }, { "name": "User", "type": "string", "required": false, "description": "指定账号执行DDL，需确保账号有 ALTER, CREATE, INSERT, UPDATE, DROP, DELETE, INDEX, CREATE TEMPORARY TABLES, LOCK TABLES, TRIGGER, REPLICATION CLIENT, REPLICATION SLAVE 等相关权限 （若不填写将默认使用系统账号）", "example": "test_user" }, { "name": "Password", "type": "string", "required": false, "description": "指定账号的密码", "example": "test_pwd" }, { "name": "CriticalLoad", "type": "integer", "required": false, "description": "运行线程数大于此值时，将终止DDL。不填则默认58", "example": "30" }, { "name": "CheckAutoInc", "type": "integer", "required": false, "description": "是否检查自增字段。为1则不允许修改自增字段，0或不填写则不检查", "example": "1" }, { "name": "MaxDelay", "type": "integer", "required": false, "description": "允许的主备延迟时间(单位s)，0或不填写则不检查延迟", "example": "5" }, { "name": "UsePt", "type": "integer", "required": false, "description": "是否使用pt-osc工具做DDL", "example": "1" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始执行时间", "example": "2024-04-01 01:00:00" } ], "required": [ "InstanceId", "Alter", "DbName", "Table" ] }, { "name": "CreateTmpDCDBInstance", "description": "回档TDSQL实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "回档实例的ID", "example": "tdsqlshard-1pif6bs0" }, { "name": "RollbackTime", "type": "string", "required": true, "description": "回档时间点", "example": "2020-01-15+10%3A27%3A02" } ], "required": [ "InstanceId", "RollbackTime" ] }, { "name": "DeleteAccount", "description": "本接口（DeleteAccount）用于删除云数据库账号。用户名+host唯一确定一个账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "testuser1" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host", "example": "172.17.%" } ], "required": [ "InstanceId", "UserName", "Host" ] }, { "name": "DescribeAccountPrivileges", "description": "本接口（DescribeAccountPrivileges）用于查询云数据库账号权限。 注意：注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "登录用户名。", "example": "testuser1" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host，用户名+host唯一确定一个账号。", "example": "172.17.%" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名。如果为 \\*，表示查询全局权限（即 \\*.\\*），此时忽略 Type 和 Object 参数", "example": "product_db" }, { "name": "Type", "type": "string", "required": false, "description": "类型,可以填入 table 、 view 、 proc 、 func 和 \\*。当 DbName 为具体数据库名，Type为 \\* 时，表示查询该数据库权限（即db.\\*），此时忽略 Object 参数", "example": "table" }, { "name": "Object", "type": "string", "required": false, "description": "具体的 Type 的名称，例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称，则 Object 表示具体对象名，不能为 \\* 或者为空", "example": "prod_user_tbl" }, { "name": "ColName", "type": "string", "required": false, "description": "当 Type=table 时，ColName 为 \\* 表示查询表的权限，如果为具体字段名，表示查询对应字段的权限", "example": "username" } ], "required": [ "InstanceId", "UserName", "Host", "DbName" ] }, { "name": "DescribeAccounts", "description": "本接口（DescribeAccounts）用于查询指定云数据库实例的账号列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-fdpjf5zh" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupConfigs", "description": "本接口(DescribeBackupConfigs)用于查询数据库备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-c1nl9rpv" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupFiles", "description": "本接口(DescribeBackupFiles)用于查看备份文件列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "按实例ID查询", "example": "tdsqlshard-xxx" }, { "name": "ShardId", "type": "string", "required": false, "description": "按分片ID查询", "example": "shard-xxxx" }, { "name": "BackupType", "type": "string", "required": false, "description": "备份类型，Data:数据备份，Binlog:Binlog备份，Errlog:错误日志，Slowlog:慢日志", "example": "Binlog" }, { "name": "StartTime", "type": "string", "required": false, "description": "按开始时间查询", "example": "2022-05-10 12:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "按结束时间查询", "example": "2022-05-10 12:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序参数，可选值：Time,Size", "example": "Time" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序参数，可选值：DESC,ASC", "example": "DESC" } ], "required": [] }, { "name": "DescribeDBEncryptAttributes", "description": "本接口(DescribeDBEncryptAttributes)用于查询实例数据加密状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如：tdsqlshard-ow728lmc。", "example": "tdsqlshard-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBLogFiles", "description": "本接口(DescribeDBLogFiles)用于获取数据库的各种日志列表，包括冷备、binlog、errlog和slowlog。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-2t4cf98d" }, { "name": "ShardId", "type": "string", "required": true, "description": "分片 ID，形如：shard-7noic7tv", "example": "shard-gdqcdn39" }, { "name": "Type", "type": "integer", "required": true, "description": "请求日志类型，取值只能为1、2、3或者4。1-binlog，2-冷备，3-errlog，4-slowlog。", "example": "1" } ], "required": [ "InstanceId", "ShardId", "Type" ] }, { "name": "DescribeDBParameters", "description": "本接口(DescribeDBParameters)用于获取数据库的当前参数设置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-ige1a5k3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBSecurityGroups", "description": "本接口（DescribeDBSecurityGroups）用于查询实例安全组信息", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：dcdb。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsqlshard-eb2w7dto" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeDBSlowLogs", "description": "本接口(DescribeDBSlowLogs)用于查询慢查询日志列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-hw0qj6m1", "example": "tdsql-xxx" }, { "name": "Offset", "type": "integer", "required": true, "description": "从结果的第几条数据开始返回", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "返回的结果条数", "example": "20" }, { "name": "StartTime", "type": "string", "required": true, "description": "查询的起始时间，形如2016-07-23 14:55:20", "example": "2016-07-23 14:55:20" }, { "name": "ShardId", "type": "string", "required": true, "description": "实例的分片ID，形如shard-53ima8ln", "example": "shard-xxx" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询的结束时间，形如2016-08-22 14:55:20。如果不填，那么查询结束时间就是当前时间", "example": "2016-08-22 14:55:20" }, { "name": "Db", "type": "string", "required": false, "description": "要查询的具体数据库名称", "example": "dbname" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序指标，取值为query_time_sum或者query_count。不填默认按照query_time_sum排序", "example": "query_count" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，desc（降序）或者asc（升序）。不填默认desc排序", "example": "desc" }, { "name": "Slave", "type": "integer", "required": false, "description": "是否查询从机的慢查询，0-主机; 1-从机。不填默认查询主机慢查询", "example": "0" } ], "required": [ "InstanceId", "Offset", "Limit", "StartTime", "ShardId" ] }, { "name": "DescribeDBSyncMode", "description": "本接口（DescribeDBSyncMode）用于查询云数据库实例的同步模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待修改同步模式的实例ID。形如：dcdbt-ow728lmc。", "example": "dcdbt-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBTmpInstances", "description": "本接口（DescribeDBTmpInstances）用于获取实例回档生成的临时实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBBinlogTime", "description": "获取实例回档时可选的时间范围", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要回档的实例ID", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBInstanceDetail", "description": "本接口（DescribeDCDBInstanceDetail）用于获取TDSQL实例详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如dcdbt-7oaxtcb7", "example": "tdsqlshard-rlye31jd" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBInstanceNodeInfo", "description": "本接口（DescribeDCDBInstanceNodeInfo）用于获取实例节点信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsqlshard-8upuqubt" }, { "name": "Limit", "type": "integer", "required": false, "description": "单次最多返回多少条，取值范围为(0-100]，默认为100", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回数据的偏移值，默认为0", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBInstances", "description": "查询云数据库实例列表，支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。 如果不指定任何筛选条件，则默认返回10条实例记录，单次请求最多支持返回100条实例记录。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例 ID 查询。实例 ID 形如：dcdbt-2t4cf98d", "example": "[\"dcdbt-52s53yyh\\n\"]", "item_type": "string" }, { "name": "SearchName", "type": "string", "required": false, "description": "搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。", "example": "instancename" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\\n'）分割。", "example": "dcdbt-52s53yyh" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "按项目 ID 查询", "example": "[1077640,1077641]", "item_type": "integer" }, { "name": "IsFilterVpc", "type": "boolean", "required": false, "description": "是否根据 VPC 网络来搜索", "example": "true" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络 ID， IsFilterVpc 为 1 时有效", "example": "vpc-737mtr2f" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络的子网 ID， IsFilterVpc 为 1 时有效", "example": "subnet-au6ics6s" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段， projectId， createtime， instancename 三者之一", "example": "createtime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型， desc 或者 asc", "example": "asc" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 10，最大值为 100。", "example": "20" }, { "name": "ExclusterType", "type": "integer", "required": false, "description": "1非独享集群，2独享集群， 0全部", "example": "0" }, { "name": "IsFilterExcluster", "type": "boolean", "required": false, "description": "标识是否使用ExclusterType字段, false不使用，true使用", "example": "false" }, { "name": "ExclusterIds", "type": "array", "required": false, "description": "独享集群ID", "example": "[\"dbdc-4ih6uct9\"]", "item_type": "string" }, { "name": "TagKeys", "type": "array", "required": false, "description": "按标签key查询", "example": "[\"负责人\", \"备份负责人\"]\t", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "name" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "liu" } ] }, { "name": "FilterInstanceType", "type": "string", "required": false, "description": "实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔", "example": "2" }, { "name": "Status", "type": "array", "required": false, "description": "按实例状态筛选。状态值 -2：已删除； -1：已隔离；0：创建中；1：流程处理中；2：运行中", "example": "[1,2]", "item_type": "integer" }, { "name": "ExcludeStatus", "type": "array", "required": false, "description": "排除实例状态。状态值 -2：已删除； -1：已隔离；0：创建中；1：流程处理中；2：运行中", "example": "[-1,-2]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeDCDBPrice", "description": "本接口（DescribeDCDBPrice）用于在购买实例前，查询实例的价格。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "欲新购实例的可用区ID。", "example": "ap-guangzhou-2" }, { "name": "Count", "type": "integer", "required": true, "description": "欲购买实例的数量，目前支持购买1-10个实例", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "欲购买的时长，单位：月。", "example": "1" }, { "name": "ShardNodeCount", "type": "integer", "required": true, "description": "单个分片节点个数大小，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "3" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储空间大小，单位：GB，可以通过 DescribeShardSpec 查询实例规格获得。", "example": "10" }, { "name": "ShardCount", "type": "integer", "required": true, "description": "实例分片个数，可选范围2-8，可以通过升级实例进行新增分片到最多64个分片。", "example": "2" }, { "name": "Paymode", "type": "string", "required": false, "description": "付费类型。postpaid：按量付费 prepaid：预付费", "example": "prepaid" }, { "name": "AmountUnit", "type": "string", "required": false, "description": "价格金额单位，不传默认单位为分，取值： * pent：分 * microPent：微分", "example": "pent" }, { "name": "CpuType", "type": "string", "required": false, "description": "Cpu类型，如：英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD", "example": "Intel/AMD" } ], "required": [ "Zone", "Count", "Period", "ShardNodeCount", "ShardMemory", "ShardStorage", "ShardCount" ] }, { "name": "DescribeDCDBRenewalPrice", "description": "本接口（DescribeDCDBRenewalPrice）用于在续费分布式数据库实例时，查询续费的价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待续费的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdvt-fdpjf5zh" }, { "name": "Period", "type": "integer", "required": false, "description": "续费时长，单位：月。不传则默认为1个月。", "example": "1" }, { "name": "AmountUnit", "type": "string", "required": false, "description": "价格金额单位，不传默认单位为分，取值： * pent：分 * microPent：微分", "example": "pent" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBSaleInfo", "description": "本接口(DescribeDCDBSaleInfo)用于查询分布式数据库可售卖的地域和可用区信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDCDBShards", "description": "本接口（DescribeDCDBShards）用于查询云数据库实例的分片信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-ovulpcjf" }, { "name": "ShardInstanceIds", "type": "array", "required": false, "description": "分片ID列表。", "example": "[\"shard-5zf65smf\",\"shard-ngbrea6b\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段， 目前仅支持 createtime", "example": "createtime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型， desc 或者 asc", "example": "desc" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDCDBUpgradePrice", "description": "本接口（DescribeDCDBUpgradePrice）用于查询变配分布式数据库实例价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-fdpjf5zh" }, { "name": "UpgradeType", "type": "string", "required": true, "description": "升级类型，取值范围: ADD: 新增分片 EXPAND: 升级实例中的已有分片 SPLIT: 将已有分片中的数据切分到新增分片上", "example": "ADD" }, { "name": "AddShardConfig", "type": "object", "required": false, "description": "新增分片配置，当UpgradeType为ADD时生效。", "example": "无", "children": [ { "name": "ShardCount", "type": "integer", "required": true, "description": "新增分片的数量", "example": "1" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "ExpandShardConfig", "type": "object", "required": false, "description": "扩容分片配置，当UpgradeType为EXPAND时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": false, "description": "分片节点数", "example": "2" } ] }, { "name": "SplitShardConfig", "type": "object", "required": false, "description": "切分分片配置，当UpgradeType为SPLIT时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "SplitRate", "type": "integer", "required": true, "description": "数据切分比例，固定50%", "example": "50" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "AmountUnit", "type": "string", "required": false, "description": "价格金额单位，不传默认单位为分，取值： * pent：分 * microPent：微分", "example": "pent" } ], "required": [ "InstanceId", "UpgradeType" ] }, { "name": "DescribeDatabaseObjects", "description": "本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-52s53yyh" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名称，通过 DescribeDatabases 接口获取。", "example": "product_db" } ], "required": [ "InstanceId", "DbName" ] }, { "name": "DescribeDatabaseTable", "description": "本接口（DescribeDatabaseTable）用于查询云数据库实例的表信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-52s53yyh" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名称，通过 DescribeDatabases 接口获取。", "example": "product_db" }, { "name": "Table", "type": "string", "required": true, "description": "表名称，通过 DescribeDatabaseObjects 接口获取。", "example": "persons" } ], "required": [ "InstanceId", "DbName", "Table" ] }, { "name": "DescribeDatabases", "description": "本接口（DescribeDatabases）用于查询云数据库实例的数据库列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "dcdbt-52s53yyh" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDcnDetail", "description": "获取实例灾备详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsqlshard-hqtjy5d1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeFileDownloadUrl", "description": "本接口(DescribeFileDownloadUrl)用于获取数据库指定备份或日志文件的下载连接。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "dbdc-1234abcd" }, { "name": "ShardId", "type": "string", "required": true, "description": "实例分片ID", "example": "shard-xxxx" }, { "name": "FilePath", "type": "string", "required": true, "description": "不带签名的文件路径", "example": "/cos_backup/xxx" } ], "required": [ "InstanceId", "ShardId", "FilePath" ] }, { "name": "DescribeFlow", "description": "本接口（DescribeFlow）用于查询流程状态", "status": "online", "parameters": [ { "name": "FlowId", "type": "integer", "required": true, "description": "异步请求接口返回的任务流程号。", "example": "3341" } ], "required": [ "FlowId" ] }, { "name": "DescribeInstanceSSLAttributes", "description": "本接口（DescribeInstanceSSLAttributes）用于拉取实例SSL认证属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsqlshard-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeLogFileRetentionPeriod", "description": "本接口(DescribeLogFileRetentionPeriod)用于查看数据库备份日志的备份天数的设置情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "dcdbt-ak4b3m9l" } ], "required": [ "InstanceId" ] }, { "name": "DescribeOnlineDDLJob", "description": "查询Online DDL 任务详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "tdsqlshard-8jbp1qpv" }, { "name": "FlowId", "type": "integer", "required": true, "description": "Online DDL 对应的流程Id。创建任务时，CreateOnlineDDLJob 会返回此流程Id", "example": "12357" } ], "required": [ "InstanceId", "FlowId" ] }, { "name": "DescribeOrders", "description": "本接口（DescribeOrders）用于查询分布式数据库订单信息。传入订单ID来查询订单关联的分布式数据库实例，和对应的任务流程ID。", "status": "online", "parameters": [ { "name": "DealNames", "type": "array", "required": true, "description": "待查询的长订单号列表，创建实例、续费实例、扩容实例接口返回。", "example": "[\"20181103110163\\r\\n\"]", "item_type": "string" } ], "required": [ "DealNames" ] }, { "name": "DescribeProcessList", "description": "本接口 (DescribeProcessList) 用于查询当前正在运行的线程（连接/查询）信息。 - 可以根据客户端IP，DB，执行时间等信息来查询实例正在运行的线程信息。过滤信息详细请见过滤器Filter。 - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的线程信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsqlshard-2gk4nxyz" }, { "name": "NodeId", "type": "string", "required": true, "description": "节点ID。", "example": "681390887981" }, { "name": "ShardId", "type": "string", "required": false, "description": "分片ID，与ShardSerialId设置一个。", "example": "shard-ljilb4st" }, { "name": "ShardSerialId", "type": "string", "required": false, "description": "分片序列ID，与ShardId设置一个。", "example": "set_1468379419_1" }, { "name": "Filters", "type": "array", "required": false, "description": "id 按照【会话ID】进行过滤。会话ID例如：125700。 类型：String 必选：否 匹配类型：精确匹配 user 按照【用户名】进行过滤。用户名例如：root。 类型：String 必选：否 匹配类型：精确匹配 host 按照【客户端Host】进行过滤。客户端Host例如：127.0.0.1:46295。 类型：String 必选：否 匹配类型：前缀匹配，例如可以查询客户端IP不加端口：127.0.0.1。 state 按照【线程状态】进行过滤。线程\ufffd...", "example": "[{\"Name\": \"user\", \"Values\": [\"root\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-2\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "InstanceId", "NodeId" ] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口（DescribeProjectSecurityGroups）用于查询项目安全组信息", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：dcdb。", "example": "dcdb" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。", "example": "11954" } ], "required": [ "Product" ] }, { "name": "DescribeProjects", "description": "本接口（DescribeProjects）用于查询项目列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeShardSpec", "description": "查询可创建的分布式数据库可售卖的分片规格配置。", "status": "online", "parameters": [ { "name": "CpuType", "type": "string", "required": false, "description": "Cpu类型，如：英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD", "example": "Intel/AMD" } ], "required": [] }, { "name": "DescribeUserTasks", "description": "本接口（DescribeUserTasks）用于拉取用户任务列表", "status": "online", "parameters": [ { "name": "Statuses", "type": "array", "required": false, "description": "任务的状态列表。0-任务启动中；1-任务运行中；2-任务成功；3-任务失败", "example": "[1,3]", "item_type": "integer" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID列表", "example": "[\"tdsqlshard-d7tnnu13\"]", "item_type": "string" }, { "name": "FlowTypes", "type": "array", "required": false, "description": "任务类型列表，当前支持的任务类型有：0-回档任务；1-创建实例任务；2-扩容任务；3-迁移任务；4-删除实例任务；5-重启任务", "example": "[1,2,3]", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "任务的创建时间", "example": "2024-12-14 16:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "任务的结束时间", "example": "2024-12-19 16:00:00" }, { "name": "UTaskIds", "type": "array", "required": false, "description": "任务ID的数组", "example": "[17122,17124]", "item_type": "integer" }, { "name": "Limit", "type": "integer", "required": false, "description": "每次最多返回多少条任务，取值范围为(0,100]，不传的话默认值为20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回任务默认是按照创建时间降序排列，从偏移值Offset处开始返回", "example": "0" } ], "required": [] }, { "name": "DestroyDCDBInstance", "description": "本接口(DestroyDCDBInstance)用于销毁已隔离的TDSQL包年包月实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-f35wr6wj" } ], "required": [ "InstanceId" ] }, { "name": "DestroyHourDCDBInstance", "description": "本接口（DestroyHourDCDBInstance）用于TDSQL销毁按量计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：dcdb。", "example": "dcdb" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组Id。", "example": "sg-xxxxxx" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表，一个或者多个实例Id组成的数组。", "example": "[\"tdsql-xxxxxx\\n\"]", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "FlushBinlog", "description": "相当于在所有分片的mysqld中执行flush logs，完成切分的binlog将展示在各个分片控制台binlog列表里。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "GrantAccountPrivileges", "description": "本接口（GrantAccountPrivileges）用于给云数据库账号赋权。 注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-ow728lmc" }, { "name": "UserName", "type": "string", "required": true, "description": "登录用户名。", "example": "user" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host，用户名+host唯一确定一个账号。", "example": "10.%" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名。如果为 \\*，表示查询全局权限（即 \\*.\\*），此时忽略 Type 和 Object 参数", "example": "product_db" }, { "name": "Privileges", "type": "array", "required": true, "description": "全局权限： 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，SHOW DATABASES，REPLICATION CLIENT，REPLICATION SLAVE 库权限： 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 \ufffd...", "example": "[\"SELECT\",\"INSERT\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": false, "description": "类型,可以填入 table 和 \\*。当 DbName 为具体数据库名，Type为 \\* 时，表示设置该数据库权限（即db.\\*），此时忽略 Object 参数", "example": "table" }, { "name": "Object", "type": "string", "required": false, "description": "具体的 Type 的名称，例如 Type 为 table 时就是具体的表名。DbName 和 Type 都为具体名称，则 Object 表示具体对象名，不能为 \\* 或者为空", "example": "prod_user_tbl" }, { "name": "ColName", "type": "string", "required": false, "description": "当 Type=table 时，ColName 为 \\* 表示对表授权，如果为具体字段名，表示对字段授权", "example": "username" } ], "required": [ "InstanceId", "UserName", "Host", "DbName", "Privileges" ] }, { "name": "InitDCDBInstances", "description": "本接口(InitDCDBInstances)用于初始化云数据库实例，包括设置默认字符集、表名大小写敏感等。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待初始化的实例ID列表，形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "[\"dcdbt-fdpjf5zh\\r\\n\",\"dcdbt-avw0207d\\r\\n\"]", "item_type": "string" }, { "name": "Params", "type": "array", "required": true, "description": "参数列表。本接口的可选值为：character_set_server（字符集，必传），lower_case_table_names（表名大小写敏感，必传，0 - 敏感；1-不敏感），innodb_page_size（innodb数据页，默认16K），sync_mode（同步模式：0 - 异步； 1 - 强同步；2 - 强同步可退化。默认为强同步）。", "example": "无", "item_type": "object", "children": [ { "name": "Param", "type": "string", "required": true, "description": "参数名称", "example": "autocommit" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "ON" } ] } ], "required": [ "InstanceIds", "Params" ] }, { "name": "IsolateDCDBInstance", "description": "本接口(IsolateDCDBInstance)用于隔离分布式数据库TDSQL实例（包年包月），隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：tdsqlshard-avw0207d，与云数据库控制台页面中显示的实例 ID 相同，可使用 查询实例列表 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "[\"tdsqlshard-pevrkilh\",\"tdsqlshard-0n6swl0t\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "IsolateDedicatedDBInstance", "description": "本接口（IsolateDedicatedDBInstance）用于隔离独享云数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 Id，形如：dcdbt-ow728lmc。", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "IsolateHourDCDBInstance", "description": "隔离TDSQL按量计费实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待升级的实例ID列表。形如：[\"dcdbt-ow728lmc\"]，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "[\"dcdbt-ow728lmc\",\"tdsqlshard-b0uoxwvh\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "KillSession", "description": "本接口（KillSession）用于杀死指定会话。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsqlshard-2gk4nxyz" }, { "name": "SessionId", "type": "array", "required": true, "description": "会话ID列表", "example": "[11917970, 11918810]", "item_type": "integer" }, { "name": "ShardId", "type": "string", "required": false, "description": "分片ID，与ShardSerialId设置一个", "example": "shard-ljilb4st" }, { "name": "ShardSerialId", "type": "string", "required": false, "description": "分片序列ID，与ShardId设置一个", "example": "set_1468379419_1" }, { "name": "NodeId", "type": "string", "required": false, "description": "节点ID，可指定主节点或者备节点进行kill。可选参数，不传默认为主节点。", "example": "681390887981" } ], "required": [ "InstanceId", "SessionId" ] }, { "name": "ModifyAccountConfig", "description": "修改账号的一些配置，比如 max_user_connections", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-kpkvq5oj，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-kpkvq5oj" }, { "name": "UserName", "type": "string", "required": true, "description": "账号的名称", "example": "user_ops" }, { "name": "Host", "type": "string", "required": true, "description": "账号的域名", "example": "%" }, { "name": "Configs", "type": "array", "required": true, "description": "配置列表，每一个元素是Config和Value的组合", "example": "无", "item_type": "object", "children": [ { "name": "Config", "type": "string", "required": true, "description": "配置项的名称，支持填写max_user_connections", "example": "max_user_connections" }, { "name": "Value", "type": "string", "required": true, "description": "配置值", "example": "1024" } ] } ], "required": [ "InstanceId", "UserName", "Host", "Configs" ] }, { "name": "ModifyAccountDescription", "description": "本接口（ModifyAccountDescription）用于修改云数据库账号备注。 注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "登录用户名。", "example": "testuser1" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host，用户名+host唯一确定一个账号。", "example": "172.17.%" }, { "name": "Description", "type": "string", "required": true, "description": "新的账号备注，长度 0~256。", "example": "用于测试的账号" } ], "required": [ "InstanceId", "UserName", "Host", "Description" ] }, { "name": "ModifyAccountPrivileges", "description": "本接口(ModifyAccountPrivileges)用于修改云数据库的账户的权限信息。 **注意** - 系统保留库：\"mysql\"，只开放[\"SELECT\"]权限 - 只读账号授予读写权限会报错 - 不传权限参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsql-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-f35wr6wj" }, { "name": "Accounts", "type": "array", "required": true, "description": "数据库的账号，包括用户名和域名。", "example": "无", "item_type": "object", "children": [ { "name": "User", "type": "string", "required": true, "description": "账户的名称", "example": "db_user" }, { "name": "Host", "type": "string", "required": true, "description": "账户的域名", "example": "%" } ] }, { "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\"。 注意，不传该参数表示保留现有权限，如需清除，该字段传空数组。", "example": "[\"SELECT\",\"SHOW DATABASES\"]", "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\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"ALTER\", \"INSERT\", \"CREATE\", \"SHOW VIEW\"]", "item_type": "string" }, { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" } ] }, { "name": "TablePrivileges", "type": "array", "required": false, "description": "数据库中表的权限。Privileges 权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"CREATE VIEW\",\"SHOW VIEW\", \"TRIGGER\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" }, { "name": "Table", "type": "string", "required": true, "description": "数据库表名", "example": "work_flow" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "['SELECT']", "item_type": "string" } ] }, { "name": "ColumnPrivileges", "type": "array", "required": false, "description": "数据库表中列的权限。Privileges 权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"REFERENCES\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" }, { "name": "Table", "type": "string", "required": true, "description": "数据库表名", "example": "work_flow" }, { "name": "Column", "type": "string", "required": true, "description": "数据库列名", "example": "input" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"SELECT\", \"ALTER\",\"CREATE\"]", "item_type": "string" } ] }, { "name": "ViewPrivileges", "type": "array", "required": false, "description": "数据库视图的权限。Privileges 权限的可选值为：\"SELECT\",\"INSERT\",\"UPDATE\",\"DELETE\",\"CREATE\", \"DROP\",\"REFERENCES\",\"INDEX\",\"ALTER\",\"CREATE VIEW\",\"SHOW VIEW\", \"TRIGGER\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" }, { "name": "View", "type": "string", "required": true, "description": "数据库视图名", "example": "work_view" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"SELECT\"]", "item_type": "string" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyBackupConfigs", "description": "本接口(ModifyBackupConfigs)用于修改数据库备份配置信息。 1. 修改数据库超期备份配置，目前按年、按月、按日只支持一种，存在互斥关系，如当前策略按年备份，如果传入按月备份策略将会覆盖当前的按年备份策略，务必注意。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqlshard-c1nl9rpv" }, { "name": "Days", "type": "integer", "required": false, "description": "常规备份存储时长，范围[1, 3650]。", "example": "30" }, { "name": "StartBackupTime", "type": "string", "required": false, "description": "每天备份执行的区间的开始时间，格式 mm:ss，形如 22:00。", "example": "03:00" }, { "name": "EndBackupTime", "type": "string", "required": false, "description": "每天备份执行的区间的结束时间，格式 mm:ss，形如 23:59。", "example": "05:59" }, { "name": "WeekDays", "type": "array", "required": false, "description": "执行备份周期，枚举值：Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday", "example": "[Saturday, Sunday]", "item_type": "string" }, { "name": "ArchiveDays", "type": "integer", "required": false, "description": "沉降到归档存储时长，-1表示关闭归档设置。", "example": "91" }, { "name": "BackupConfigSet", "type": "array", "required": false, "description": "超期备份配置。", "example": "无", "item_type": "object", "children": [ { "name": "EnableBackupPolicy", "type": "boolean", "required": true, "description": "备份策略是否启用。", "example": "true" }, { "name": "BeginDate", "type": "string", "required": true, "description": "超期保留开始日期，早于开始日期的超期备份不保留，格式：yyyy-mm-dd。", "example": "2023-05-30" }, { "name": "MaxRetentionDays", "type": "integer", "required": true, "description": "超期备份保留时长，超出保留时间的超期备份将被删除，可填写1-3650整数。", "example": "180" }, { "name": "Frequency", "type": "string", "required": true, "description": "备份模式，可选择按年月周模式保存 * 按年：annually * 按月：monthly * 按周：weekly", "example": "monthly" }, { "name": "WeekDays", "type": "array", "required": false, "description": "Frequency等于weekly时生效。 表示保留特定工作日备份。可选择周一到周日，支持多选，取星期英文： * 星期一 ：Monday * 星期二 ：Tuesday * 星期三：Wednesday * 星期四：Thursday * 星期五：Friday * 星期六：Saturday * 星期日：Sunday", "example": "Monday", "item_type": "string" }, { "name": "BackupCount", "type": "integer", "required": false, "description": "保留备份个数，Frequency等于monthly或weekly时生效。 备份模式选择按月时，可填写1-28整数； 备份模式选择年时，可填写1-336整数。", "example": "10" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyDBEncryptAttributes", "description": "本接口(ModifyDBEncryptAttributes)用于修改实例数据加密。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如：tdsqlshard-ow728lmc。", "example": "tdsqlshard-xxx" }, { "name": "EncryptEnabled", "type": "integer", "required": true, "description": "是否启用数据加密，开启后暂不支持关闭。本接口的可选值为：1-开启数据加密。", "example": "0" } ], "required": [ "InstanceId", "EncryptEnabled" ] }, { "name": "ModifyDBInstanceName", "description": "本接口（ModifyDBInstanceName）用于修改实例名字", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如tdsql-hdaprz0v", "example": "tdsql-xxx" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称", "example": "test-name" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口（ModifyDBInstanceSecurityGroups）用于修改云数据库安全组", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：dcdb。", "example": "dcdb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsqlshard-eb2w7dto" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。注意：该入参会全量替换存量已有安全组集合，并非增量更新。修改需传入全量的预期集合。", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" } ], "required": [ "Product", "InstanceId", "SecurityGroupIds" ] }, { "name": "ModifyDBInstancesProject", "description": "本接口（ModifyDBInstancesProject）用于修改云数据库实例所属项目。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待修改的实例ID列表。实例 ID 形如：dcdbt-ow728lmc。", "example": "[\"dcdbt-fdpjf5zh\\r\\n\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "要分配的项目 ID，可以通过 DescribeProjects 查询项目列表接口获取。", "example": "0" } ], "required": [ "InstanceIds", "ProjectId" ] }, { "name": "ModifyDBParameters", "description": "本接口(ModifyDBParameters)用于修改数据库参数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-ige1a5k3" }, { "name": "Params", "type": "array", "required": true, "description": "参数列表，每一个元素是Param和Value的组合", "example": "无", "item_type": "object", "children": [ { "name": "Param", "type": "string", "required": true, "description": "参数名称", "example": "autocommit" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "ON" } ] } ], "required": [ "InstanceId", "Params" ] }, { "name": "ModifyDBSyncMode", "description": "本接口（ModifyDBSyncMode）用于修改云数据库实例的同步模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待修改同步模式的实例ID。形如：dcdbt-ow728lmc。", "example": "dcdbt-avw0207d" }, { "name": "SyncMode", "type": "integer", "required": true, "description": "同步模式：0 异步，1 强同步， 2 强同步可退化", "example": "0" } ], "required": [ "InstanceId", "SyncMode" ] }, { "name": "ModifyInstanceNetwork", "description": "本接口（ModifyInstanceNetwork）用于修改实例所属网络。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-jv8z8fhl" }, { "name": "VpcId", "type": "string", "required": true, "description": "希望转到的VPC网络的VpcId", "example": "vpc-xxxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "希望转到的VPC网络的子网ID", "example": "subnet-xxxxx" }, { "name": "Vip", "type": "string", "required": false, "description": "如果需要指定VIP，填上该字段", "example": "10.0.0.1" }, { "name": "Vipv6", "type": "string", "required": false, "description": "如果需要指定VIPv6，填上该字段", "example": "2001:0000: 1F 1F :0000:0000:0100: 11A 0:ADDF" }, { "name": "VipReleaseDelay", "type": "integer", "required": false, "description": "VIP保留时长，单位小时，取值范围（0~168），0表示立即释放，有一分钟释放延迟。不传此参数，默认24小时释放VIP。", "example": "168" } ], "required": [ "InstanceId", "VpcId", "SubnetId" ] }, { "name": "ModifyInstanceProtectedProperty", "description": "该接口用于修改实例的保护属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "tdsqlshard-qoep98ai" }, { "name": "ProtectedProperty", "type": "integer", "required": true, "description": "0-允许删除，无销毁保护，1-禁止删除，有销毁保护", "example": "1" } ], "required": [ "InstanceId", "ProtectedProperty" ] }, { "name": "ModifyInstanceSSLAttributes", "description": "本接口 （ModifyInstanceSSLAttributes）用于修改实例SSL认证功能属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "无" }, { "name": "SSLEnabled", "type": "integer", "required": true, "description": "是否开启实例的SSL认证。0-关闭；1-开启", "example": "无" } ], "required": [ "InstanceId", "SSLEnabled" ] }, { "name": "ModifyInstanceVip", "description": "本接口（ModifyInstanceVip）用于修改实例Vip", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-jv8z8fhl" }, { "name": "Vip", "type": "string", "required": true, "description": "实例VIP", "example": "10.0.0.2" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "IPv6标志", "example": "0" }, { "name": "VipReleaseDelay", "type": "integer", "required": false, "description": "VIP保留时长，单位小时，取值范围（0~168），0表示立即释放，有一分钟释放延迟。不传此参数，默认24小时释放VIP。", "example": "164" } ], "required": [ "InstanceId", "Vip" ] }, { "name": "ModifyInstanceVport", "description": "本接口（ModifyInstanceVport）用于修改实例VPORT", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsqlshard-xxx" }, { "name": "Vport", "type": "integer", "required": true, "description": "实例VPORT", "example": "3307" } ], "required": [ "InstanceId", "Vport" ] }, { "name": "ModifyRealServerAccessStrategy", "description": "本接口(ModifyRealServerAccessStrategy)用于修改云数据库的VPCGW到RS的访问策略。 **注意** - 修改策略后只对新建立的连接生效，老连接不受影响 - 就近访问只针对实例是跨可用区部署有用，单可用区部署实例就近与否并无作用 - DB每个Node对应一个proxy，如果开启就近访问，将会把连接集中到对应可用区的proxy上，可能造成热点问题，这种情况下如果是线上业务，请务必根据自己的业务\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsqshard-f35wr6wj" }, { "name": "RsAccessStrategy", "type": "integer", "required": true, "description": "RS就近模式, 0-无策略, 1-可用区就近访问。", "example": "1" } ], "required": [ "InstanceId", "RsAccessStrategy" ] }, { "name": "OpenDBExtranetAccess", "description": "本接口（OpenDBExtranetAccess）用于开通云数据库实例的外网访问。开通外网访问后，您可通过外网域名和端口访问实例，可使用查询实例列表接口获取外网域名和端口信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待开放外网访问的实例ID。形如：dcdbt-ow728lmc。", "example": "dcdbt-avw0207d" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "是否IPv6，默认0", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "RenewDCDBInstance", "description": "本接口（RenewDCDBInstance）用于续费分布式数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待续费的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-avw0207d" }, { "name": "Period", "type": "integer", "required": true, "description": "续费时长，单位：月。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "false" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]\t", "item_type": "string" } ], "required": [ "InstanceId", "Period" ] }, { "name": "ResetAccountPassword", "description": "本接口（ResetAccountPassword）用于重置云数据库账号的密码。 注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow728lmc。", "example": "dcdbt-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "登录用户名。", "example": "testuser1" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host，用户名+host唯一确定一个账号。", "example": "172.17.%" }, { "name": "Password", "type": "string", "required": false, "description": "新密码，由字母、数字或常见符号组成，不能包含分号、单引号和双引号，长度为6~32位。", "example": "abcd8765_." }, { "name": "EncryptedPassword", "type": "string", "required": false, "description": "使用GetPublicKey返回的RSA2048公钥加密后的密码，加密算法是PKCS1v15", "example": "+5DzNPbJ5s6e/SkAFgMKQ4ezgmIyKqwHR/TtkwCQP5oFzYTpXJC6iEYVkAmlbreL8XX2I/YdNsqfy184B5sKt7LcfcvTCDspbQrDlRawvcWU0lLxvSpBgL4zXlixxOIR5UmC6lvSJFHOdMzoeK2UKGuV2EG3BMuvVthHAKaFDEQh5C5UP5FsN8G+Zsf27tofNm6KRFrQksNcYvFqMEnnGWV4luXISbJI0yK0m6kyKJSAgtHtDvsGBbJ1fA3RO1p5K/usvARNPB1jzjK5TJtG5eFDsPLXDHwiHh8clQpSLhYj531Ba1uXi9yL1Zkhoc0lf4y2xoJU3N+ce+6IAfJiaw==" } ], "required": [ "InstanceId", "UserName", "Host" ] }, { "name": "SwitchDBInstanceHA", "description": "本接口(SwitchDBInstanceHA)用于实例主备切换。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如 tdsql-ow728lmc。", "example": "tdsqlshard-b0uoxwvh" }, { "name": "Zone", "type": "string", "required": true, "description": "指定可用区标识符，具体含义由zoneMode参数决定。 - 当zoneMode为target时表示目标可用区 - 当zoneMode为avoid时表示需避开的故障可用区", "example": "ap-guangzhou-3" }, { "name": "ShardInstanceIds", "type": "array", "required": false, "description": "指定分片实例id进行切换", "example": "[\"shard-aq0o9glh\"]", "item_type": "string" }, { "name": "ZoneMode", "type": "string", "required": false, "description": "可用区模式选择器，定义zone参数的语义类型。 - 默认值：target - 可选值：target, avoid", "example": "target, avoid" } ], "required": [ "InstanceId", "Zone" ] }, { "name": "TerminateDedicatedDBInstance", "description": "本接口（TerminateDedicatedDBInstance）用于销毁已隔离的独享分布式数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 Id，形如：dcdbt-ow728lmc。", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeDCDBInstance", "description": "本接口（UpgradeDCDBInstance）用于升级分布式数据库实例。本接口完成下单和支付两个动作，如果发生支付失败的错误，调用用户账户相关接口中的支付订单接口（PayDeals）重新支付即可。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-fdpjf5zh" }, { "name": "UpgradeType", "type": "string", "required": true, "description": "升级类型，取值范围: ADD: 新增分片 EXPAND: 升级实例中的已有分片 SPLIT: 将已有分片中的数据切分到新增分片上", "example": "ADD" }, { "name": "AddShardConfig", "type": "object", "required": false, "description": "新增分片配置，当UpgradeType为ADD时生效。", "example": "无", "children": [ { "name": "ShardCount", "type": "integer", "required": true, "description": "新增分片的数量", "example": "1" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "ExpandShardConfig", "type": "object", "required": false, "description": "扩容分片配置，当UpgradeType为EXPAND时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": false, "description": "分片节点数", "example": "2" } ] }, { "name": "SplitShardConfig", "type": "object", "required": false, "description": "切分分片配置，当UpgradeType为SPLIT时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "SplitRate", "type": "integer", "required": true, "description": "数据切分比例，固定50%", "example": "50" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "false" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "变更部署时指定的新可用区列表，第1个为主可用区，其余为从可用区", "example": "[\"ap-guangzhou-3\", \"ap-guangzhou-4\"]", "item_type": "string" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，格式如: \"2019-12-12 07:00:00\"。开始时间必须在当前时间一个小时以后，3天以内。", "example": "2019-12-12 07:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换结束时间, 格式如: \"2019-12-12 07:15:00\"，结束时间必须大于开始时间。", "example": "2019-12-12 07:15:00" }, { "name": "SwitchAutoRetry", "type": "integer", "required": false, "description": "是否自动重试。 0：不自动重试 1：自动重试", "example": "1" } ], "required": [ "InstanceId", "UpgradeType" ] }, { "name": "UpgradeDedicatedDCDBInstance", "description": "本接口（UpgradeDedicatedDCDBInstance）用于升级TDSQL独享集群实例", "status": "online", "parameters": [ { "name": "UpgradeType", "type": "string", "required": true, "description": "升级类型，取值为ADD，SPLIT和EXPAND。ADD-添加分片；SPLIT-切分某个分片；EXPAND-垂直扩容某个分片", "example": "EXPAND" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如 dcdbt-mlfjm74h", "example": "dcdbt-mlfjm74h" }, { "name": "AddShardConfig", "type": "object", "required": false, "description": "当UpgradeType取值为ADD时，添加分片的配置参数", "example": "无", "children": [ { "name": "ShardCount", "type": "integer", "required": true, "description": "新增分片的数量", "example": "1" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "ExpandShardConfig", "type": "object", "required": false, "description": "当UpgradeType取值为EXPAND时，垂直扩容分片的配置参数", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": false, "description": "分片节点数", "example": "2" } ] }, { "name": "SplitShardConfig", "type": "object", "required": false, "description": "当UpgradeType取值为SPLIT时，切分分片的配置参数", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "SplitRate", "type": "integer", "required": true, "description": "数据切分比例，固定50%", "example": "50" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "SwitchAutoRetry", "type": "integer", "required": false, "description": "错过切换时间窗口时，是否自动重试一次，0-否，1-是", "example": "1" }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换时间窗口开始时间", "example": "2020-12-01 00:30:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换时间窗口结束时间", "example": "2020-12-01 00:45:00" } ], "required": [ "UpgradeType", "InstanceId" ] }, { "name": "UpgradeHourDCDBInstance", "description": "本接口（UpgradeHourDCDBInstance）用于升级分布式数据库TDSQL按量计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：dcdbt-ow728lmc，可以通过 DescribeDCDBInstances 查询实例详情获得。", "example": "dcdbt-ow728lmc" }, { "name": "UpgradeType", "type": "string", "required": true, "description": "升级类型，取值范围: ADD: 新增分片 EXPAND: 升级实例中的已有分片 SPLIT: 将已有分片中的数据切分到新增分片上", "example": "EXPAND" }, { "name": "AddShardConfig", "type": "object", "required": false, "description": "新增分片配置，当UpgradeType为ADD时生效。", "example": "无", "children": [ { "name": "ShardCount", "type": "integer", "required": true, "description": "新增分片的数量", "example": "1" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "ExpandShardConfig", "type": "object", "required": false, "description": "扩容分片配置，当UpgradeType为EXPAND时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" }, { "name": "ShardNodeCount", "type": "integer", "required": false, "description": "分片节点数", "example": "2" } ] }, { "name": "SplitShardConfig", "type": "object", "required": false, "description": "切分分片配置，当UpgradeType为SPLIT时生效。", "example": "无", "children": [ { "name": "ShardInstanceIds", "type": "array", "required": true, "description": "分片ID数组", "example": "[\"shard-xxxx\"]", "item_type": "string" }, { "name": "SplitRate", "type": "integer", "required": true, "description": "数据切分比例，固定50%", "example": "50" }, { "name": "ShardMemory", "type": "integer", "required": true, "description": "分片内存大小，单位 GB", "example": "2" }, { "name": "ShardStorage", "type": "integer", "required": true, "description": "分片存储大小，单位 GB", "example": "10" } ] }, { "name": "SwitchStartTime", "type": "string", "required": false, "description": "切换开始时间，格式如: \"2019-12-12 07:00:00\"。开始时间必须在当前时间一个小时以后，3天以内。", "example": "2019-12-12 07:00:00" }, { "name": "SwitchEndTime", "type": "string", "required": false, "description": "切换结束时间, 格式如: \"2019-12-12 07:15:00\"，结束时间必须大于开始时间。", "example": "2019-12-12 07:15:00" }, { "name": "SwitchAutoRetry", "type": "integer", "required": false, "description": "是否自动重试。 0：不自动重试 1：自动重试", "example": "1" }, { "name": "Zones", "type": "array", "required": false, "description": "变更部署时指定的新可用区列表，第1个为主可用区，其余为从可用区", "example": "[\"ap-guangzhou-3\",\"ap-guangzhou-4\"]", "item_type": "string" } ], "required": [ "InstanceId", "UpgradeType" ] } ] }