华为云用户手册

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

URI URI格式 POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/bind-eip URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/bind-eip

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 node_name String 是 节点名称。 node_id String 是 节点ID。 public_ip_id String 是 弹性公网IP的ID。 public_ip String 是 弹性公网IP。 响应示例 { "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5", "node_id":"52a4c096bb1f455d8d866956a959519eno02", "node_name":"mongodb-8977_mongos_node_1", "public_ip":"10.145.51.128", "public_ip_id":"45da4782-e0c8-4aa4-a290-b8740014f710" }

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

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balancer/{action} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/balancer/start

请求示例 扩容mongos节点数量，spec_code为dds.mongodb.c6.medium.4.mongos，数量为1 { "type": "mongos", "spec_code":"dds.mongodb.c6.medium.4.mongos", "num": 1 } 扩容shard组数量，spec_code为dds.mongodb.c6.medium.4.mongos，新增shard组的磁盘容量为330GB { "type": "shard", "spec_code":"dds.mongodb.c6.medium.4.shard", "num": 1, "volume": { "size": 330 } }

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

请求消息 请求参数 表1 参数说明 名称 类型 IN 必选 描述 x-auth-token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 engine_name string query 否 数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。

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

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

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-role URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/db-role

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 role_name String 是 创建角色名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 roles Array of objects 否 新建角色所继承的角色列表。请参见表3。 db_name String 否 角色所在的数据库名称，默认admin。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 表3 roles字段数据结构说明 名称 参数类型 是否必选 描述 role_db_name String 是 被继承角色所在数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 role_name String 是 被继承角色的名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

请求示例 查询某个时间段的数据库查询类语句的慢日志，每次查询的日志条数为100条，可以通过关键字搜索日志全文，可以根据最大执行时间100ms范围查找日志，根据最小执行时间50ms范围查找日志。 { "start_time" : "2022-09-06T10:41:14+0800", "end_time" : "2022-09-16T10:41:14+0800", "limit" : 100, "line_num" : "1595659490239433658", "operate_type" : "query", "node_id" : "dbd0b65ed0c34125a0b04d4e5ba67e66no02", "keywords" : [ "response", "oplog" ], "database_keywords" : [ "testDB" ], "collection_keywords" : [ "testCollection" ], "max_cost_time" : 100, "min_cost_time" : 50 }

响应消息 参数说明 表3 参数说明 名称 参数类型 说明 slow_logs Array of objects 慢日志具体信息。 详情请参见表4。 表4 slowLogDetail字段数据结构说明 名称 参数类型 说明 node_name String 节点名称。 node_id String 节点ID。 whole_message String 执行语句。 operate_type String 语句类型。 cost_time Integer 执行时间。 单位：ms。 lock_time Integer 等待锁时间。 单位：us。 docs_returned Integer 返回的文档数。 docs_scanned Integer 扫描的文档数。 database String 日志所属的数据库库名。 collection String 日志所属的数据库表名。 log_time String 日志产生时间，UTC时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 line_num String 日志单行序列号。

请求消息 参数说明 表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日志。 operate_type String 否 语句类型，取空值，表示查询所有语句类型。 取值如下： insert query update remove getmore command killcursors node_id String 否 节点ID，请参考表8的“id”。 取空值，表示查询实例下所有允许查询的节点。 允许查询的节点如下： 集群实例下面的 shard节点。 副本集、单节点实例下面的所有节点。 keywords Array of strings 否 根据多个关键字搜索日志全文，表示同时匹配所有关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过512个字符。 database_keywords Array of strings 否 根据多个数据库关键字模糊搜索日志，表示匹配至少一个关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过64个字符。 collection_keywords Array of strings 否 根据多个数据库表名关键字模糊搜索日志，表示匹配至少一个关键字。 只支持关键字前缀模糊搜索，最多支持10个关键字。 每个关键字最大长度不超过128个字符。 max_cost_time Integer 否 支持根据最大执行时间范围查找日志。 单位：ms。 min_cost_time Integer 否 支持根据最小执行时间范围查找日志。 单位：ms。

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

请求消息 参数说明 表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，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 表2 Query参数 参数 参数类型 是否必选 描述 entity_id String 是 实例ID或组ID或节点ID。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 当获取的实例类型是集群，如果获取的是shard组或者config组的参数模板，传值为组ID。如果获取的是mongos节点的参数模板，传值为节点ID。 当获取的实例类型是副本集或单节点，传值为实例ID。

响应消息 参数说明 表3 响应Body参数 名称 参数类型 说明 datastore_version String 数据库版本。 datastore_name 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 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表4。 表4 parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 value_range String 参数值范围。 示例：Integer类型取值范围为0~1、Boolean类型取值为“true”或“false”。 restart_required Boolean 参数是否需要重启。 取值为“true”，需要重启。 取值为“false”，不需要重启。 readonly Boolean 是否只读。 取值为“false”，非只读参数。 取值为“true”，只读参数。 type String 参数类型，取值为“integer”，“string”，“boolean”，“float”或“list”。 description String 参数描述。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f0ba99dd8a8249838a6007042d76b07ain02/configurations?entity_id=827697ee2f6040bd9fcf65586e3f7218gr02

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-user URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f032c0db12d147ef87317efdfacbbe15in02/db-user

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 是 数据库用户名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 用户名不能为内部保留用户：drsFull，drsIncremental。 user_pwd String 是 数据库用户密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 roles Array of Object 是 新用户所拥有的角色。请参见表3。 roles限制了该账户所具有的权限。若指定一个空数组，表示该账户不具有任何权限。 db_name String 否 新用户所在的数据库，默认为“admin”。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 表3 roles字段数据结构说明 名称 参数类型 是否必选 描述 role_db_name String 是 授予新用户所拥有的角色所在数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 role_name String 是 授予新用户所拥有的角色名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

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

请求消息 参数说明 表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 参数说明 名称 参数类型 是否必选 描述 roles String 是 数据库角色信息。 注意： 返回格式按照数据库原生格式返回，需要用户解析。 total_count Integer 是 数据库角色总数。 响应示例 { "total_count": 1, "roles": "[{\"privileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"inheritedPrivileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"role\":\"userAdmin\",\"roles\":[],\"inheritedRoles\":[],\"isBuiltin\":true,\"db\":\"admin\"}]" }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit} URI样例 查询数据库角色列表： https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles 根据指定条件查询角色列表 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles?role_name=testRole&db_name=testDb&offset=0&limit=100

响应消息 参数说明 表9 参数说明 名称 参数类型 是否必选 描述 id String 否 实例ID。 name String 否 实例名称，与请求参数相同。 datastore Object 否 数据库信息，与请求参数相同。详情请参见表10。 created String 否 创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。 status String 否 实例状态，取值为“creating”。 region String 否 区域ID，与请求参数相同。 availability_zone String 否 可用区ID，与请求参数相同。 vpc_id String 否 虚拟私有云ID，与请求参数相同。 subnet_id String 否 子网的网络ID，与请求参数相同。 security_group_id String 否 安全组ID，与请求参数相同。 port Integer 否 数据库访问端口。 disk_encryption_id String 否 磁盘加密的密钥ID，与请求参数相同。 mode String 否 实例类型，与请求参数相同。 configurations Array of objects 否 参数组配置信息。 详情请参见表11。 flavor Array of objects 否 实例规格详情，与请求参数相同。详情请参见表12。 backup_strategy Object 否 高级备份策略，与请求参数相同。详情请参见表13。 enterprise_project_id String 否 企业项目ID。取值为“0”，表示为default企业项目。 ssl_option String 否 SSL开关选项，与请求参数相同。 dss_pool_id String 否 Dec用户专属存储ID，与请求参数相同。 job_id String 否 创建实例的工作流ID。 tags Array of objects 否 标签列表，与请求参数相同。 详情请参见表14。 order_id String 否 创建实例的订单ID，仅创建包年包月实例时返回该参数。 charge_info Object 否 付费方式信息，与请求参数相同。 详情请参见表15。 表10 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持4.2、4.0、3.4版本，取值为“4.2”、“4.0”、“3.4”。 说明： 目前DDS 4.2版本受限商用，详情请参见DDS服务公告。 为了保证您的文档数据库使用体验，建议创建4.0版本的数据库。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表11 Configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 枚举值： mongos shard config replica configuration_id String 是 参数组id。获取参数值请参见表4 表12 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 num String 是 节点数量或组数量。 storage String 否 磁盘类型。 size String 否 磁盘大小。 spec_code String 是 资源规格编码。 表13 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 keep_days String 否 指定已生成的备份文件可以保存的天数。 表14 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。最大长度36个unicode字符。 key不能为空，不能为空字符串，不能重复。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 是 标签值。最大长度43个unicode字符。 可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表15 charge_info字段数据结构说明 参数 参数类型 是否必选 描述 charge_mode String 是 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 否 订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num Integer 否 “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew Boolean 否 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围： true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay Boolean 否 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 响应示例中参数“region”和“availability_zone”的值为示例值。 响应示例 集群实例： { "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:34:36", "status": "creating", "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.medium.4.shard", "size": 20 }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.large.2.config", "size": 20 } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "tags": [ { "key": "dds001", "value": "dds001" } ] }

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

响应消息 参数说明 状态码：200 表2 响应Body参数 参数 参数类型 说明 name String 连接地址复制集名称。 状态码：406 表3 响应Body参数 参数 参数类型 说明 ErrorResponse Array of 表4 objects 实例不是副本集，当前实例不允许此操作。 表4 ErrorResponse 参数 参数类型 说明 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 响应示例 状态码：200 { "name" : "replica" }

响应消息 参数说明 表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章节获取项目编号。