华为云用户手册

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switch-ssl URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switch-ssl

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 参数解释： 从 IAM 服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 project_id string path 是 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id string path 是 参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover

URI URI格式 GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community

请求消息 请求参数 表1 参数说明 名称 类型 IN 必选 描述 x-auth-token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 engine_name string query 否 数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。

响应消息 参数说明 表10 参数说明 名称 参数类型 是否必选 描述 id String 否 实例ID。 name String 否 实例名称，与请求参数相同。 datastore Object 否 数据库信息，与请求参数相同。详情请参见表11。 created String 否 创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。 status String 否 实例状态，取值为“creating”。 region String 否 区域ID，与请求参数相同。 availability_zone String 否 可用区ID，与请求参数相同。 vpc_id String 否 虚拟私有云ID，与请求参数相同。 subnet_id String 否 子网ID，与请求参数相同。 security_group_id String 否 实例所属的安全组ID列表，与请求参数相同。 port Integer 否 数据库访问端口。 disk_encryption_id String 否 磁盘加密的密钥ID，与请求参数相同。 mode String 否 实例类型，与请求参数相同。 configurations Array of objects 否 参数组配置信息。 详情请参见表12。 flavor Array of objects 否 实例规格详情，与请求参数相同。详情请参见表6。 backup_strategy Object 否 高级备份策略，与请求参数相同。详情请参见表7。 enterprise_project_id String 否 企业项目ID。取值为“0”，表示为default企业项目。 dss_pool_id String 否 Dec用户专属存储ID。 job_id String 否 创建实例的工作流ID。 ssl_option String 否 SSL开关选项，与请求参数相同。 tags Array of objects 否 标签列表，与请求参数相同。 详情请参见表15。 order_id String 否 创建实例的订单ID，仅创建包年包月实例时返回该参数。 charge_info Object 否 付费方式信息，与请求参数相同。 详情请参见表16。 表11 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表12 configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 枚举值： mongos shard config replica single configuration_id String 是 参数组id。 表13 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 num String 是 节点数量或组数量。 取值： type取值“mongos”，num表示集群实例下mongos节点的数量，取值2~16。 type取值“shard”，num表示集群实例下shard组的数量，取值2~16。 type取值“config”，num表示集群实例下config组的数量，只能取值1。 type取值“replica”，num表示副本集实例下副本节点的数量，可取值3，5，7。 type取值“single”，num表示单节点实例下节点的数量，只能取值1。 storage String 否 磁盘类型。 size String 否 磁盘大小。 对于除mongos外的其他节点，该参数必选。mongos节点下，该参数无意义。 取值：必须为10的整数倍。单位为GB。 对于集群实例，shard组可取10GB~2000GB，config组仅可取20GB。mongos节点不涉及选择磁盘，该参数无意义。 对于副本集实例，可取10GB~3000GB。 对于单节点实例，可取10GB~1000GB。 spec_code String 是 资源规格编码。获取方法请参见查询数据库规格中响应参数“spec_code”的值。 集群实例下，需要指定多个规格，要求所有规格的系列一致，均为通用型（s6）、增强型（c3）、或增强Ⅱ型（c6）。 示例： dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.large.4.config是同一规格系列。 dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.config不是同一规格系列。 表14 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 不传该参数，默认的备份时间段不传该参数，默认的备份时间段为00:00-01:00。 取值示例： 23:00-00:00 keep_days String 否 指定已生成的备份文件可以保存的天数。 取值范围：0~732。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表15 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。最大长度36个unicode字符。 key不能为空，不能为空字符串，不能重复。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 是 标签值。最大长度43个unicode字符。 可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表16 charge_info字段数据结构说明 参数 参数类型 是否必选 描述 charge_mode String 是 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 否 订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num Integer 否 “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew Boolean 否 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围： true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay Boolean 否 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 响应示例中参数“region”和“availability_zone”的值为示例值。 响应示例 集群实例： { "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:34:36", "status": "creating", "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": "2", "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.medium.4.shard", "size": "20" }, { "type": "config", "num": "1", "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.large.2.config", "size": "20" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "tags" : [{ "key" : "dds001", "value" : "dds001" }] }

请求示例 集群根据备份文件恢复到新实例： { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "server_group_policies": [ "anti-affinity" ], "tags": [ { "key": "dds001", "value": "dds001" } ] } 副本集根据备份文件恢复到新实例： { "name": "test-replicaset", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "ReplicaSet", "configurations": [ { "type": "replica", "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "replica", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.s2.medium.4.shard" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 单节点根据备份文件恢复到新实例： { "name": "test-singlenode", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Single", "configurations": [ { "type": "single", "configuration_id": "b8e962e66ede47609a94cba591735b49pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "single", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.c6.medium.4.single" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 副本集根据时间点恢复到新实例： { "name": "replica-liuyunj1", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "dcdadabc-efed-4518-8b34-4af66fcd97e7", "subnet_id": "4a9348f2-f232-4700-a440-2f1641d80960", "security_group_id": "c57b9db2-cccb-4c0d-b058-7ea51dda0c99", "mode": "ReplicaSet", "flavor": [ { "type": "replica", "num": 1, "storage": "ULTRAHIGH", "size": 100, "spec_code": "dds.mongodb.c6.large.2.repset" } ], "backup_strategy": { "start_time": "08:00-09:00", "keep_days": "8" }, "restore_point": { "instance_id": "d5833c2854a4486cb7960f829269e211in02", "type": "timestamp", "restore_time": 1607689584000 }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 name String 是 实例名称。 用于表示实例的名称，允许和已有名称重复。 实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。 datastore Object 是 数据库信息。详情请参见表3。 region String 是 区域ID。 取值：非空，请参见地区和终端节点。 availability_zone String 是 可用区ID。 取值：非空，请参见地区和终端节点。 vpc_id String 是 虚拟私有云ID。 获取方法请参见《虚拟私有云API参考》中“VPC”的内容。 取值：非空，字符长度校验，严格UUID正则校验。 subnet_id String 是 子网ID。 获取方法请参见《虚拟私有云API参考》中“子网”的内容。 security_group_id String 是 指定实例所属的安全组ID列表。 最多支持添加10个安全组ID，安全组ID之间用英文逗号隔开。 获取方法如下： 获取方法请参见《虚拟私有云API参考》中“安全组”的内容。 port String 否 数据库访问端口。 端口有效范围：2100~65535（不包括12017和33071）。 不传该参数时，创建实例的访问端口默认为8635。 password String 否 数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 不传该参数时，实例创建完成后，如需连接实例，请先为实例设置密码，具体请参见重置管理员密码。 disk_encryption_id String 否 磁盘加密时的密钥ID，严格UUID正则校验。 不传该参数时，表示不进行磁盘加密。 mode String 是 实例类型。支持集群和副本集。 取值： Sharding ReplicaSet configurations Array of objects 否 参数组配置信息。详情请参见表5。 不传该参数时，表示为系统默认参数组。 flavor Array of objects 是 实例规格详情。详情请参见表6。 获取方法请参见查询数据库规格中参数的值。 restore_point Object 是 恢复到新实例备份信息详情。详情请参见表4。 backup_strategy Object 否 高级备份策略。详情请参见表7。 enterprise_project_id String 否 企业项目ID。 对于未开通企业多项目服务的用户，不传该参数。 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。 获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 ssl_option String 否 SSL开关选项。 取值： 取“0”，表示DDS实例默认不启用SSL连接。 取“1”，表示DDS实例默认启用SSL连接。 不传该参数时，默认启用SSL连接。 dss_pool_id String 否 Dec用户专属存储ID，默认为空。仅Dec用户支持该参数。 server_group_policies Array of strings 否 Dec用户云服务器组关联的策略名称列表。取值包括： 取“anti-affinity”，表示DDS实例开启反亲和部署，反亲和部署是出于高可用性考虑，将您的Primary、Secondary和Hidden节点分别创建在不同的物理机上。 DEC用户不传该参数时，默认不开启反亲和部署。仅DEC用户支持该参数。 tags Array of objects 否 标签列表。 单个实例总标签数上限20个。详情请参见表8。 charge_info Object 否 计费类型信息，支持包年包月和按需计费，默认为按需计费。 详情请参见表9。 表3 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表4 restore_point字段数据结构说明 名称 参数类型 是否必选 描述 instance_id String 否 实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 当type为“backup”，为非必选。 当type为“timestamp”，为必选。 type String 否 恢复方式，枚举值： “backup”，表示使用备份文件恢复，按照此方式恢复时，当“type”字段为非必选时，“backup_id”必选。 “timestamp”，表示按时间点恢复，按照此方式恢复时，当“type”字段必选时，“restore_time”必选。 backup_id String 否 用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 说明： 当“type”字段为非必选时，“backup_id”必选。 restore_time Integer 否 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 说明： 当“type”字段必选时，“restore_time”必选。 表5 configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 枚举值： mongos shard config replica single configuration_id String 是 参数组id。 表6 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 num String 是 节点数量。 取值： 集群实例下“shard”类型不传该参数。 集群实例下“mongos”类型的节点数量可取2~32。 “config”类型的组数量只能取1。 “replica”类型的组数量只能取1。 “single”类型的节点数量只能取1。 storage String 否 磁盘类型。 取值：ULTRAHIGH，表示SSD。 对于集群实例的shard和config节点、副本集、以及单节点实例，该参数有效。mongos节点不涉及选择磁盘，该参数无意义。 size String 否 磁盘大小。 取值：必须为10的整数倍。单位为GB。 对于集群实例，shard组可取10GB~2000GB，并且大于等于原实例的磁盘大小，config组仅可取20GB。mongos节点不涉及选择磁盘，该参数无意义。 对于副本集实例，可取10GB~3000GB，并且大于等于原实例的磁盘大小。 对于单节点实例，可取10GB~1000GB，并且大于等于原实例的磁盘大小。 spec_code String 是 资源规格编码。获取方法请参见查询数据库规格中参数“spec_code”的值。 表7 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 23:00-00:00 keep_days String 否 指定已生成的备份文件可以保存的天数。 取值范围：0~732。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表8 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。最大长度36个unicode字符。 key不能为空，不能为空字符串，不能重复。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 是 标签值。最大长度43个unicode字符。 可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表9 charge_info字段数据结构说明 参数 参数类型 是否必选 描述 charge_mode String 是 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 否 订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num Integer 否 “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew Boolean 否 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围： true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay Boolean 否 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 请求示例中参数“region”和“availability_zone”的值为示例值。

文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 查询实例列表 GET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} dds:instance:list √ √ 删除实例 DELETE /v3/{project_id}/instances/{instance_id} dds:instance:deleteInstance √ √ 重启实例 POST /v3/{project_id}/instances/{instance_id}/restart dds:instance:reboot √ √ 扩容实例存储容量 POST /v3/{project_id}/instances/{instance_id}/enlarge-volume dds:instance:extendVolume √ √ 扩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/enlarge dds:instance:extendNode vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 变更实例规格 POST /v3/{project_id}/instances/{instance_id}/resize dds:instance:modifySpec √ √ 切换副本集实例的主备节点 POST /v3/{project_id}/instances/{instance_id}/switchover dds:instance:switchover √ √ 切换SSL开关 POST/v3/{project_id}/instances/{instance_id}/switch-ssl dds:instance:modifySSL √ √ 修改实例名称 PUT /v3/{project_id}/instances/{instance_id}/modify-name dds:instance:modify √ √ 修改数据库端口 POST /v3/{project_id}/instances/{instance_id}/modify-port dds:instance:modifyPort √ √ 变更实例安全组 POST /v3/{project_id}/instances/{instance_id}/modify-security-group dds:instance:modifySecurityGroup √ √ 绑定弹性公网IP POST /v3/{project_id}/nodes/{node_id}/bind-eip dds:instance:bindPublicIp √ √ 解绑弹性公网IP POST /v3/{project_id}/nodes/{node_id}/unbind-eip dds:instance:unbindPublicIp √ √ 修改实例内网地址 POST /v3/{project_id}/instances/{instance_id}/modify-internal-ip dds:instance:modifyVIP √ √ 打开集群的Shard/Config IP开关 POST /v3/{project_id}/instances/{instance_id}/create-ip dds:instance:createIp √ √ 查询实例可迁移到的可用区 GET /v3/{project_id}/instances/{instance_id}/migrate/az dds:instance:migrate √ √ 实例可用区迁移 POST /v3/{project_id}/instances/{instance_id}/migrate dds:instance:migrate √ √ 表2 连接管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询实例节点会话 GET /v3/{project_id}/nodes/{node_id}/sessions dds:instance:session √ √ 终结实例节点会话 POST /v3/{project_id}/nodes/{node_id}/session dds:instance:session √ √ 查询实例节点连接数统计 GET /v3/{projectId}/instances/{instance_id}/conn-statistics dds:instance:list √ √ 表3 备份与恢复 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建手动备份 POST /v3/{project_id}/backups dds:instance:createManualBackup √ √ 删除手动备份 DELETE /v3/{project_id}/backups/{backups_id} dds:backup:delete √ √ 查询备份列表 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}&mode={mode} dds:backup:list √ √ 查询自动备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/policy dds:instance:list √ √ 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy dds:instance:modifyBackupPolicy √ √ 恢复到新实例 POST /v3/{project_id}/instances dds:instance:create vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get √ √ 获取备份下载链接 GET /v3/{projectId}/backups/download-file dds:backup:download √ √ 查询可恢复的时间段 GET /v3/{project_id}/instances/{instance_id}/restore-time dds:instance:list √ √ 获取可恢复的数据库列表 GET /v3/{project_id}/instances/{instance_id}/restore-database dds:instance:list √ √ 获取可恢复的数据库集合列表 GET /v3/{project_id}/instances/{instance_id}/restore-collection dds:instance:list √ √ 恢复到当前实例 POST /v3/{project_id}/instances/recovery dds:backup:refreshInstanceFromBackup √ √ 库表级时间点恢复 POST /v3/{project_id}/instances/{instance_id}/restore/collections dds:backup:refreshInstanceFromBackup √ √ 表4 参数配置 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取参数模板列表 GET /v3/{project_id}/configurations dds:param:list √ √ 创建参数模板 PUT /v3/{project_id}/configurations dds:param:create √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} dds:param:delete √ √ 获取参数模板的详情 GET /v3/{projectId}/configurations/{configId} dds:param:list √ √ 修改参数模板 PUT /v3/{project_id}/configurations/{config_id} dds:param:modify √ √ 应用参数模板 PUT /v3/{project_id}/configurations/{config_id}/apply dds:instance:modifyParameter √ √ 获取指定实例的参数信息 GET /v3/{project_id}/instances/{instance_id}/configurations dds:param:list √ √ 修改指定实例的参数 PUT /v3/{project_id}/instances/{instance_id}/configurations dds:instance:modifyParameter √ √ 表5 获取日志信息 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog dds:instance:list √ √ 获取慢日志下载链接 POST /v3/{project_id}/instances/{instance_id}/slowlog-download dds:instance:list √ √ 查询数据库错误日志 GET /v3/{project_id}/instances/{instance_id}/errorlog dds:instance:list √ √ 获取错误日志下载链接 POST /v3/{project_id}/instances/{instance_id}/errorlog-download dds:instance:list √ √ 设置审计日志策略 POST /v3/{project_id}/instances/{instance_id}/auditlog-policy dds:instance:modifyAuditLogSwitch √ √ 查询审计日志策略 GET /v3/{project_id}/instances/{instance_id}/auditlog-policy dds:instance:list √ √ 查询审计日志列表 GET /v3/{project_id}/instances/{instance_id}/auditlog dds:instance:list √ √ 获取审计日志下载链接 POST /v3/{project_id}/instances/{instance_id}/auditlog-links dds:instance:downloadAuditLog √ √ 表6 标签管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 批量添加或删除资源标签 POST /v3/{project_id}/instances/{instance_id}/tags/action dds:instance:modify √ √ 查询资源标签 GET /v3/{project_id}/instances/{instance_id}/tags dds:instance:list √ √ 表7 管理数据库和用户 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db-user dds:instance:createDatabaseUser √ √ 创建数据库角色 POST /v3/{project_id}/instances/{instance_id}/db-role dds:instance:createDatabaseRole √ √ 删除数据库用户 DELETE /v3/{project_id}/instances/{instance_id}/db-user dds:instance:deleteDatabaseUser √ √ 删除数据库角色 DELETE /v3/{project_id}/instances/{instance_id}/db-role dds:instance:deleteDatabaseRole √ √ 修改数据库用户密码 PUT /v3/{project_id}/instances/{instance_id}/reset-password dds:instance:resetPasswd √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db-user/detail? offset ={offset}&limit={limit}&user_name={user_name }&db_name={db_name} dds:instance:get √ √ 查询数据库角色列表 GET /v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit} dds:instance:get √ √ 查询和设置集群均衡器 GET /v3/{project_id}/instances/{instance_id}/balancer PUT /v3/{project_id}/instances/{instance_id}/balancer/{action} PUT /v3/{project_id}/instances/{instance_id}/balancer/active-window dds:instance:balancer √ √ “√”表示支持，“x”表示暂不支持。 父主题： 权限策略和授权项

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见IAM与企业管理的区别。 DDS支持的自定义策略授权项请参见文档数据库服务授权项说明。

响应消息 参数说明 表2 参数说明 名称 是否必选 参数类型 描述 tags 是 Array of objects 标签列表。详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 描述 key 是 String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 values 是 Array of strings 标签值列表。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 响应示例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ] }

响应消息 参数说明 表2 参数说明 名称 是否必选 参数类型 描述 tags 是 Array of objects 实例标签列表。详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 描述 key 是 String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 响应示例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 project_id string path 是 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id string path 是 参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 批量添加2个标签 { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key", "value": "value3" } ] } 批量删除2个标签 { "action": "delete", "tags": [ { "key": "key1" }, { "key": "key2", "value": "value3" } ] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 action String 是 操作标识。取值： create，表示添加标签。 delete，表示删除标签。 tags Array of objects 是 标签列表。详情请参见表3。 说明： 删除标签时，不对该参数做字符集校验。 表3 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value String 否 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/tags/action

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 offset String 否 索引位置偏移量，表示从第一条数据偏移offset条数据后开始查询。 “action”值为“count”时，不传该参数。 “action”值为“filter”时，取值必须为数字，不能为负数。默认取0值，表示从第一条数据开始查询。 limit String 否 查询记录数。 “action”值为“count”时，不传该参数。 “action”值为“filter”时，取值范围：1~100。不传该参数时，默认查询前100条实例信息。 action String 是 操作标识。 取值为“filter”，表示根据标签过滤条件查询实例。 取值为“count”，表示仅返回总记录数，禁止返回其他字段。 matches Array of objects 否 搜索字段。 该字段值为空，表示不按照实例名称或实例ID查询。 该字段值不为空，具体值请参见表4。 tags Array of objects 否 包含标签，最多包含20个key。详情请参见表3。 表3 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 说明： 搜索时不对该参数做字符集校验。 values Array of strings 是 标签值列表。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 如果values为空列表，则表示查询任意value。value之间为或的关系。 表4 matches字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 取值为“instance_name”或“instance_id”，分别表示按实例名称或按实例ID匹配查询。 value String 是 待匹配的实例名称或实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

响应消息 参数说明 表5 参数说明 名称 参数类型 描述 instances Array of objects 实例列表。详情请参见表6。 total_count Integer 总记录数。 表6 instance字段数据结构说明 名称 参数类型 描述 instance_id String 实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 instance_name String 实例名称。 tags Array of objects 标签列表。如果没有标签，默认为空数组。详情请参见表7。 表7 tags字段数据结构说明 名称 参数类型 描述 key String 标签键。 key不能为空，长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 _sys_开头属于系统标签，租户不能输入。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value String 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 可以为空（empty or null），长度0~255个半角字符。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 响应示例 根据标签返回指定实例： { "instances": [ { "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02", "instance_name": "test-single", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ] } 返回总记录数： { "total_count": 4 }

请求示例 根据标签，按实例名称查询1~100条指定实例信息 { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "instance_name", "value": "test-single" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } 按照实例名称或按实例ID查询总记录数 { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "instance_name", "value": "test-single" }, { "key": "instance_id", "value": "958693039f284d6ebfb177375711072ein02" } ] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backup_policy Object 是 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。 表3 backup_policy字段数据结构说明 名称 参数类型 是否必选 描述 keep_days String 否 指定已生成的备份文件可以保存的天数。keep_days或enable_incremental_backup至少传其中一个参数。 取值范围：0～732。取0值，表示关闭备份策略，包括自动备份策略和增量备份策略。 start_time String 否 备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 23:00-00:00 period String 否 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下： 0天，不传该参数。 1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。 7～732天，备份周期至少选择一周中的一天。示例：1,2,3,4。 enable_incremental_backup Boolean 否 增量备份开关。不传这个参数则不对增备状态进行改动。开启增量备份后，系统会自动进行增量备份。增量备份开关的取值和约束如下： false，代表关闭增量备份，关闭会将之前做的增量备份清理。 true，代表开启增量备份，开启增量备份会触发一次全量备份。

请求示例 开启或修改自动备份策略，并开启增量备份策略： PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : true } } 开启或修改自动备份策略，并关闭增量备份策略 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : false } } 仅开启或修改自动备份策略，增量备份策略状态保持不变 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7" } } 开启增量备份策略，需要在有自动全备策略情况下才能下发，关闭增量备份策略同理 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "enable_incremental_backup" : true } } 关闭备份策略，包括自动备份策略和增量备份策略 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 0 } }

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 project_id string path 是 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id string path 是 参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 请求示例 备份策略开启，包括自动备份策略和增量备份策略： GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : true } } 自动备份策略开启，但增量备份策略关闭： GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : false } } 备份策略关闭，包括自动备份策略和增量备份策略： GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 0 } }

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backup_policy Object 是 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。 表3 backup_policy字段数据结构说明 名称 参数类型 是否必选 描述 keep_days Integer 是 备份文件可以保存的天数。 start_time String 否 备份时间段。自动备份将在该时间段内触发。 period String 否 备份周期配置。自动备份将在每星期指定的天进行。 enable_incremental_backup Boolean 否 是否开启增量备份。true：表示增量备份策略为开启状态；false：表示增量备份策略为关闭状态。 响应示例 状态码： 200 Success. { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : true } }

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backups Array of objects 是 备份列表。详情请参见表3。 total_count Integer 是 总记录数。 表3 backups字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 备份ID。 name String 是 备份名称。 instance_id String 是 备份所属的实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 instance_name String 是 备份所属的实例名称。 datastore Object 是 数据库版本信息。详情请参见表4。 type String 是 备份类型。 取值为“Auto”，表示自动全量备份。 取值为“Manual”，表示手动全量备份。 取值为“Incremental”，表示自动增量备份。 begin_time String 是 备份开始时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 end_time String 是 备份结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 status String 是 备份状态。取值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 DISABLED：备份删除中。 size Long 是 备份大小，单位：KB。 description String 是 备份描述。 表4 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库引擎。 取值：DDS-Community。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 响应示例 { "backups": [ { "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "backup-test", "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name": "cluster-test", "datastore" : { "type" : "DDS-Community", "version" : "3.4" }, "type": "auto", "begin_time": "2018-08-06 12:41:14", "end_time": "2018-08-06 12:43:14", "status": "COMPLETED", "size": 2803, "description": "backup description" } ], "total_count":1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}&mode={mode} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

请求示例 创建一个数据库实例的手动备份，名称为mybackup1，描述为The first Manual backup { "backup":{ "instance_id": "a89dab5e39394eccbdb77b19d57b0180in02", "name": "mybackup1", "description": "The first Manual backup" } }

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 手动备份的异步任务ID。 backup_id String 是 手动备份ID。 响应示例 { "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec", "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02" }