华为云用户手册

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

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/conn-statistics?node_id={node_id} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/conn-statistics?node_id=51a90da2cfc846688abcdd23861077b5no02

响应消息 参数说明 表2 参数说明 名称 是否必选 参数类型 描述 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，“_”，“.”，“-”，中文。 响应示例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }

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

请求消息 参数说明 表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}/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参数 参数 参数类型 说明 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" } ] }

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

URI URI格式 GET https://{Endpoint}/v3/{project_id}/datastores/{datastore_name}/versions URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/datastores/DDS-Community/versions

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 versions Array of strings 是 数据库版本。支持4.2、4.0、3.4版本，取值为“4.2”、“4.0”、“3.4”。 说明： 目前DDS 4.2版本受限商用，详情请参见DDS服务公告。 为了保证您的文档数据库使用体验，建议创建4.0版本的数据库。 响应示例 { "versions": [ "3.2", "3.4", "4.0" ] }

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

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

请求消息 请求参数 表1 参数说明 名称 类型 IN 必选 描述 x-auth-token string header 是 从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 engine_name string query 否 数据库版本类型。取值为“DDS-Community”。获取方法请参见查询数据库版本信息。 engine_version string query 否 数据库版本号。 offset Integer query 否 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据,表示从第一条数据开始查询）。 取值必须为数字，不能为负数。 limit Integer query 否 查询规格信息上限值。 取值范围：1~100。 不传该参数时，默认查询前100条规格信息。

响应消息 参数说明 表3 参数说明 名称 参数类型 描述 links Array of strings 审计日志下载链接列表，有效时间5分钟。 响应示例 { "links": ["https://obs.domainname.com/ddsbucket.username.1/xxxxxx", "https://obs.domainname.com/ddsbucket.username.2/xxxxxx"] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-links URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/2870a411522849aa901cd4351c96a3b7in02/auditlog-links

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

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

响应消息 参数说明 表2 参数说明 名称 参数类型 描述 keep_days Integer 审计日志保存天数，审计日志策略关闭时为0。 audit_scope String 审计范围。 audit_types Array of strings 审计类型。 响应示例 { "keep_days":7, "audit_scope":"all", "audit_types":["insert"] }

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

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

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 keep_days Integer 是 审计日志保存天数，取值范围为0或7~732。 取值0，表示关闭审计日志策略。 取值7~732，表示开启审计日志策略，并设置审计日志保存天数为该值。 reserve_auditlogs String 否 仅关闭审计日志策略时有效。 true（默认），表示关闭审计日志策略的同时，保留历史审计日志。 false，表示关闭审计日志策略的同时，删除已有的历史审计日志。 audit_scope String 否 仅打开审计日志策略时有效，并且取值为空或者“all”时，默认全部。 审计范围。 请输入数据库或集合名称，多个库或集合请用英文逗号分隔。若名称中有英文逗号，请在逗号前添加“$”符号，用以区分分隔符。 输入长度范围不能超过1024位，且不能包含空格∧"[]{}():'和特殊字符，$符号只能在转义时使用。 audit_types Array of strings 否 仅打开审计日志策略时有效，并且为空时，默认全部。 审计类型。支持auth，insert，delete，update，query，command等。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 user_name String 是 数据库用户名称，系统自带的数据库用户不可删除。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 db_name String 是 用户所在的数据库。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 请求示例 { "user_name":"test" , "db_name":"test_db" }

URI URI格式 DELETE 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 否 数据库用户名称。 默认为“rwuser”用户，也支持“sharduser”、“csuser”用户。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 user_pwd String 是 数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 db_name String 否 数据库名称，默认为“admin”。

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

响应消息 参数说明 表8 参数说明 名称 参数类型 是否必选 描述 id String 否 实例ID。 name String 否 实例名称，与请求参数相同。 datastore Object 否 数据库信息，与请求参数相同。详情请参见表3。 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，与请求参数相同。 disk_encryption_id String 否 磁盘加密的密钥ID，与请求参数相同。 mode String 否 实例类型，与请求参数相同。 configurations Array of objects 否 参数组配置信息。 详情请参见表9。 flavor Array of objects 否 实例规格详情，与请求参数相同。详情请参见表5。 backup_strategy Object 否 高级备份策略，与请求参数相同。详情请参见表6。 enterprise_project_id String 否 企业项目ID。取值为“0”，表示为default企业项目。 dss_pool_id String 否 Dec用户专属存储ID。 job_id String 否 创建实例的工作流ID。 ssl_option String 否 SSL开关选项，与请求参数相同。 order_id String 否 创建实例的订单ID，仅创建包年包月实例时返回该参数。 charge_info Object 否 付费方式信息，与请求参数相同。 详情请参见表12。 表9 configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 枚举值： mongos shard config replica single configuration_id String 是 参数组id。 表10 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 num String 是 节点数量或组数量。 取值： type取值“mongos”，num表示集群实例下mongos节点的数量，取值2~16。 type取值“shard”，num表示集群实例下shard组的数量，取值2~16。 type取值“config”，num表示集群实例下config组的数量，只能取值1。 type取值“replica”，num表示副本集实例下副本节点的数量，可取值3，5，7。 type取值“single”，num表示单节点实例下节点的数量，只能取值1。 storage String 否 磁盘类型。 size String 否 磁盘大小。 对于除mongos外的其他节点，该参数必选。mongos节点下，该参数无意义。 取值：必须为10的整数倍。单位为GB。 对于集群实例，shard组可取10GB~2000GB，config组仅可取20GB。mongos节点不涉及选择磁盘，该参数无意义。 对于副本集实例，可取10GB~3000GB。 对于单节点实例，可取10GB~1000GB。 spec_code String 是 资源规格编码。获取方法请参见查询数据库规格中响应参数“spec_code”的值。 集群实例下，需要指定多个规格，要求所有规格的系列一致，均为通用型（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不是同一规格系列。 表11 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 不传该参数，默认的备份时间段不传该参数，默认的备份时间段为00:00-01:00。 取值示例： 23:00-00:00 keep_days String 否 指定已生成的备份文件可以保存的天数。 取值范围：0~732。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表12 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" }

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 job_id String 是 工作流ID。 node_name String 是 节点名称。 node_id String 是 节点ID。 响应示例 { "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5", "node_id": "52a4c096bb1f455d8d866956a959519eno02", "node_name": "mongodb-8977_mongos_node_1" }

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

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