华为云用户手册

响应消息 参数说明 表2 响应Body参数 参数 参数类型 说明 recycle_policy 表2-4 object 实例回收策略。 表3 RecyclePolicy 参数 参数类型 说明 enabled Boolean 是否打开回收策略。 true 打开回收策略。 retention_period_in_days Integer 策略保持时长（1-7天），天数为正整数。 响应示例 { "recycle_policy" : { "enabled" : true, "retention_period_in_days" : 3 } }

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

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

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

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

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

请求消息 参数说明 表2 参数说明 名称 类型 是否必选 说明 start_time String 是 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 注意： 开始时间不得早于当前时间30天。 end_time String 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： 结束时间不能晚于当前时间。 limit Integer 是 表示每次查询的日志条数，最大限制100条。 line_num String 否 日志单行序列号，第一次查询时不需要此参数，下一页查询时需要使用，可从上一次查询的返回信息中获取。 说明：当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。 severity String 否 日志级别，取空值表示查询所有日志级别。枚举值： Warning Error search_type String 否 日志查询方式，需结合line_num使用，以line_num的日志为起始点： 取值"backwards"时，表示查询上一页limit大小的日志。 取值"forwards"时，表示查询下一页limit大小的日志。 不传默认"forwards"。 枚举值： backwards forwards node_id String 否 节点ID，取空值，表示查询实例下所有允许查询的节点。 使用请参考表8的“id”。允许查询的节点如下： 集群实例下面的 shard节点。 副本集、单节点实例下面的所有节点。 keywords Array of strings 否 根据多个关键字搜索日志全文，表示同时匹配所有关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过512个字符。 请求示例 { "start_time" : "2023-01-06T10:41:14+0800", "end_time" : "2023-01-09T13:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "severity" : "Warning", "search_type" : "forwards", "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02", "keywords" : ["Unable", "NETWORK"] }

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 error_logs Array of objects 错误日志具体信息。 详情请参见表4。 表4 error_log_list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 node_id String 节点ID。 raw_message String 描述信息。 severity String 日志级别。 log_time String 日志产生时间，UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。 响应示例 { "error_logs" : [ { "node_name" : "Test_replica_node_2", "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02", "raw_message" : "W NETWORK [ShardServerCatalogCacheLoader-214] Unable to reach primary for set shard_2", "severity" : "Warning", "log_time" : "2023-01-09T12:55:39.398+0000", "line_num" : "1595659490239433659" } ] }

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

请求示例 打开实例回收站策略，策略保持时长为3天 PUT https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy { "recycle_policy" : { "enabled" : true, "retention_period_in_days" : 3 } }

请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 recycle_policy 是 Object 实例回收策略。详情请参见表3。 表3 RecyclePolicy 参数 是否必选 参数类型 描述 enabled 是 Boolean 打开回收策略，不可关闭。 true 打开回收策略。 retention_period_in_days 否 Integer 策略保持时长（1~7天），天数为正整数，不填默认保留7天。

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

请求示例 设置可维护时间段 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格式 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，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求消息 参数说明 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 请求示例 查询秒级监控配置。 GET https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/monitoring-by-seconds/switch

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

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

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

请求示例 副本集实例升级数据库补丁版本，升级模式为中断时间最短优先模式 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}/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，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

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，表示手动从账户中支付，默认为该方式。

请求示例 副本集实例新增只读节点，spec_code为dds.mongodb.c6.large.4.rr，新增只读节点数为1，delay为0 POST https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/readonly-node { "spec_code": "dds.mongodb.c6.large.4.rr", "num" : 1, "delay" : 0 }

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