华为云用户手册

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

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

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，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

响应消息 参数说明 状态码：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" }

请求消息 参数说明 表3 请求Body参数 参数 是否必选 参数类型 描述 num 是 Integer 副本集节点扩容个数，副本集有3个节点时，可以扩容2/4个节点，副本集有5个节点时，只能扩容2个，七节点副本集不可扩容备节点。 is_auto_pay 否 Boolean 扩容包年包月实例的节点数量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

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

响应消息 参数说明 表2 参数说明 名称 参数类型 描述 flavors Array of objects 实例规格信息列表。详情请参见表3。 表3 flavors字段数据结构说明 名称 参数类型 描述 engine_name String 引擎名称。 type String 节点类型。文档数据库包含以下几种节点类型： mongos shard config replica single vcpus String CPU核数。 ram String 内存大小，单位为GB。 spec_code String 资源规格编码。 示例：dds.mongodb.c6.xlarge.2.shard 说明： “dds”表示文档数据库服务产品。 “dds.mongodb”表示文档数据库服务产品。 “c6.xlarge.2”表示节点性能规格，为高内存类型。 “shard”表示节点类型。 查询规格时，注意区分是否为同系列的规格。规格系列包括：通用型（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不是同一规格系列。 az_status Object 规格在可用区内的状态，包含以下状态： normal，在售。 unsupported，暂不支持该规格。 sellout，售罄。 响应示例中“az_status”字段下可用区的值为示例值。 响应示例 { "flavors": [ { "engine_name": "DDS-Community", "type": "mongos", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.mongos", "az_status": { "cn-north-1a": "unsupported", "cn-north-1b": "normal", "cn-north-1c": "normal", "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported" } },{ "engine_name": "DDS-Community", "type": "shard", "vcpus": "4", "ram": "8", "spec_code": "dds.mongodb.c6.xlarge.2.shard", "az_status": { "cn-north-1a": "sellout", "cn-north-1b": "normal", "cn-north-1c": "normal", "cn-north-1a,cn-north-1b,cn-north-1c": "unsupported" } }, { "engine_name": "DDS-Community", "type": "config", "vcpus": "2", "ram": "4", "spec_code": "dds.mongodb.c6.large.2.config", "az_status": { "cn-north-1a": "normal", "cn-north-1b": "normal", "cn-north-1c": "normal", "cn-north-1a,cn-north-1b,cn-north-1c": "normal" } },{ "engine_name": "DDS-Community", "type": "replica", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.repset", "az_status": { "cn-north-1a": "normal", "cn-north-1b": "normal", "cn-north-1c": "normal", "cn-north-1a,cn-north-1b,cn-north-1c": "normal" } },{ "engine_name": "DDS-Community", "type": "single", "vcpus": "16", "ram": "64", "spec_code": "dds.mongodb.c6.4xlarge.4.single", "az_status": { "cn-north-1a": "normal", "cn-north-1b": "normal", "cn-north-1c": "normal", "cn-north-1a,cn-north-1b,cn-north-1c": "normal" } } ]}

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

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 region string query 否 实例所在区域。 实例所在区域。 取值： 非空，请参见地区和终端节点。 engine_name string query 否 数据库版本类型。取值为“DDS-Community”。

响应消息 参数说明 表3 响应Body参数 参数 参数类型 说明 differences Array of 表5-5 objects 参数之间的区别集合。 表4 DiffDetails 参数 参数类型 说明 parameter_name String 参数名称 source_value String 源参数模板中的参数值。 target_value String 目标参数模板中的参数值。 响应示例 { "differences" : [ { "parameter_name" : "connPoolMaxConnsPerHost", "source_value" : "600", "target_value" : "601" }, { "parameter_name" : "connPoolMaxShardedConnsPerHost", "source_value" : "600", "target_value" : "601" }, { "parameter_name" : "cursorTimeoutMillis", "source_value" : "600000", "target_value" : "600001" }, { "parameter_name" : "userCacheInvalidationIntervalSecs", "source_value" : "30", "target_value" : "31" } ] }

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，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

响应消息 参数说明 表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 应用结果。 SUC CES S：应用成功，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

响应消息 参数说明 表4 响应Body参数 参数 参数类型 说明 instances Array of 表5-5 objects 可以应用的实例列表。 表5 ApplicableInstancesInfo 参数 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 entities Array of 表6-6 objects 节点组信息或节点信息的列表对象。 当参数模板是副本集或单节点类型时，不返回该字段，模板直接应用到对应实例。 当参数模板是集群类型时，如果是shard组或者config组的参数模板，则返回的是对应类型的节点组信息；如果是mongos组的参数模板，则返回的是对应类型的的节点信息。 例如：一个mongos参数模板可应用到一个或多个mongos节点。 表6 EntityInfo 参数 参数类型 说明 entity_id String 组ID或节点ID。 entity_name String 组名称或节点名称。 响应示例 { instances:[ { "instance_id": "1967d9d9d6ef4c5ea38bd5a754f5737ein02", "instance_name": "dds-5425", "entities": [ { "entity_id": "36457a9af7c7486a882727d205ef37afgr02", "entity_name": "shard_1" }, { "entity_id": "a36651f1807f40be891db839e8bbe9e7gr02", "entity_name": "shard_2" } ] }, { "instance_id": "4809355b9836467c8749610089b1ef3bin02", "instance_name": "dds-9d67", "entities": [ { "entity_id": "08e61e50220c49728eb49dbb092d6ec4gr02", "entity_name": "shard_2" }, { "entity_id": "24d58cd41c20486e9745e7f5b424e641gr02", "entity_name": "shard_3" }, { "entity_id": "602807fcb2b24e38952347e030ec4a61gr02", "entity_name": "shard_1" } ] } ] }

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

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations

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

响应消息 参数说明 表3 响应Body参数 参数 参数类型 描述 job_id String 修改实例参数的异步任务ID。 restart_required Boolean 参数修改涉及范围（实例，组，节点）否需要重启。 取值为false，不需要重启。 取值为true，需要重启。 响应示例 {"job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f","restart_required" : false}

请求消息 参数说明 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 Content-Type string header 是 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 status string path 是 开启或关闭慢日志脱敏，取值为on或off。

请求消息 参数说明 表2 请求Body参数 名称 是否必选 参数类型 说明 entity_ids 是 Array of strings 实例ID或组ID或节点ID的列表对象。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 当变更的实例类型是集群，如果变更的是shard组或者config组的参数模板，传值为组ID。如果变更的是mongos节点的参数模板，传值为节点ID。 当变更的实例类型是副本集或单节点，传值为实例ID。

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

请求示例 设置可维护时间段 PUT https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/maintenance-window { "start_time" : "14:00", "end_time" : "15:00"}

请求消息 参数说明 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间，格式必须为HH:MM且有效，当前时间指UTC时间。不能与结束时间相同，只能为整点。 end_time 是 String 结束时间，格式必须为HH:MM且有效，当前时间指UTC时间。不能与开始时间相同，只能为整点。

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

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

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 az_list Array of objects 是 可用区具体信息。详情请参见表3。 表3 az_list 字段数据结构说明 名称 参数类型 是否必选 描述 code String 是 可用区ID。 description String 是 可用区描述。 status String 是 当前可用区的的状态。 ENABLED，表示该可用区（组合）可用。 DISABLED，表示该可用区（组合）不可用。 响应示例 { "az_list": [ { "code": "az3xahz", "description": "可用区3", "status": "DISABLED" } { "code": "az1xahz,az2xahz,az3xahz", "description": "可用区1,可用区2,可用区3", "status": "ENABLED" } ]}

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

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

请求参数 参数说明 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 资源规格编码。获取方法请参见查询数据库规格中参数的值。示例：dds.mongodb.c6.large.4.rr。 num 是 Integer 待新增只读节点个数。取值范围：1~5。 delay 否 Integer 同步延迟时间。取值范围：0~1200毫秒。默认取值为0。 is_auto_pay 否 Boolean 新增包年包月实例的只读节点时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。