华为云用户手册

URI URI格式 GET https://{Endpoint}/v3/{project_id}/recycle-instances URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-instances 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 表2 Query参数 名称 是否必选 参数类型 说明 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 每页显示的数量，默认是100。

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 } ] }

响应消息 参数说明 表2 响应Body参数 参数 参数类型 说明 volumes Array of 表3 objects 磁盘信息列表。 表3 DiskVolumes 参数 参数类型 说明 entity_id String 实例ID或组ID或节点ID。 entity_name String 实例名称或组名称或节点名称。 group_type String group_type。取值范围： mongos，表示集群mongos节点类型。 shard，表示集群shard节点类型。 config，表示集群config节点类型。 replica，表示副本集类型。 single，表示单节点类型。 readonly，表示只读节点类型。 used String 使用量，保留两位小数，单位(GB)。 size String 总大小，单位(GB)。 响应示例 { "volumes" : [ { "entity_id" : "f04553d9ad2942e7a44facc518dc5699gr02", "entity_name" : "single01", "group_type" : "single", "used" : "3.18", "size" : "60" } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disk-usage URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/disk-usage 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 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 }

请求消息 参数说明 表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，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求示例 根据标签，按实例名称查询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" } ] }

响应消息 参数说明 状态码：202 表3 响应Body参数 参数 参数类型 说明 job_id String 工作流 id。 状态码：406 表4 响应Body参数 参数 参数类型 说明 ErrorResponse Array of 表5 objects 实例不是副本集或实例状态非“normal”，当前实例不允许此操作。 表5 ErrorResponse 参数 参数类型 说明 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 响应示例 状态码：202 { "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" }

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/replica-set/name URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0d248ca90800d3902f79c014f11df3b8/instances/593416e7c9da4a4c97c6ad5b086b8ddfin02/replica-set/name 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog-desensitization/status URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/e73893ef73754465a8bd2e0857bbf13ein02/slowlog-desensitization/status 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 否 数据库用户名称，默认为“rwuser”。 取值范围：长度为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格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/check-password URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/check-password

响应消息 参数说明 表3 响应Body参数 参数 参数类型 说明 jobs Array of 表5-5 objects 任务列表。 total_count Integer 任务列表总数。 表4 job 参数 参数类型 说明 id String 任务ID。 name String 任务名称。 instance_id String 实例ID。 instance_name String 实例名称。 status String 任务状态。取值为“Running”为执行中；取值为“Completed”为完成；取值为“Failed”为失败。 progress String 任务执行进度。 说明： 执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。任务执行进度。 fail_reason String 任务执行失败时的错误信息。 created_at String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 ended_at String 结束时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 响应示例 { "jobs": [ { "id": "2f406db7-bdc4-402f-9dc4-2c1b094a5f93", "name": "RestartReplicaSetInstance", "status": "Completed", "created_at": "2022-09-05T06:24:14+0000", "ended_at": "2022-09-05T06:25:43+0000", "progress": "", "instance_id": "1f311e6a299345d7bbc878874844e233in02", "instance_name": "dds-6be2-fwyrestore", "fail_reason": "" } ] }

响应消息 参数说明 表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" ] } ] }

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

请求示例 创建集群实例的Config组IP POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip { "type" : "config", "password" : "******" } 首次创建集群实例的Shard组IP POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip { "type" : "shard", "password" : "******" } 已经添加过Shard组IP的实例，开启新扩容的shard组IP POST https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/create-ip { "type" : "shard", "target_id" : "91bac9f23ead42e19013333e05f44829gr02", "password" : "******" }

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

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 type String 是 集群实例类型。 扩容Shard组时，取值为“shard”。 扩容Config组时，取值为“config”。 target_id String 否 Shard组ID 。 注意： 第一次添加Shard/Config IP时，该参数不传。 对于已经添加过Shard IP的实例，需要传入该参数为新扩容的Shard组添加IP。 password String 是 打开集群开关设置的密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 注意： 该密码暂不支持修改，请谨慎操作。

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

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 client_network_ranges Array of strings 是 客户端所在网段。 说明： 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。只有副本集有该功能。 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。 源端E CS 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/remark URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/remark

请求消息 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 upgrade_mode 否 String 升级模式。取值为“minimized_interrupt_time”为中断时间最短优先模式：升级过程对业务影响相对较小的升级方式取值为“minimized_upgrade_time”为升级时长最短优先模式：升级过程时长相对较快的升级方式。默认取值为“minimized_interrupt_time”。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-upgrade URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/db-upgrade 表1 请求参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求示例 副本集实例升级数据库补丁版本，升级模式为中断时间最短优先模式 POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/db-upgrade { "upgrade_mode" : "minimized_interrupt_time" }

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

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 ssl_option String 是 SSL开关选项。 取值： 取“0”，表示DDS实例不启用SSL连接。 取“1”，表示DDS实例启用SSL连接。 响应示例 { "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5", "ssl_option": "0" }

响应消息 参数说明 表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。