华为云用户手册

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之间。 源端ECS连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。

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

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

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

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

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/histories URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/341bc383a3e24221a94c4ad0b4547e8apr02/histories?offset=0&limit=10

响应消息 参数说明 表4 响应Body参数 参数 参数类型 说明 histories Array of 表5-5 objects 参数模板的修改历史列表。 表5 HistoryInfo 参数 参数类型 说明 parameter_name String 参数名称 old_value String 修改前的值。 new_value String 修改后的值。 updated_at String 修改时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 响应示例 { "histories" : [ { "parameter_name" : "rateLimit.mbps", "old_value" : "500", "new_value" : "350", "updated_at" : "2022-06-07T09:25:45+0000" } ] }

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

请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 num 否 Integer 删除的节点数量。 node_list 否 Array of strings 指定删除节点的ID列表。 num与node_list必须有一个字段传值。 如果num与node_list同时传值时，则以node_list的值为准。 删除的节点角色不能是Primary，以及Hidden。 如果是多AZ实例，需满足删除指定节点后，每个AZ至少存在一个节点。 请求示例一： { "num" : 2 } 请求示例二： { "node_list" : [ "116ba14da34a42d28ecd83a38c218907no02", "642597740d884b9eb998338859eea6ceno02" ] }

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

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 list List 慢日志下载链接列表。 详情请参见表4。 status String 慢日志下载链接生成状态。 FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 count Integer 慢日志链接数量。 表4 list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 file_name String 生成的下载文件名。 status String 当前链接的生成状态。 SUCCESS，表示下载链接已经生成完成。 EXPORTING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 file_size String 文件大小，单位为 KB。 file_link String 下载链接。 说明： 下载链接在更新时间的15分钟内有效，超出时间会重新获取。 update_at Long 更新时间。 响应示例 { "list": [ { "node_name": "dds-2a78_replica_node_3", "file_name": "054bc9f81e80d2201fccc00b92ad6ec0_ca327a60b3084fa79ce072d7299b905ano02_slowlog_20201117060412", "status": "SUCCESS", "file_size": "0", "file_link": "https://rdsbucket.xxxr.obs.cn-xianhz-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", "update_at": 1605593100566 } ], "status": "FINISH", "count": 1 }

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

请求示例 获取慢日志下载链接，按照需要下载的文件的文件名列表或节点ID列表 { "file_name_list":["0541c9f81e80d2201fccc00b92ad6ec0_052f8a12dfed43fbb27c2020e3c3c507no02_slowlog_20201117104809"], "node_id_list":["052f8a12dfed43fbb27c2020e3c3c507no02"] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 file_name_list Array of strings 否 需要下载的文件的文件名列表。 node_id_list Array of strings 否 节点ID列表，取空值，表示查询实例下所有允许查询的节点。 使用请参考《DDS API参考》的“查询实例列表”响应消息表“nodes 数据结构说明”的“id”。 允许查询的节点如下： 集群下面的shard节点。 副本集、单节点下面的所有节点。

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 参数说明 名称 参数类型 是否必选 描述 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删除。

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

响应消息 参数说明 表4 响应Body参数 参数 参数类型 说明 histories Array of 表5-5 objects 参数模板应用历史列表。 表5 ApplicableInstancesInfo 参数 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 applied_at String 应用时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 apply_result String 应用结果。 SUCCESS：应用成功，FAILED：应用失败，APPLYING：应用中。 failure_reason String 失败原因。 响应示例 { "histories" : [ { "instance_id" : "1967d9d9d6ef4c5ea38bd5a754f5737ein02", "instance_name" : "dds-4525", "applied_at" : "2022-06-07T09:25:45+0000", "apply_result" : "SUCCESS" } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/applied-histories?offset=0&limit=10

修订记录 发布日期 更新特性 2021-12-30 第四十三次正式发布，包含以下修改内容： 新增补丁升级。 2021-11-30 第四十二次正式发布，包含以下修改内容： 副本集实例支持添加副本集实例只读节点。 2021-07-30 第四十一次正式发布，包含以下修改内容： 新增修改实例备注。 新增使用浏览器直接下载。 新增按地址下载。 2021-06-30 第四十次正式发布，包含以下修改内容： 新增设置秒级监控。 支持RocksDB引擎，兼容MongoDB 4.2版本。 2021-05-30 第三十九次正式发布，包含以下修改内容： 新增设置可维护时间段。 2021-04-30 第三十八次正式发布，包含以下修改内容： 新增查看参数修改历史。 新增导出参数模板。 新增应用参数模板。 新增查看参数模板应用记录。 新增设置跨区域备份策略。 参数组更名为参数模板。 副本集实例支持可用区部署切换。 DDS实例名称支持中文。 跨网段访问配置当前最多可支持配置30个源端网段。 2021-03-30 第三十七次正式发布，包含以下内容： 新增迁移可用区。 2021-01-30 第三十六次正式发布，包含以下内容： 新增恢复集群备份到本地自建数据库。 2020-12-30 第三十五次正式发布，包含以下内容： DDS支持极速云盘。 DDS支持删除源端网段。 2020-10-30 第三十四次正式发布，包含以下内容： 资源标签支持20个配额。 2020-09-30 第三十三次正式发布，包含以下内容： 下线社区增强版。 社区版4.0实例支持鲲鹏机型。 2020-08-30 第三十二次正式发布，包含以下内容： 社区版集群实例最大支持32个mongos和32个shard。 副本集存储空间最大值调整到3000GB。 社区版实例支持恢复备份至当前实例。 2020-07-30 第三十一次正式发布，包含以下内容： 副本集实例支持跨网段配置。 2020-05-30 第三十次正式发布，包含以下内容： 提供回收站功能。 2020-04-30 第二十九次正式发布，包含以下内容： 支持购买多az社区版实例。 2020-04-15 第二十八次正式发布，包含以下内容： 副本集实例支持同VPC下跨子网访问配置。 2020-03-31 第二十七次正式发布，包含以下内容： 新增如下监控指标。 mongo044_swap_usage mongo050_top_total_time mongo051_top_read_time mongo052_top_write_time mongo053_wt_flushes_status mongo054_wt_cache_used_percent mongo055_wt_cache_dirty_percent 2020-02-14 第二十六次正式发布，包含以下内容： 副本集实例支持新增至五节点或七节点。 根据界面优化更新重启及删除实例、添加节点、扩容存储、变更规格、备份与恢复、参数组、监控相关的操作步骤。 2019-12-09 第二十五次正式发布，包含以下内容： 新增什么是参数模板。 支持删除已冻结的包周期实例。 支持添加mongos节点时选择AZ。 支持任务中心查看规格变更、添加节点、重启、恢复到新实例、恢复到指定时间点任务。 2019-11-11 第二十四次正式发布，包含以下内容： 社区版集群实例支持扩容到2000GB。 修改DDS的云监控指标维度。 修改支持与限制的命令。 2019-10-18 第二十三次正式发布，包含以下内容： 补充设置自动备份策略的注意事项。 新增数据迁移的注意事项。 修改标签的命名规则。 支持导出错误日志和慢日志明细。 补充连接实例相关的故障排除。 2019-09-11 第二十二次正式发布，包含以下内容： 社区版集群实例最大支持16个mongos和16个shard。 社区版实例支持审计日志功能。 社区版副本集实例支持库表级时间点恢复。 2019-08-13 第二十一次正式发布，包含以下内容： 社区版实例支持慢日志明文显示。 支持通过参数设置统计函数功能。 增强版集群实例支持恢复到指定时间点。 2019-07-07 第二十次正式发布，包含以下内容： 新增审计日志。 2019-06-13 第十九次正式发布，包含以下内容： 新增权限管理。 2019-04-19 第十八次正式发布，包含以下内容： 根据界面优化更新重启及删除实例、备份与恢复、参数组、存储、安全、标签、任务中心、监控相关操作的操作步骤。 支持手动切换副本集实例的主备节点。 新增通过mongodump和mongorestore工具迁移数据。 2019-03-25 第十七次正式发布，包含以下内容： 备份保留天数最多支持732天。 2019-02-15 第十六次正式发布，包含以下内容： 增强版集群实例支持按需计费转包周期。 新增恢复副本集备份到本地自建数据库。 界面上按需计费实例的扩容操作取消规格确认页面，文档中删除相关描述。 2019-01-07 第十五次正式发布，包含以下内容： 添加新的方式修改实例名称。 2018-11-23 第十四次正式发布，包含以下内容： DDS社区版实例支持下载错误日志和慢日志。 2018-11-02 第十三次正式发布，包含以下内容： 支持副本集实例按需计费转包周期。 支持按需计费实例批量转包周期。 支持批量续费包周期实例。 2018-09-26 第十二次正式发布，包含以下内容： 支持变更实例的CPU和内存规格时不中断业务。 对接标签管理服务。 2018-09-06 第十一次正式发布，包含以下内容： 支持集群和单节点按需计费实例转包周期。 手动备份的备份名称区分大小写字母。 支持修改参数组描述。 支持降低社区版实例的CPU和内存规格。 2018-08-03 第十次正式发布，包含以下内容： 支持下载备份文件。 2018-07-02 第九次正式发布，包含以下内容： 支持DDS社区增强版。 支持修改实例安全组。 支持任务中心。 优化自动备份策略。 支持用户删除自动备份。 副本集的存储空间上限值变更为2000GB。 2018-06-15 第八次正式发布，包含以下内容： 支持通过开关开启和关闭自动备份策略。 2018-06-01 第七次正式发布，包含以下内容： 支持兼容社区版MongoDB 3.4版本。 支持重启实例和删除实例时二次验证。 2018-05-04 第六次正式发布，包含以下内容： 支持创建“包年/包月”模式的副本集实例。 支持单节点公测。 副本集商用。 2018-04-13 第五次正式发布，包含以下内容： 创建实例页面支持设置实例名称。 支持开启和关闭公网访问。 支持查看所有shard节点的慢日志。 创建实例时磁盘存储空间范围变更。 扩容存储的最小扩容量变更。 支持为新创建的实例创建数据库账户。 支持删除添加失败的节点。 支持变更实例的CPU和内存规格。 2017-12-29 第四次正式发布，包含以下内容： 根据界面适配资料。 2017-11-08 第三次正式发布，包含以下内容： 文档数据库服务商用。 2017-08-18 第二次正式发布，包含以下内容： 根据界面优化更新购买数据库实例操作步骤。 根据界面优化更新通过SSL证书连接数据库实例的操作步骤。 2017-03-03 第一次正式发布。

参数说明 表1 DDS慢日志相关的参数说明 参数名称 说明 operationProfiling.mode 数据库profiling（分析）级别。默认值为slowOp。 off：分析器关闭，不收集任何数据。 slowOp：对于耗时超过慢查询阈值的操作，采集器采集数据。 all：采集器采集所有操作的数据。 operationProfiling.slowOpThresholdMs 慢查询的时间阈值，单位为毫秒，超过该阈值的操作将被认为是慢操作。默认值为500ms。 如无特殊需求，建议使用默认值500ms。

使用须知 回收站策略机制默认开启，且不可关闭，默认保留天数为7天，该功能免费。 如果用户同时删除100个实例，且回收站内存放有之前删除的实例，那么这100个实例可以被删除成功，但是只有部分实例能进入回收站。回收站只允许加入100个实例，超过该配额的实例将无法添加至回收站中。 修改回收站保留天数，仅对修改后新进入回收站的实例生效，对于修改前已经存在的实例，仍保持原来的回收策略，请您谨慎操作。 节点脱节状态下无法做回收备份。