华为云用户手册

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

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs URI样例 https://dds.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs?offset=0&limit=10 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。取值范围：0~50。不传该参数时，默认查询前50条实例的云服务日志配置信息。

响应消息 参数说明 表3 响应Body参数 参数 参数类型 说明 instance_lts_configs Array of 表4 objects 每个实例的LTS日志配置信息和实例简要信息。 total_count Integer 全部可查询的云服务日志配置结果个数，等于所有DDS实例的个数。 表4 instance_lts_configs 参数 参数类型 说明 instance 表5 object 实例的简要信息。 lts_configs Array of 表 lts_configs objects LTS日志配置明细。从未设置LTS日志流，不返回该字段。 表5 instance 参数 参数类型 说明 id String 实例ID。 name String 实例名字。 mode String 实例类型，对应单节点，副本集，集群三种。 枚举值： Single Replica Sharding datastore 表6 object 实例的数据库引擎和版本。 status String 实例状态。 enterprise_project_id String 实例归属的企业项目ID，如果是default企业项目，值为0，如果是其他企业项目，请参考企业项目相关内容。 actions Array of strings 实例所有正在执行的动作。 表6 datastore 参数 参数类型 说明 type String 数据库引擎，值为mongodb。 枚举值： mongodb version String 数据库大版本。 表7 lts_configs 参数 参数类型 说明 log_type String LTS日志类型，不能为空，具有以下日志类型。 audit_log 枚举值： audit_log lts_group_id String 云日志服务LTS 日志组ID。 lts_stream_id String 云日志 服务LTS日志流ID。 enabled Boolean 是否上传。 响应示例 { "total_count" : 1, "instance_lts_configs" : [ { "instance" : { "id" : "520c58ba00a3497e97ce0b9604874dd6in02", "name" : "dds-1f84", "mode" : "Single", "datastore" : { "type" : "mongodb", "version" : 4.0 }, "status" : "normal", "enterprise_project_id" : "0", "actions" : [ "OPS_AUDIT_ LOG " ] }, "lts_configs" : [ { "log_type" : "audit_log", "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc", "enabled" : true } ] } ] }

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

响应消息 参数说明 表2 响应Body参数 参数 参数类型 说明 instance_id String 实例ID。 client_network_ranges Array of strings 客户端所在网段。 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。 只有副本集有该功能。 响应示例 { "instance_id": "f400017ff2184ee1bad45f3f247f4936in02", "client_network_ranges": [ "173.12.10.0/9", "132.22.1.1/10" ] }

响应消息 参数说明 表2 参数说明 名称 参数类型 说明 slow_log_list Array of objects 具体信息。 详情请参见表3。 total_record Integer 总记录数。 表3 slow_log_list字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 query_sample String 执行语法。 type String 语句类型。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 start_time String 发生时间，UTC时间。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} URI样例 查询数据库慢日志： https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog?start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800 根据指定条件查询数据库慢日志： https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/6ade8143870047b8999aba8f1891b48ein02/slowlog?type=INSERT&offset=1&limit=20&node_id=a7c84462483642798cf159237343135fno06&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800

请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 file_names 是 Array of strings 文件名列表。 请求示例 { "file_names" : [ "054bc9f81e80d2201fccc00b92ad6ec0_audit_log_65ca506de9904366bdf69ca8174250abin02_dda6bd25f6b043518f9574befabc9536no02_1660354924651", "054bc9f81e80d2201fccc00b92ad6ec0_audit_log_65ca506de9904366bdf69ca8174250abin02_dda6bd25f6b043518f9574befabc9536no02_1660354987726" ] }

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/auditlog 表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 响应Body参数 参数 参数类型 说明 certs Array of 表3 objects 证书列表。 表3 CertInfo 参数 参数类型 说明 category String 证书种类。枚举值： international。 national。 download_link String 证书下载链接。 响应示例 { "certs" : [ { "category" : "international", "download_link" : "https://obs.xxx.myhuaweicloud.com/xxx/dds/ca-dds.crt" } ] }

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

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

响应消息 参数说明 表2 响应Body参数 参数 参数类型 说明 strategies Array of 表3 objects 升级策略列表 表3 DurationStrategies 参数 参数类型 说明 strategy String 升级策略。 minimized_interrupt_time，表示最短中断时。 minimized_upgrade_time，最短升级时长。 estimated_upgrade_duration Integer 升级时长，单位为分钟 响应示例 { "strategies" : [ { "strategy" : "minimized_interrupt_time", "estimated_upgrade_duration" : 10 }, { "strategy" : "minimized_upgrade_time", "estimated_upgrade_duration" : 5 } ] }

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

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参数 参数 参数类型 说明 recycle_policy 表3 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章节获取项目编号。

响应消息 参数说明 表3 响应Body参数 参数 参数类型 说明 total_count Integer 总记录数。 instances Array of 表4 objects 实例信息。 表4 RecycleInstance 参数 参数类型 说明 id String 实例ID。 name String 实例名称。 mode String 实例类型。支持集群、副本集、以及单节点。取值： Sharding ReplicaSet Single datastore 表5 object 数据库信息。 pay_mode String 计费方式。 取值为“0”，表示按需计费。 取值为“1”，表示包年/包月计费。 enterprise_project_id String 企业项目ID，取值为“0”，表示为default企业项目。 backup_id String 备份ID。 created_at String 创建时间。 deleted_at String 删除时间。 retained_until String 保留截止时间。 表5 RecycleDatastore 参数 参数类型 说明 type String 数据库版本类型。取值“DDS-Community”。 枚举值： DDS-Community。 version String 数据库版本。支持3.4、4.0、4.2、4.4和5.0版本。取值为“3.4”、“4.0”或“4.2”、“4.4”、“5.0”。 响应示例 { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in02", "name" : "test1", "mode" : "ReplicaSet", "datastore" : { "type" : "DDS-Community", "version" : "4.0" }, "pay_mode" : "0", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T10:00:00", "retained_until" : "2022-05-01T10:00:00" } ] }

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格式 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

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