华为云用户手册

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

请求示例 根据target_id重启整个实例 { "target_id":"9136fd2a9fcd405ea4674276ce36dae8in02" } 根据target_type和target_id重启shard组 { "target_type":"shard", "target_id":"84e7c96b82aa4fedb3b00f98edd71ba4gr02" } 根据target_type和target_id重启config组 { "target_type":"config", "target_id":"06439baa35c146d3a8965af59d370908gr02" } 根据target_type和target_id重启mongos节点 { "target_type":"mongos", "target_id":"bd4dccbd53ae48d5bd3046bebf715079no02" }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 target_type String 否 参数解释： 待重启对象的类型。 约束限制： 重启集群实例下的节点或组时，该参数必选。 重启mongos节点时，取值为“mongos”。 重启shard组时，取值为“shard”。 重启config组时，取值为“config”。 重启实例（集群、副本集、单节点）时，不传该参数。 取值范围： mongos shard config 默认取值： 不涉及。 target_id String 是 参数解释： 待重启对象的ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 重启集群实例下的节点时，对于mongos节点，取值为mongos节点ID，对于shard和config组，取值为shard和config组ID。 重启整个实例时，取值为实例ID。 重启副本集实例时，取值为实例ID。 重启单节点实例时，取值为实例ID。 取值范围： 不涉及。 默认取值： 不涉及。

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

响应消息 参数说明 表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 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 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" } ] }

请求示例 创建版本为3.2，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的集群实例 { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "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", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 8 }, "ssl_option": 1, "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "server_group_policies": [ "anti-affinity" ], "tags": [ { "key": "dds001", "value": "dds001" } ] } 创建版本为3.4，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的跨AZ集群实例 { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "aaa,bbb,ccc", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Sharding", "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" }, "ssl_option":"1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 创建版本为3.2，存储引擎为wiredTiger，带有虚拟私有云，子网，安全组，参数组配置，启用SSL连接，带有标签的副本集实例 { "name": "test-replicaset", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "ReplicaSet", "configurations": [ { "type": "replica", "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02" } ], "flavor": [ { "type": "replica", "num": 1, "storage": "ULTRAHIGH", "size": 30, "spec_code": "dds.mongodb.c6.medium.4.repset" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 8 }, "ssl_option": 1, "tags": [ { "key": "dds001", "value": "dds001" } ] }

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 name String 是 实例名称。 用于表示实例的名称，允许和已有名称重复。 实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。 datastore Object 是 数据库信息。详情请参见表3。 region String 是 区域ID。 取值：非空，请参见地区和终端节点。 availability_zone String 是 可用区ID。参见查询数据库规格接口中返回的az_status ，可以选择多个AZ，创建跨AZ的集群。 取值：非空，请参见地区和终端节点。 vpc_id String 是 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id String 是 子网的网络ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id String 是 指定实例所属的安全组ID列表。 最多支持添加10个安全组ID，安全组ID之间用英文逗号隔开。 获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 port String 否 数据库访问端口。 端口有效范围：2100~65535（不包括12017和33071）。 不传该参数时，创建实例的访问端口默认为8635。 password String 否 数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 不传该参数时，实例创建完成后，如需连接实例，请先为实例设置密码，具体请参见重置管理员密码。 disk_encryption_id String 否 磁盘加密时的密钥ID，严格UUID正则校验。 不传该参数时，表示不进行磁盘加密。 mode String 是 实例类型。支持集群和副本集。 取值： Sharding ReplicaSet configurations Array of objects 否 参数组配置信息。详情请参见表4。 不传该参数时，表示为系统默认参数组。 flavor Array of objects 是 实例规格详情。详情请参见表5。 获取方法请参见查询数据库规格中响应flavors字段下参数的值。 backup_strategy Object 否 高级备份策略。详情请参见表6。 enterprise_project_id String 否 企业项目ID。 对于未开通企业多项目服务的用户，不传该参数。 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。 获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 ssl_option String 否 SSL开关选项。 取值： 取“0”，表示DDS实例默认不启用SSL连接。 取“1”，表示DDS实例默认启用SSL连接。 不传该参数时，默认不启用SSL连接。 dss_pool_id String 否 Dec用户专属存储ID，默认为空。仅Dec用户支持该参数。 server_group_policies Array of strings 否 Dec用户云服务器组关联的策略名称列表。仅Dec用户支持该参数。 该参数取值包括： 取“anti-affinity”，表示DDS实例开启反亲和部署，反亲和部署是出于高可用性考虑，将您的Primary、Secondary和Hidden节点分别创建在不同的物理机上。 Dec用户不传该参数时，默认不开启反亲和部署。 tags Array of objects 否 标签列表。 单个实例总标签数上限20个。详情请参见表7。 charge_info Object 否 计费类型信息，支持包年包月和按需计费，默认为按需计费。 详情请参见表8。 表3 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表4 Configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 枚举值： mongos shard config replica configuration_id String 是 参数组id。获取参数值请参见表4 表5 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 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。 说明： 当创建副本集实例时，num取值为“1”也可以正常调用，创建3副本集实例。 storage String 否 磁盘类型。 取值： ULTRAHIGH，表示SSD。 EXTREMEHIGH，表示极速型SSD。 对于集群实例的shard和config节点，以及副本集实例，该参数有效。mongos节点不涉及选择磁盘，该参数无意义。 size String 否 磁盘大小。 对于除mongos外的其他节点，该参数必选。mongos节点下，该参数无意义。 取值：必须为10的整数倍。单位为GB。 对于集群实例，shard组可取10GB~2000GB，config组仅可取20GB。mongos节点不涉及选择磁盘，该参数无意义。 对于副本集实例，可取10GB~3000GB。 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不是同一规格系列。 表6 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天。 表7 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）。 表8 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”的值为示例值。

响应消息 参数说明 表1 参数说明 名称 参数类型 是否必选 描述 versions Array of objects 否 API版本详细信息列表。详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 API版本号。 links Array of objects 是 对应该API的链接信息。详情请参见表3。 说明： v3版本该字段为[]。 status String 是 版本状态。 取值为“CURRENT”，表示该版本目前已对外公布。 version String 是 API版本的子版本信息。 min_version String 是 API版本的最小版本号。 updated String 是 版本更新时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 是否必选 描述 href String 否 对应该API的URL，该字段为""。 rel String 否 取值为“self”，表示URL为本地链接。 响应示例 { "version": { "id": "v3", "links": [], "status": "CURRENT", "version": "", "min_version": "", "updated": "2017-02-07T17:34:02Z" } }

响应消息 参数说明 表1 参数说明 名称 参数类型 是否必选 描述 versions Array of objects 否 API版本详细信息列表。详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 API版本号。 links Array of objects 是 对应该API的链接信息。详情请参见表3。 说明： v3版本该字段为[]。 status String 是 版本状态。 取值为“CURRENT”，表示该版本目前已对外公布。 version String 是 API版本的子版本信息。 min_version String 是 API版本的最小版本号。 updated String 是 版本更新时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 是否必选 描述 href String 否 对应该API的URL，该字段为""。 rel String 否 取值为“self”，表示URL为本地链接。 响应示例 { "versions": [ { "id": "v3", "links": [], "status": "CURRENT", "version": "", "min_version": "", "updated": "2017-02-07T17:34:02Z" } ] }

具体步骤 Token认证，具体操作请参考认证鉴权。 发送“POST https://DDS的Endpoint/v3/{project_id}/instances”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下： 样例中参数“region”和“availability_zone”的值为示例值。 关于创建实例接口的详细说明，请参见创建实例。 { "name": "test-cluster", //实例名称 "datastore": { "type": "DDS-Community", //数据库版本类型 "version": "3.4", //数据库版本号 "storage_engine": "wiredTiger" //存储引擎 }, "region": "aaa", //区 域名 称 "availability_zone": "bbb", //可用区名称 "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", //虚拟私有云ID "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", //子网ID "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", //安全组ID "password": "******", //管理员密码 "disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1", //磁盘加密时的密钥ID "mode": "Sharding", //分片集群实例类型 "flavor": [ { "type": "mongos", //mongos节点类型 "num": 2, //节点数量 "spec_code": "dds.mongodb.c6.medium.4.mongos" //节点资源编码 }, { "type": "shard", //shard节点类型 "num": 2, //节点数量 "storage": "ULTRAHIGH", //磁盘类型 "size": 20, //磁盘大小 "spec_code": "dds.mongodb.c6.medium.4.shard" //节点资源编码 }, { "type": "config", //config节点类型 "num": 1, //节点数量 "storage": "ULTRAHIGH", //磁盘类型 "size": 20, //磁盘大小 "spec_code": "dds.mongodb.c6.large.2.config" //节点资源编码 } ], "backup_strategy": { "start_time": "23:00-00:00", //备份时间段 "keep_days": "8" //备份文件的保留天数 }, "ssl_option":"1" } 请求成功后，返回如下信息： { "id": "46125c43ca4d424a9f5c97354223c4e0in02", "name": "test-cluster", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-14 08:50:27", "status": "creating", "region": "aaa", "availability_zone": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1", "mode": "Sharding", "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option":"1", "job_id": "c0c606b6-470a-48c7-97a2-6c7f146014d4" } 若请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度，单位为Byte。 POST请求为可选，GET请求该字段值留空。 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domianname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domianname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。 查询数据库规格 查询指定条件下的所有实例规格信息。 查询数据库磁盘类型 查询当前区域下的数据库磁盘类型。 实例管理 包括创建实例、重启实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、变更实例规格、切换副本集实例的主备节点、切换SSL开关、修改实例名称、修改数据库端口、变更实例安全组、绑定弹性公网IP、解绑弹性公网IP、修改实例内网地址、打开集群的Shard/Config IP开关接口、副本集跨网段访问配置、查询实例可迁移到的可用区、实例可用区迁移。 连接管理 包括查询实例节点会话、终结实例节点会话、查询实例节点连接数统计接口。 备份与恢复 包括创建手动备份、删除手动备份、查询备份列表、查询自动备份策略、设置自动备份策略、恢复到新实例、获取备份下载链接、查询可恢复的时间段、获取可恢复的数据库列表、获取可恢复的数据库集合列表、获取到当前实例、库表级时间点恢复接口。 参数配置 包括获取参数模板列表、创建参数模板、删除参数模板、获取参数模板的详情、修改参数模板、应用参数模板、获取指定实例的参数信息、修改指定实例的参数接口。 获取日志信息 包括查询数据库慢日志、获取慢日志下载链接、查询数据库错误日志、获取错误日志下载链接、设置审计日志策略、查询审计日志策略、获取审计日志列表、获取审计日志下载链接接口。 标签管理 包括查询资源实例、批量添加或删除资源标签、查询资源标签、查询项目标签接口。 管理数据库和用户 包括创建数据库用户、创建数据库角色、查询数据库用户列表、查询数据库角色列表、修改数据库用户密码、检查数据库密码接口、查询集群均衡设置、设置集群均衡开关、设置集群均衡活动时间窗、删除数据库用户、删除数据库角色。 配额管理 查询单租户在DDS服务下的资源配额，包括集群实例配额、单节点实例配额和副本集实例配额。 任务管理 获取DDS任务中心指定ID的任务信息。

请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 node_list 是 Array of strings 参数解释： 所有需要删除的mongos节点ID，至少保留两个mongos节点。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 请求示例： 删除实例520c58ba00a3497e97ce0b9604874dd6in02的mongos节点fea413b892214c53a58e5a529096ed75no02 DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/mongos-node { "node_list" : [ "fea413b892214c53a58e5a529096ed75no02" ] }

响应消息 参数说明 状态码：202 表3 响应Body参数 参数 参数类型 说明 job_id String 参数解释： 任务ID，仅按需实例返回该参数。 取值范围： 不涉及。 order_id String 参数解释： 订单ID，仅包周期实例返回该参数。 取值范围： 不涉及。 状态码：default 表4 ErrorResponse 参数 参数类型 说明 error_code String 参数解释： 提交任务异常时返回的错误编码。 取值范围： 不涉及。 error_msg String 参数解释： 提交任务异常时返回的错误描述信息。 取值范围： 不涉及。 响应示例 状态码： 202 Accepted. { "job_id" : "6ad4eb1f-73bd-4876-aa31-aa9a1e41c4bc" }

URI URI格式 DELETE /v3/{project_id}/instances/{instance_id}/mongos-node 表1 请求参数 名称 类型 IN 是否必选 描述 X-Auth-Token string header 是 参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 project_id string path 是 参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id string path 是 参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "region_id": "cn-north-7", "host_name": "CN_NORTH_7_E CS ", "vm_list": "[['', '', 'Euler', '[{"cores":"1","model":"","threads":"1","cpu":"16 * 1 * 1 * ","sockets":"16"}]']]", "host_id": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "host_ip": "xx.xx.xx.xx", "last_update_time": "1726819320000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host/vms?host_id=abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "REGION_ID": "cn-north-7", "HOST_ID": "dea41fb4-2583-45d7-a4b1-22d8d27c5024", "HOST_NAME": "ecs_4-CXXX034", "MANUFACTURER": "cn-north-7", "KERNEL": "0", "CPU": "[{"cores":"22","model":"Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","threads":"2","cpu":"2 * 22 * 2 * Intel(R) Xeon(R) Gold 6161 CPU @ 2.20GHz","sockets":"2"}]", "MEMORY": "[{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"},{"frequency":"2666 MHz","manufacturer":"Micron","type":"DDR4","size":"32 GB"}]", "DISK": "[{"disk":"/dev/sda:599.0GB"},{"disk":"/dev/sdb:1598.0GB"},{"disk":"/dev/sdc:10.7GB"}]", "MAC_IP": "xx.xx.xx.xx", "NETWORK_ADAPTER": "1", "RAID": "1", "SN": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "CPU_ARCH": "x86_64", "AZ_CODE": "1", "POD_CODE": "1", "CLUSTER_NAME": "ecs", "ROOM_CODE": "1", "RACK_CODE": "1", "DC_CODE": "1" } ] }

URI /rest/dataapi/homs/open-api/v1/host/detail 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 host_id 否 string 无 主机ID

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求。 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host/detail?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

URI /rest/dataapi/homs/open-api/v1/ecs/performance 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 vm_id 否 string 无 虚拟机ID

响应 响应参数 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "SERVICE": "ECS", "REGION_ID": "cn-north-7", "NAMESPACE": "ecs", "SOURCE_SERVICE": " CES ", "SOURCE_TYPE": "TenantMon", "SOURCE_TAG": "CN_NORTH_7_ECS", "TENANT_NAME": "xxx", "METRIC_NAME": "cpu_usage", "METRIC_VALUE": "10", "METRIC_UNIT": "%", "INSTANCE_ID": "abfa96bc-29f6-4571-bfba-fcfdf6ad6ebb", "TIMESTAMP": "1726819320000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求。 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/ecs/performance?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxxxx x-hcso-appcode: xxxx

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/network-device/metric-data?begin_time=0&end_time=0&offset_value=0&page_size=1 Content-Type: application/json Accept: application/json X-Auth-Token: xxx x-hcso-appcode: xxx

响应 响应参数 参数 是否必选 类型 值域 说明 device_ip 是 string 无 网络设备管理IP。 res_type 是 string 无 资源类型。 metric 是 string 无 设备指标。 region_id 是 string 无 区域编码。 value 是 string 无 指标值。 timestamp 是 string 无 时间戳。 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "total": 1698669, "list": [ { "device_ip": "xx.xx.xx.xx", "res_type": "2", "metric": "14", "region_id": "cn-north-7", "value": "0", "timestamp": "1726819320000" } ] }

URI /rest/dataapi/homs/open-api/v1/network-device/metric-data 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 是 integer 无 偏移大小：大于等于0 page_size 是 integer 默认值：500 页大小：大于等于0 management_ip 否 string 无 网络设备管理IP地址 metric 否 string 取值范围：59, 60, 14, 18, 101, 102, 61, 52 设备指标