{ "name": "mariadb", "display_name": "云数据库 MariaDB", "description": "介绍如何使用API对云数据库MariaDB进行操作，包括查询云数据库可售卖地域和可用区信息、查看数据库参数等。", "domain": "database", "api_version": "2017-03-12", "endpoint": "mariadb.tencentcloudapi.com", "actions": [ { "name": "ActivateHourDBInstance", "description": "解隔离MariaDB按量计费实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表", "example": "[\"tdsql-rlye31jd\", \"tdsql-a8l2dwxb\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "AssociateSecurityGroups", "description": "本接口 (AssociateSecurityGroups) 用于安全组批量绑定云资源。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：mariadb。", "example": "mariadb" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "要绑定的安全组ID，类似sg-efil73jd。", "example": "sg-efil73jd" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被绑定的实例ID，类似tdsql-lesecurk，支持指定多个实例。", "example": "[\"tdsql-lesecurk\"]", "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": "CloneAccount", "description": "本接口（CloneAccount）用于克隆实例账户。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-6a0lwzzj" }, { "name": "SrcUser", "type": "string", "required": true, "description": "源用户账户名", "example": "testuser" }, { "name": "SrcHost", "type": "string", "required": true, "description": "源用户HOST", "example": "10.10.10.%" }, { "name": "DstUser", "type": "string", "required": true, "description": "目的用户账户名", "example": "testuser" }, { "name": "DstHost", "type": "string", "required": true, "description": "目的用户HOST", "example": "10.10.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。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-fdpjf5zh" }, { "name": "UserName", "type": "string", "required": true, "description": "账号名，账号名需要1-32个字符，由字母、数字或特殊字符组成；以字母开头；特殊字符为_-", "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": "账号备注，可以包含中文、英文字符、常见符号和数字，最多256个字符", "example": "测试账号" }, { "name": "DelayThresh", "type": "integer", "required": false, "description": "根据传入时间判断备机不可用", "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": "CreateDBInstance", "description": "本接口（CreateDBInstance）用于创建包年包月的MariaDB云数据库实例，可通过传入实例规格、数据库版本号、购买时长和数量等信息创建云数据库实例。", "status": "online", "parameters": [ { "name": "Zones", "type": "array", "required": true, "description": "实例节点可用区分布，可填写多个可用区。", "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-2\"]", "item_type": "string" }, { "name": "NodeCount", "type": "integer", "required": true, "description": "节点个数大小，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "2000" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储空间大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。", "example": "10000" }, { "name": "Period", "type": "integer", "required": false, "description": "欲购买的时长，单位：月。", "example": "1" }, { "name": "Count", "type": "integer", "required": false, "description": "欲购买的数量，默认查询购买1个实例的价格。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "true" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]", "item_type": "string" }, { "name": "VpcId", "type": "string", "required": false, "description": "虚拟私有网络 ID，不传表示创建为基础网络", "example": "vpc-qdiqptn3" }, { "name": "SubnetId", "type": "string", "required": false, "description": "虚拟私有网络子网 ID，VpcId 不为空时必填", "example": "subnet-0r3bgq4c" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，可以通过查看项目列表获取，不传则关联到默认项目", "example": "1077641" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "数据库引擎版本，当前可选：8.0，5.7，10.1。", "example": "8.0" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称， 可以通过该字段自主的设置实例的名字", "example": "tdsql_MariaDB" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID列表", "example": "[\"sg-5ozc4vtq\"]", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志，1:自动续费，2:不自动续费", "example": "1" }, { "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": "project" }, { "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": "tdsql-8lmkqnkb" }, { "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", "NodeCount", "Memory", "Storage" ] }, { "name": "CreateDedicatedClusterDBInstance", "description": "创建Mariadb独享集群实例", "status": "online", "parameters": [ { "name": "GoodsNum", "type": "integer", "required": true, "description": "分配实例个数", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "內存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "磁盘大小，单位GB", "example": "10" }, { "name": "ClusterId", "type": "string", "required": true, "description": "独享集群集群uuid", "example": "dbdc-56nsyijj" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "网络Id", "example": "vpc-qdiqptn3" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网Id", "example": "subnet-f3nhaeyg" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "db类型，不传默认8.0", "example": "8.0" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID", "example": "[\"sg-qra0l3rt\"]", "item_type": "string" }, { "name": "DcnInstanceId", "type": "string", "required": false, "description": "DCN源实例ID", "example": "tdsql-jfsr9ytl" }, { "name": "DcnRegion", "type": "string", "required": false, "description": "DCN源实例地域名", "example": "ap-guangzhou" }, { "name": "InstanceName", "type": "string", "required": false, "description": "自定义实例名称", "example": "tdsql_maraidb" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键key", "example": "project" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值value", "example": "tdsql50" } ] }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "支持IPv6标志：1 支持， 0 不支持", "example": "0" }, { "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": "NodeNum", "type": "integer", "required": false, "description": "实例节点数", "example": "2" }, { "name": "MasterHostId", "type": "string", "required": false, "description": "指定主节点uuid，不填随机分配", "example": "svr-xxxx" }, { "name": "SlaveHostIds", "type": "array", "required": false, "description": "指定从节点uuid，不填随机分配", "example": "[\"svr-xxxx\"]", "item_type": "string" }, { "name": "RollbackInstanceId", "type": "string", "required": false, "description": "需要回档的源实例ID", "example": "tdsql-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", "Memory", "Storage", "ClusterId" ] }, { "name": "CreateHourDBInstance", "description": "创建MariaDB按量计费实例", "status": "online", "parameters": [ { "name": "Zones", "type": "array", "required": true, "description": "节点可用区分布，可填写多个可用区。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" }, { "name": "NodeCount", "type": "integer", "required": true, "description": "节点个数", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "储存大小，单位：GB", "example": "10" }, { "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": "vpc-n2vdqxdx" }, { "name": "SubnetId", "type": "string", "required": false, "description": "统一子网ID，VpcId有值时需填写", "example": "subnet-j2ezrypg" }, { "name": "DbVersionId", "type": "string", "required": false, "description": "数据库引擎版本，当前可选：8.0，5.7，10.1。", "example": "5.7" }, { "name": "InstanceName", "type": "string", "required": false, "description": "自定义实例名称", "example": "实例名称" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID，不传表示不绑定安全组", "example": "[\"sg-123456\"]", "item_type": "string" }, { "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": "project" }, { "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": "tdsql-123456" }, { "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，例如“2021-11-22 00:00:00”", "example": "tdsql-dup8gl6t" }, { "name": "RollbackTime", "type": "string", "required": false, "description": "回档时间", "example": "2021-11-22 00:00:00" }, { "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", "NodeCount", "Memory", "Storage" ] }, { "name": "CreateTmpInstances", "description": "本接口（CreateTmpInstances）用于创建临时实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "回档实例的ID列表，形如：tdsql-ow728lmc。", "example": "[\"tdsql-arryr5nt\\r\\n\"]", "item_type": "string" }, { "name": "RollbackTime", "type": "string", "required": true, "description": "回档时间点", "example": "2019-04-06 12:31:10" } ], "required": [ "InstanceIds", "RollbackTime" ] }, { "name": "DeleteAccount", "description": "本接口（DeleteAccount）用于删除云数据库账号。用户名+host唯一确定一个账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-fdpjf5zh" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupConfigs", "description": "本接口(DescribeBackupConfigs)用于查询数据库备份配置信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsql-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsql-c1nl9rpv" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupFiles", "description": "本接口(DescribeBackupFiles)用于查看备份文件列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "按实例ID查询", "example": "tdsql-muad49ep" }, { "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": "DescribeBackupTime", "description": "本接口（DescribeBackupTime）用于获取云数据库的备份时间。后台系统将根据此配置定期进行实例备份。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "[\"tdsql-fdpjf5zh\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeBinlogTime", "description": "本接口（DescribeBinlogTime）用于查询可回档时间范围。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-arryr5nt" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBEncryptAttributes", "description": "本接口(DescribeDBEncryptAttributes)用于查询实例数据加密状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如：tdsql-ow728lmc。", "example": "tdsql-59a1o2nd" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceDetail", "description": "本接口(DescribeDBInstanceDetail)用于查询指定实例的详细信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id形如：tdsql-ow728lmc。", "example": "tdsql-jv8z8fhl" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceSpecs", "description": "本接口(DescribeDBInstanceSpecs)用于查询可创建的云数据库可售卖的规格配置。", "status": "online", "parameters": [ { "name": "CpuType", "type": "string", "required": false, "description": "Cpu类型，如：英特尔：Intel/AMD，海光：Hygon，默认Intel/AMD", "example": "Intel/AMD" } ], "required": [] }, { "name": "DescribeDBInstances", "description": "本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。 如果不指定任何筛选条件，则默认返回20条实例记录，单次请求最多支持返回100条实例记录。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。", "example": "[\"tdsql-722d255z\\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": "tdsql-13qobrt9" }, { "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-975ql47u" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络的子网 ID， IsFilterVpc 为 1 时有效", "example": "subnet-bgo1rfsq" }, { "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": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "OriginSerialIds", "type": "array", "required": false, "description": "按 OriginSerialId 查询", "example": "[\"set_1700103903_101644246\"]", "item_type": "string" }, { "name": "IsFilterExcluster", "type": "boolean", "required": false, "description": "标识是否使用ExclusterType字段, false不使用，true使用", "example": "false" }, { "name": "ExclusterType", "type": "integer", "required": false, "description": "实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部", "example": "0" }, { "name": "ExclusterIds", "type": "array", "required": false, "description": "按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9", "example": "[\"dbdc-4ih6uct9\"]", "item_type": "string" }, { "name": "TagKeys", "type": "array", "required": false, "description": "按标签key查询", "example": "[\"负责人\", \"备份负责人\"]", "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": "DescribeDBLogFiles", "description": "本接口(DescribeDBLogFiles)用于获取数据库的各种日志列表，包括冷备、binlog、errlog和slowlog。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-ow728lmc" }, { "name": "Type", "type": "integer", "required": true, "description": "请求日志类型，取值只能为1、2、3或者4。1-binlog，2-冷备，3-errlog，4-slowlog。", "example": "1" } ], "required": [ "InstanceId", "Type" ] }, { "name": "DescribeDBParameters", "description": "本接口(DescribeDBParameters)用于获取数据库的当前参数设置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-ige1a5k3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBSecurityGroups", "description": "本接口（DescribeDBSecurityGroups）用于查询实例安全组信息", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：mariadb。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsql-eb2w7dto" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeDBSlowLogs", "description": "本接口(DescribeDBSlowLogs)用于查询慢查询日志列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-ige1a5k3" }, { "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": "2017-08-06 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询的结束时间，形如2016-08-22 14:55:20", "example": "2017-08-07 23:59:59" }, { "name": "Db", "type": "string", "required": false, "description": "要查询的具体数据库名称", "example": "db" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序指标，取值为query_time_sum或者query_count", "example": "query_time_sum" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序类型，desc或者asc", "example": "desc" }, { "name": "Slave", "type": "integer", "required": false, "description": "是否查询从机的慢查询，0-主机; 1-从机", "example": "1" } ], "required": [ "InstanceId", "Offset", "Limit", "StartTime" ] }, { "name": "DescribeDBSyncMode", "description": "本接口（DescribeDBSyncMode）用于查询云数据库实例的同步模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：tdsql-ow728lmc", "example": "tdsql-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBTmpInstances", "description": "本接口（DescribeDBTmpInstances）用于获取实例回档生成的临时实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-oc5srykh" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDatabaseObjects", "description": "本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：dcdbt-ow7t8lmc。", "example": "tdsql-e9tklsgz" }, { "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": "tdsql-e9tklsgz" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名称，通过 DescribeDatabases 接口获取。", "example": "product_db" }, { "name": "Table", "type": "string", "required": true, "description": "表名称，通过 DescribeDatabaseObjects 接口获取。", "example": "region" } ], "required": [ "InstanceId", "DbName", "Table" ] }, { "name": "DescribeDatabases", "description": "本接口（DescribeDatabases）用于查询云数据库实例的数据库列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-e9tklsgz。", "example": "tdsql-e9tklsgz" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDcnDetail", "description": "获取实例灾备详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-ohjuvzgt" } ], "required": [ "InstanceId" ] }, { "name": "DescribeFileDownloadUrl", "description": "本接口(DescribeFileDownloadUrl)用于获取数据库指定备份或日志文件的下载连接。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-1234abcd" }, { "name": "FilePath", "type": "string", "required": true, "description": "不带签名的文件路径", "example": "/cos_backup/xxx" } ], "required": [ "InstanceId", "FilePath" ] }, { "name": "DescribeFlow", "description": "本接口（DescribeFlow）用于查询流程状态。", "status": "online", "parameters": [ { "name": "FlowId", "type": "integer", "required": true, "description": "异步请求接口返回的任务流程号。", "example": "3340" } ], "required": [ "FlowId" ] }, { "name": "DescribeInstanceNodeInfo", "description": "本接口（DescribeInstanceNodeInfo）用于获取数据库实例主备节点信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如tdsql-6ltok4u9", "example": "tdsql-b43f8yjl" }, { "name": "Limit", "type": "integer", "required": false, "description": "一次最多返回多少条数据。默认为无穷大，返回符合要求的所有数据", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "返回数据的偏移量，默认为0", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceSSLAttributes", "description": "本接口（DescribeInstanceSSLAttributes）用于拉取实例SSL认证属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeLogFileRetentionPeriod", "description": "本接口(DescribeLogFileRetentionPeriod)用于查看数据库备份日志的备份天数的设置情况。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-ige1a5k3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeOrders", "description": "本接口（DescribeOrders）用于查询云数据库订单信息。传入订单ID来查询订单关联的云数据库实例，和对应的任务流程ID。", "status": "online", "parameters": [ { "name": "DealNames", "type": "array", "required": true, "description": "待查询的长订单号列表，创建实例、续费实例、扩容实例接口返回。", "example": "[\"20171103110035\\r\\n\"]", "item_type": "string" } ], "required": [ "DealNames" ] }, { "name": "DescribePrice", "description": "本接口（DescribePrice）用于在购买实例前，查询实例的价格。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "欲新购实例的可用区ID。", "example": "ap-guangzhou-2" }, { "name": "NodeCount", "type": "integer", "required": true, "description": "实例节点个数，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "2000" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储空间大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。", "example": "10000" }, { "name": "Period", "type": "integer", "required": false, "description": "欲购买的时长，单位：月。", "example": "1" }, { "name": "Count", "type": "integer", "required": false, "description": "欲购买的数量，默认查询购买1个实例的价格。", "example": "1" }, { "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", "NodeCount", "Memory", "Storage" ] }, { "name": "DescribeProcessList", "description": "本接口 (DescribeProcessList) 用于查询当前正在运行的线程（连接/查询）信息。 - 可以根据客户端IP，DB，执行时间等信息来查询实例正在运行的线程信息。过滤信息详细请见过滤器Filter。 - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的线程信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsql-2gk4nxyz" }, { "name": "NodeId", "type": "string", "required": true, "description": "节点ID。", "example": "681390887981" }, { "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": "数据库引擎名称，本接口取值：mariadb。", "example": "mariadb" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。", "example": "1" } ], "required": [ "Product" ] }, { "name": "DescribeRenewalPrice", "description": "本接口（DescribeRenewalPrice）用于在续费云数据库实例时，查询续费的价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待续费的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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": "DescribeSaleInfo", "description": "本接口(DescribeSaleInfo)用于查询云数据库可售卖的地域和可用区信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeUpgradePrice", "description": "本接口（DescribeUpgradePrice）用于在扩容云数据库实例时，查询变配的价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-fdpjf5zh" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "2000" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储空间大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。", "example": "20000" }, { "name": "NodeCount", "type": "integer", "required": false, "description": "新节点数，传0表示节点数不变", "example": "0" }, { "name": "AmountUnit", "type": "string", "required": false, "description": "价格金额单位，不传默认单位为分，取值： * pent：分 * microPent：微分", "example": "pent" } ], "required": [ "InstanceId", "Memory", "Storage" ] }, { "name": "DestroyDBInstance", "description": "本接口(DestroyDBInstance)用于销毁已隔离的包年包月实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsqlshard-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsql-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "DestroyHourDBInstance", "description": "本接口（DestroyHourDBInstance）用于销毁MariaDB按量计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsql-avw0207d，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsql-avw0207d" } ], "required": [ "InstanceId" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：mariadb。", "example": "mariadb" }, { "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，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-ow728lmc" }, { "name": "UserName", "type": "string", "required": true, "description": "登录用户名。", "example": "username" }, { "name": "Host", "type": "string", "required": true, "description": "用户允许的访问 host，用户名+host唯一确定一个账号。", "example": "10.%" }, { "name": "DbName", "type": "string", "required": true, "description": "数据库名。如果为 \\*，表示设置全局权限（即 \\*.\\*），此时忽略 Type 和 Object 参数。当DbName不为\\*时，需要传入参 Type。", "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 、 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", "Privileges" ] }, { "name": "InitDBInstances", "description": "本接口(InitDBInstances)用于初始化云数据库实例，包括设置默认字符集、表名大小写敏感等。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待初始化的实例ID列表，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "[\"tdsql-fdpjf5zh\\r\\n\",\"tdsql-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": "IsolateDBInstance", "description": "本接口(IsolateDBInstance)用于隔离云数据库MariaDB实例（包年包月），隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行充值。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID，格式如：tdsql-dasjkhd，与云数据库控制台页面中显示的实例 ID 相同，可使用 查询实例列表 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "[\"tdsql-dasjkhd\",\"tdsql-e6ddrouh\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "IsolateDedicatedDBInstance", "description": "本接口（IsolateDedicatedDBInstance）用于隔离独享云数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 Id，形如：tdsql-ow728lmc。", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "IsolateHourDBInstance", "description": "隔离MariaDB按量计费实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表", "example": "[\"tdsql-cq3ndzu7\",\"tdsql-7xp6kuvb\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "KillSession", "description": "本接口（KillSession）用于杀死指定会话。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-2gk4nxyz" }, { "name": "SessionId", "type": "array", "required": true, "description": "会话ID列表", "example": "[11917970, 11918810]", "item_type": "integer" }, { "name": "NodeId", "type": "string", "required": false, "description": "节点ID，可指定主节点或者备节点进行kill。可选参数，不传默认为主节点。", "example": "681390887981" } ], "required": [ "InstanceId", "SessionId" ] }, { "name": "ModifyAccountDescription", "description": "本接口（ModifyAccountDescription）用于修改云数据库账号备注。 注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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": "tdsql-1or2l5kz" }, { "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" } ] }, { "name": "FunctionPrivileges", "type": "array", "required": false, "description": "数据库函数的权限。Privileges 权限的可选值为：\"ALTER ROUTINE\"，\"EXECUTE\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" }, { "name": "FunctionName", "type": "string", "required": true, "description": "数据库函数名", "example": "work_func" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"EXECUTE\"]", "item_type": "string" } ] }, { "name": "ProcedurePrivileges", "type": "array", "required": false, "description": "数据库存储过程的权限。Privileges 权限的可选值为：\"ALTER ROUTINE\"，\"EXECUTE\"。 注意，不传该参数表示保留现有权限，如需清除，请在复杂类型Privileges字段传空数组。", "example": "无", "item_type": "object", "children": [ { "name": "Database", "type": "string", "required": true, "description": "数据库名", "example": "pre_oss" }, { "name": "Procedure", "type": "string", "required": true, "description": "数据库存储过程名", "example": "work_procedure" }, { "name": "Privileges", "type": "array", "required": true, "description": "权限信息", "example": "[\"SELECT\",\"DELETE\",\"CREATE\"]", "item_type": "string" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyBackupConfigs", "description": "本接口(ModifyBackupConfigs)用于修改数据库备份配置信息。 1. 修改数据库超期备份配置，目前按年、按月、按日只支持一种，存在互斥关系，如当前策略按年备份，如果传入按月备份策略将会覆盖当前的按年备份策略，务必注意。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsql-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsql-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": "ModifyBackupTime", "description": "本接口（ModifyBackupTime）用于设置云数据库实例的备份时间。后台系统将根据此配置定期进行实例备份。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-fdpjf5zh" }, { "name": "StartBackupTime", "type": "string", "required": true, "description": "每天备份执行的区间的开始时间，格式 mm:ss，形如 22:00", "example": "03:00" }, { "name": "EndBackupTime", "type": "string", "required": true, "description": "每天备份执行的区间的结束时间，格式 mm:ss，形如 23:59", "example": "05:59" } ], "required": [ "InstanceId", "StartBackupTime", "EndBackupTime" ] }, { "name": "ModifyDBEncryptAttributes", "description": "本接口(ModifyDBEncryptAttributes)用于修改实例数据加密。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如：tdsql-ow728lmc。", "example": "tdsql-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-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-fdpjf5zh" }, { "name": "InstanceName", "type": "string", "required": true, "description": "新的实例名称。允许的字符为字母、数字、下划线、连字符和中文。", "example": "newname" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口（ModifyDBInstanceSecurityGroups）用于修改云数据库安全组", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：mariadb。", "example": "mariadb" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "tdsql-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 形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "[\"tdsql-fdpjf5zh\"]", "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，形如：tdsql-ow728lmc。", "example": "tdsql-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。形如：tdsql-ow728lmc。", "example": "tdsql-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": "tdsql-quidk8ji" }, { "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": "tdsql-aks3di5h" }, { "name": "SSLEnabled", "type": "integer", "required": true, "description": "是否开启实例的SSL认证。0-关闭；1-开启", "example": "1" } ], "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": "168" } ], "required": [ "InstanceId", "Vip" ] }, { "name": "ModifyInstanceVport", "description": "本接口（ModifyInstanceVport）用于修改实例VPORT", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-2gk4nxyz" }, { "name": "Vport", "type": "integer", "required": true, "description": "实例VPORT", "example": "3307" } ], "required": [ "InstanceId", "Vport" ] }, { "name": "ModifyLogFileRetentionPeriod", "description": "本接口(ModifyLogFileRetentionPeriod)用于修改数据库备份日志保存天数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc。", "example": "tdsql-ige1a5k3" }, { "name": "Days", "type": "integer", "required": true, "description": "保存的天数,不能超过30", "example": "29" } ], "required": [ "InstanceId", "Days" ] }, { "name": "ModifyRealServerAccessStrategy", "description": "本接口(ModifyRealServerAccessStrategy)用于修改云数据库的VPCGW到RS的访问策略。 **注意** - 修改策略后只对新建立的连接生效，老连接不受影响 - 就近访问只针对实例是跨可用区部署有用，单可用区部署实例就近与否并无作用 - DB每个Node对应一个proxy，如果开启就近访问，将会把连接集中到对应可用区的proxy上，可能造成热点问题，这种情况下如果是线上业务，请务必根据自己的业务\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：tdsql-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "tdsql-jfsr9ytl" }, { "name": "RsAccessStrategy", "type": "integer", "required": true, "description": "RS就近模式, 0-无策略, 1-可用区就近访问。", "example": "0" } ], "required": [ "InstanceId", "RsAccessStrategy" ] }, { "name": "ModifySyncTaskAttribute", "description": "本接口 (ModifySyncTaskAttribute) 用于修改同步任务的属性（目前只支持修改任务名称）", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": true, "description": "一个或多个待操作的任务ID。可通过DescribeSyncTasks API返回值中的TaskId获取。每次请求允许操作的任务数量上限是100。", "example": "100", "item_type": "string" }, { "name": "TaskName", "type": "string", "required": false, "description": "任务名称。可任意命名，但不得超过100个字符。", "example": "taskname" } ], "required": [ "TaskIds" ] }, { "name": "OpenDBExtranetAccess", "description": "本接口（OpenDBExtranetAccess）用于开通云数据库实例的外网访问。开通外网访问后，您可通过外网域名和端口访问实例，可使用查询实例列表接口获取外网域名和端口信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待开放外网访问的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-avw0207d" }, { "name": "Ipv6Flag", "type": "integer", "required": false, "description": "是否为IPV6网络类型实例，0:否，1:是，不传默认为0表示实例为IPV4网络类型", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "RenewDBInstance", "description": "本接口（RenewDBInstance）用于续费云数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待续费的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-avw0207d" }, { "name": "Period", "type": "integer", "required": true, "description": "续费时长，单位：月。", "example": "1" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "true" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表，目前仅支持指定一张代金券。", "example": "[\"ZRPCQJGMYSYV73IYOTFJD8\"]", "item_type": "string" } ], "required": [ "InstanceId", "Period" ] }, { "name": "ResetAccountPassword", "description": "本接口（ResetAccountPassword）用于重置云数据库账号的密码。 注意：相同用户名，不同Host是不同的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-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": "密码需要 8\\~32 个字符，不能以 '/' 开头，并且至少包含字母、数字和特殊字符 ()~!@#$%^\u0026*-+=_|{}[]:,.?/ 中的两项", "example": "abcd8765_." }, { "name": "EncryptedPassword", "type": "string", "required": false, "description": "使用GetPublicKey返回的RSA2048公钥加密后的密码", "example": "MTIzNDU2Nzg5MTA=" } ], "required": [ "InstanceId", "UserName", "Host" ] }, { "name": "RestartDBInstances", "description": "本接口（RestartDBInstances）用于重启数据库实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID的数组", "example": "[\"tdsql-fdpjf5zh\\r\\n\"]", "item_type": "string" }, { "name": "RestartTime", "type": "string", "required": false, "description": "重启时间", "example": "2021-04-20 15:00:00" } ], "required": [ "InstanceIds" ] }, { "name": "SwitchDBInstanceHA", "description": "本接口（SwitchDBInstanceHA）用于发起实例主备切换。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id，形如 tdsql-ow728lmc", "example": "tdsql-ow728lmc" }, { "name": "Zone", "type": "string", "required": true, "description": "指定可用区标识符，具体含义由zoneMode参数决定。 - 当zoneMode为target时表示目标可用区 - 当zoneMode为avoid时表示需避开的故障可用区", "example": "ap-guangzhou-3" }, { "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，形如：tdsql-ow728lmc。", "example": "tdsql-xxx" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeDBInstance", "description": "本接口(UpgradeDBInstance)用于扩容云数据库实例。本接口完成下单和支付两个动作，如果发生支付失败的错误，调用用户账户相关接口中的支付订单接口（PayDeals）重新支付即可。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例详情获得。", "example": "tdsql-avw0207d" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得。", "example": "2000" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储空间大小，单位：GB，可以通过 DescribeDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。", "example": "20000" }, { "name": "AutoVoucher", "type": "boolean", "required": false, "description": "是否自动使用代金券进行支付，默认不使用。", "example": "true" }, { "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", "Memory", "Storage" ] }, { "name": "UpgradeDedicatedDBInstance", "description": "本接口(UpgradeDedicatedDBInstance)用于扩容独享云数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待升级的实例ID。形如：tdsql-ow728lmc，可以通过 DescribeDBInstances 查询实例获得。", "example": "tdsql-2gk4nxyz" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB，可以通过 DescribeFenceDBInstanceSpecs 查询实例规格获得。", "example": "4" }, { "name": "Storage", "type": "integer", "required": true, "description": "存储空间大小，单位：GB，可以通过 DescribeFenceDBInstanceSpecs 查询实例规格获得不同内存大小对应的磁盘规格下限和上限。", "example": "100" }, { "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": [ "InstanceId", "Memory", "Storage" ] }, { "name": "UpgradeHourDBInstance", "description": "升级MariaDB按量计费实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "tdsql-cq3ndzu7" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB", "example": "2" }, { "name": "Storage", "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-1\", \"ap-guangzhou-2\"]", "item_type": "string" } ], "required": [ "InstanceId", "Memory", "Storage" ] } ] }