华为云用户手册

URI URI格式 POST https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/slow-logs URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slow-logs

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

响应消息 参数说明 表2 响应Body参数 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version String 数据库版本。 datastore_name String 数据库类型。 description String 参数模板描述。 created String 创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置。 请参见表3。 表3 parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 description String 参数描述。 type String 参数类型.。 取值为“integer”，“string”，“boolean”，“float”或“list”。 value_range String 参数值范围。 如integer取值0-1，boolean取值true/false等。 restart_required Boolean 参数是否需要重启。 取值为“true”，需要重启。 取值为“false”，不需要重启。 readonly Boolean 是否只读。 取值为“true”，只读参数。 取值为“false”，非只读参数。 响应示例 { "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name": "paramsGroup-test", "description": "", "datastore_name": "mongodb", "datastore_version": "4.0", "created": "2017-01-01T10:00:00", "updated": "2017-01-01T10:00:00", "parameters": [ { "name": "cursorTimeoutMillis", "type": "integer", "value": 600000, "description": "设置空闲游标的超期时间，DDS将删除空闲的游标", "value_range": "600000-1000000", "restart_required": false, "readonly": false } ] }

响应消息 参数说明 表3 响应Body参数 名称 参数类型 描述 total_count Integer 总记录数。 configurations Array of objects 参数模板列表。请参见表4。 表4 configurations字段数据结构说明 参数 参数类型 描述 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 datastore_version String 数据库版本。 datastore_name String 数据库类型。 node_type String 参数模板节点类型。 mongos，表示集群mongos节点类型。 shard，表示集群shard节点类型。 config，表示集群config节点类型。 replica，表示副本集类型。 readonly，表示副本集只读节点类型。 shard_readonly，表示集群只读节点类型。 single，表示单节点类型。 created String 创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 user_defined Boolean 是否是用户自定义参数模板。 取值为“false”，表示为系统默认参数模板。 取值为“true”，表示为用户自定义参数模板。 响应示例 { "total_count" : 1, "configurations" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name" : "test1", "description" : "", "datastore_name" : "mongos", "node_type":"shard", "datastore_version" : "4.0", "created" : "2017-01-01T10:00:00", "updated" : "2017-01-01T10:00:00", "user_defined" : true } ] }

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

请求示例 恢复数据库级备份，数据库名称为test { "restore_collections": [ { "database": "test", "restore_database_time": 1607762955000 } ] } 恢复集合级备份，恢复前表名为test { "restore_collections": [ { "database": "test", "collections": [ { "old_name": "test", "restore_collection_time": 1607762955000 } ] } ] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 restore_collections Array of objects 是 数据库信息。 请参见表3。 表3 restore_collections字段数据结构说明 名称 参数类型 是否必选 描述 database String 是 数据库名称。 collections Array of objects 否 集合信息。 请参见表4。 restore_database_time String 否 数据库恢复时间点。 如果是数据库级恢复，该参数必传， UNIX时间戳格式，单位是毫秒，时区是UTC。 表4 collections字段数据结构说明 名称 参数类型 是否必选 描述 old_name String 是 恢复前表名。 new_name String 否 恢复后表名。 restore_collection_time String 是 数据库集合恢复时间点。 UNIX时间戳格式，单位是毫秒，时区是UTC。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore/collections URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore/collections

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 source Object 是 恢复数据源对象。 请参见表3。 target Object 是 恢复目标对象。 请参见表4。 表3 source字段数据结构说明 名称 参数类型 是否必选 描述 instance_id String 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 type String 否 表示恢复方式，枚举值： “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。 “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。 backup_id String 否 用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 restore_time String 否 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 说明： 目前该参数只适用于副本集实例。 表4 target字段数据结构说明 名称 参数类型 是否必选 描述 instance_id String 是 恢复目标实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求示例 使用备份文件恢复，恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } } 根据时间点恢复（适用于副本集实例和4.0版本的集群实例），恢复目标实例ID为d8e6ca5a624745bcb546a227aa3ae1cfin02 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin02" } }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&restore_time={restore_time}&offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&restore_time=1607689584000&limit=10&offset=0

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 collections Array of objects 是 集合列表，列表中每个元素表示一个集合。 total_count Integer 是 集合总数。 表3 参数说明 名称 参数类型 是否必选 描述 name String 是 集合名称。 响应示例 { "collections": [ "dds-test" ], "total_count": 1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-database?restore_time={restore_time}&offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-database?restore_time=1607689584000&limit=10&offset=1

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 restore_time Array of objects 是 可恢复时间段列表，请参见表3。 表3 restore_time字段参数说明 名称 参数类型 是否必选 描述 start_time Long 是 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Long 是 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 响应示例 { "restore_time": [ { "start_time": 1607731200000, "end_time": 1607756414000 }, { "start_time": 1607756825000, "end_time": 1607761999000 }, { "start_time": 1607762943000, "end_time": 1607817599000 } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从 IAM 服务获取的用户Token。请参考认证鉴权。 Content-Type string header 是 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Language string header 否 语言。 project_id string path 是 项目ID。请参考获取项目ID章节获取项目编号。 instance_id String path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 date string query 是 所需查询的日期，为yyyy-mm-dd字符串格式,时区为UTC。

操作步骤 删除DDS实例。 接口相关信息 URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} {Endpoint}信息请从地区和终端节点获取。 URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02 详情请参见删除实例。 请求示例 无。 响应示例 { "job_id": "252f11f1-2912-4c06-be55-1999bde659c5" }

操作步骤 修改DDS实例名称。 接口相关信息 URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name {Endpoint}信息请从地区和终端节点获取。 URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name 详情请参见修改实例名称。 请求示例 { "new_instance_name": "myNewName" } 响应示例 {}

操作步骤 指定limit与offset查询DDS实例列表。 接口相关信息 URI格式：GET https://{Endpoint}/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} {Endpoint}信息请从地区和终端节点获取。 {limit}可根据DDS实例数据调整。 详情请参见查询实例列表和详情。 请求示例 根据指定limit与offset查询DDS实例列表 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=1 响应示例 根据指定limit与offset查询DDS实例列表： { "instances": [ { "id": "8436a91546294036b75931e879882200in02", "name": "dds-efa6", "status": "normal", "port": 8635, "mode": "ReplicaSet", "region": "aaa", "datastore": { "type": "DDS-Community", "version": "3.4" }, "engine": "wiredTiger", "created": "2019-01-17T07:05:52", "updated": "2019-01-17T07:05:47", "db_user_name": "rwuser", "ssl": "1", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "backup_strategy": { "start_time": "16:00-17:00", "keep_days": 7 }, "pay_mode": "0", "maintenance_window": "02:00-06:00", "groups": [ { "type": "replica", "volume": { "size": "10", "used": "0.33" }, "nodes": [ { "id": "233eaac9c6f245c0bb9c2d21eea12d1bno02", "name": "dds-efa6_replica_node_2", "status": "normal", "role": "Primary", "private_ip": "192.168.0.174", "public_ip": "", "spec_code": "dds.mongodb.s2.medium.4.repset", "availability_zone": "bbb" }, { "id": "d57d76d6320a4a7b86db82c317550c4ano02", "name": "dds-efa6_replica_node_1", "status": "normal", "role": "Hidden", "private_ip": "192.168.0.39", "public_ip": "", "spec_code": "dds.mongodb.s2.medium.4.repset", "availability_zone": "bbb" }, { "id": "f46b0a1cf4d9400e9fd7af17f8742d37no02", "name": "dds-efa6_replica_node_3", "status": "normal", "role": "Secondary", "private_ip": "192.168.0.176", "public_ip": "", "spec_code": "dds.mongodb.s2.medium.4.repset", "availability_zone": "bbb" } ] } ], "enterprise_project_id": "0", "time_zone": "", "actions": [ ] } ], "total_count": 24 } 汇总查询结果。 参考1持续调用，如果查询的DDS实例列表为空，或者返回的body体中不存在instances字段，表明所有DDS实例查询完成。 汇总所有查询到的DDS实例即当前查询条件下的所有DDS实例。

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 否 数据库用户名称。 默认为“rwuser”用户，也支持“sharduser”、“csuser”用户。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 user_pwd String 是 数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 db_name String 否 数据库名称，默认为“admin”。

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

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 roles String 是 数据库角色信息。 注意： 返回格式按照数据库原生格式返回，需要用户解析。 total_count Integer 是 数据库角色总数。 响应示例 { "total_count": 1, "roles": "[{\"privileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"inheritedPrivileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"role\":\"userAdmin\",\"roles\":[],\"inheritedRoles\":[],\"isBuiltin\":true,\"db\":\"admin\"}]" }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit} URI样例 查询数据库角色列表： https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles 根据指定条件查询角色列表 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles?role_name=testRole&db_name=testDb&offset=0&limit=100

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user/detail?offset ={offset}&limit={limit}&user_name={user_name }&db_name={db_name} URI样例 查询数据库用户列表： https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-user/detail 根据指定条件查询用户列表 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-user/detail?offset=0&limit=100&user_name=test&db_name=testDb

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 users String 是 数据库用户信息。 注意： 返回格式按照数据库原生格式返回，需要用户解析。 total_count Integer 是 数据库用户总数。 响应示例 { "total_count": 1, "users": "[{\"inheritedPrivileges\":[{\"resource\":{\"collection\":\"temproles\",\"db\":\"admin\"},\"actions\":[\"find\"]}],\"roles\":[{\"role\":\"root\",\"db\":\"admin\"}],\"inheritedRoles\":[{\"role\":\"root\",\"db\":\"admin\"}],\"_id\":\"admin.rwuser\",\"user\":\"rwuser\",\"db\":\"admin\"}]" }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 role_name String 是 创建角色名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 roles Array of objects 否 新建角色所继承的角色列表。请参见表3。 db_name String 否 角色所在的数据库名称，默认admin。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 表3 roles字段数据结构说明 名称 参数类型 是否必选 描述 role_db_name String 是 被继承角色所在数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 role_name String 是 被继承角色的名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-role URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/db-role

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 是 数据库用户名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 用户名不能为内部保留用户：drsFull，drsIncremental。 user_pwd String 是 数据库用户密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 roles Array of Object 是 新用户所拥有的角色。请参见表3。 roles限制了该账户所具有的权限。若指定一个空数组，表示该账户不具有任何权限。 db_name String 否 新用户所在的数据库，默认为“admin”。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 表3 roles字段数据结构说明 名称 参数类型 是否必选 描述 role_db_name String 是 授予新用户所拥有的角色所在数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 role_name String 是 授予新用户所拥有的角色名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

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