华为云用户手册

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backup_policy Object 是 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。 表3 backup_policy字段数据结构说明 名称 参数类型 是否必选 描述 keep_days String 是 指定已生成的备份文件可以保存的天数。 取值范围：0～732。取0值，表示关闭自动备份策略。 start_time String 否 备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 23:00-00:00 period String 否 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下： 0天，不传该参数。 1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。 7～732天，备份周期至少选择一周中的一天。示例：1,2,3,4。

请求示例 开启或修改自动备份策略，可以保存9天，备份时间段为23:00-00:00，指定备份周期 { "backup_policy": { "keep_days": 9, "start_time": "23:00-00:00", "period": "1,4,5,6,7" } } 关闭自动备份策略 { "backup_policy": { "keep_days": 0 } }

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backup_policy Object 是 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。 表3 backup_policy字段数据结构说明 名称 参数类型 是否必选 描述 keep_days Integer 是 备份文件可以保存的天数。 start_time String 否 备份时间段。自动备份将在该时间段内触发。 period String 否 备份周期配置。自动备份将在每星期指定的天进行。 响应示例 自动备份策略开启： { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,4,5,6" } } 自动备份策略关闭： { "backup_policy": { "keep_days": 0 } }

响应消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 backups Array of objects 是 备份列表。详情请参见表3。 total_count Integer 是 总记录数。 表3 backups字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 备份ID。 name String 是 备份名称。 instance_id String 是 备份所属的实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 instance_name String 是 备份所属的实例名称。 datastore Object 是 数据库版本信息。详情请参见表4。 type String 是 备份类型。 取值为“Auto”，表示自动全量备份。 取值为“Manual”，表示手动全量备份。 取值为“Incremental”，表示自动增量备份。 begin_time String 是 备份开始时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 end_time String 是 备份结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 status String 是 备份状态。取值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 DISABLED：备份删除中。 size Long 是 备份大小，单位：KB。 description String 是 备份描述。 表4 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”。 响应示例 { "backups": [ { "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "backup-test", "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name": "cluster-test", "datastore" : { "type" : "DDS-Community", "version" : "3.4" }, "type": "auto", "begin_time": "2018-08-06 12:41:14", "end_time": "2018-08-06 12:43:14", "status": "COMPLETED", "size": 2803, "description": "backup description" } ], "total_count":1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}&mode={mode} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14

请求示例 创建一个数据库实例的手动备份，名称为mybackup1，描述为The first Manual backup { "backup":{ "instance_id": "a89dab5e39394eccbdb77b19d57b0180in02", "name": "mybackup1", "description": "The first Manual backup" } }

响应消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 job_id String 是 手动备份的异步任务ID。 backup_id String 是 手动备份ID。 响应示例 { "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec", "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02" }

请求消息 参数说明 表3 参数说明 名称 参数类型 是否必选 描述 resize Object 是 目标规格信息。详情请参见表4。 is_auto_pay Boolean 否 变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 对于降低规格场景，该字段无效。 对于扩大规格场景： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表4 resize字段数据结构说明 名称 参数类型 是否必选 描述 target_type String 否 对象类型。 对于集群实例，该参数为必选。变更mongos节点规格时，取值为“mongos”；变更单个shard组规格、或者批量变更多个shard组规格时，取值为“shard”，变更config组规格时，取值为"config"。 对于副本集实例，不传该参数。变更readonly节点规格时,取值为“readonly”。 对于单节点实例，不传该参数。 枚举值： mongos shard config readonly target_id String 是 待变更规格的节点ID或实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 对于集群实例，变更mongos节点规格时，取值为mongos节点ID；变更单个shard组规格时，取值为shard组ID；批量变更多个shard组规格时，不传该参数；变更config组规格时，取值为config组的ID。 对于副本集实例，取值为相应的实例ID。变更readonly节点规格时，取值为readonly节点ID。 对于单节点实例，取值为相应的实例ID。 target_spec_code String 是 变更至新规格的资源规格编码。获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。

请求示例 变更集群实例下mongos节点的规格 { "resize": { "target_type": "mongos", "target_id": "a742c13a284949adad177672e8a0f01cno02", "target_spec_code": "dds.mongodb.c6.large.4.mongos" } } 变更集群实例下shard组的规格 { "resize": { "target_type": "shard", "target_id": "aeeb40a704904977ad78993d138ec942gr02", "target_spec_code": "dds.momgodb.c6.large.4.shard" } } 变更集群实例下config组的规格 { "resize": { "target_type": "config", "target_id": "10a1c330537b42c1a9b3f7a5ebcda35egr02", "target_spec_code": "dds.momgodb.c6.xlarge.2.config" } } 变更副本集或单节点实例的规格 { "resize": { "target_id": "aeeb40a704904977ad78993d138ec942in02", "target_spec_code": "dds.mongodb.c6.medium.4.repset" } }

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

请求示例 扩容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格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 type String 是 待扩容的对象类型。 扩容mongos节点时，取值为“mongos”。 扩容shard组时，取值为“shard”。 spec_code String 是 资源规格编码，获取方式请参见查询数据库规格中响应参数“flavors.spec_code”。 num String 是 待扩容的mongos节点或shard组数量。一个集群实例下，最多支持32个mongos节点和32个shard组。 volume Object 否 磁盘信息。详情请参见表3。 扩容mongos节点时，不传该参数。 扩容shard组时，该参数必选，指定新增的所有shard组的磁盘信息。 说明： 如果一次性添加多个shard组，该shard组只能选择相同的规格和磁盘容量。 is_auto_pay Boolean 否 扩容包年包月实例的节点数量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表3 volume字段数据结构说明 名称 参数类型 是否必选 描述 size String 是 指定新增的所有shard组的磁盘容量。取值范围：10GB~5000GB。

请求示例 扩容集群实例的存储容量，磁盘容量为20GB POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", "size" : 20 } } 扩容副本集实例的存储容量，磁盘容量为20GB POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20 } } 扩容单节点实例的存储容量，磁盘容量为20GB POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20 } } 扩容副本集只读节点的存储容量，磁盘容量为20GB POST https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume { "volume" : { "size" : 20, "node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ] } }

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

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 volume Object 是 volume请求详细信息。 详情请参见表3。 is_auto_pay Boolean 否 扩容包年包月实例的存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表3 volume字段数据结构说明 名称 参数类型 是否必选 描述 group_id String 否 角色组ID。 对于集群实例，该参数为shard组ID。 对于副本集和单节点实例，不传该参数。 size String 是 待扩容到的磁盘容量。取值为10的整数倍，并且大于当前磁盘容量。 对于集群实例，表示扩容到的单个shard组的磁盘容量。取值范围：10GB~5000GB。 对于副本集实例，表示扩容到的实例的磁盘容量，取值范围：10GB~5000GB。 对于单节点实例，表示扩容到的实例的磁盘容量，取值范围：10GB~1000GB。 node_ids Array of strings 否 副本集只读节点磁盘扩容时，需要传入该参数，当前list只支持传入一个元素。

响应消息 参数说明 表2 响应Body参数 名称 参数类型 是否必选 描述 instances Array of objects 是 实例信息。详情请参见表3。 total_count Integer 是 总记录数。 表3 instances字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 实例ID。 name String 是 实例名称。 remark String 是 实例备注。 status String 是 实例状态。 取值： normal，表示实例正常。 abnormal，表示实例异常。 creating，表示实例创建中。 frozen，表示实例被冻结。 data_disk_full，表示存储空间满。 createfail，表示实例创建失败。 enlargefail，表示实例扩容节点个数失败。 说明： 实例正在执行的动作（actions），例如“rebooting，重启中”与实例状态（status）有本质的区别。详情请参见该表中的actions字段。 port String 是 数据库端口号。文档数据库实例支持的端口号范围为2100～9500。 mode String 是 实例类型。与请求参数相同。 region String 是 实例所在区域。 datastore Object 是 数据库信息。 详情请参见表4。 engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 created String 是 实例创建时间。 updated String 是 实例操作最新变更的时间。 db_user_name String 是 默认用户名。取值为“rwuser”。 ssl Integer 是 是否开启SSL安全连接。 取值为“1”，表示开启。 取值为“0”，表示不开启。 vpc_id String 是 虚拟私有云ID。 subnet_id String 是 子网的网络ID。 security_group_id String 是 安全组ID列表。当实例存在多安全组时，多个安全组ID采用英文逗号分隔。 backup_strategy Object 是 备份策略。 详情请参见表5。 pay_mode String 否 计费方式。 取值为“0”，表示按需计费。 取值为“1”，表示包年/包月计费。 maintenance_window String 是 系统可维护时间窗。 groups Array of objects 是 组信息。 详情请参见表6。 disk_encryption_id String 是 磁盘加密的密钥ID。该参数仅在实例磁盘被加密时返回。 enterprise_project_id String 是 企业项目ID。 取值为“0”，表示为default企业项目。 time_zone String 是 时区。 dss_pool_id String 否 Dec用户专属存储ID。 actions Array of strings 是 实例正在执行的动作。 取值： RESTARTING，重启中。 RESTORE，恢复中。 RESIZE_FLAVOR，规格变更中。 RESTORE_TO_NEW_INSTANCE，恢复中。 MODIFY_VPC_PEER，跨子网访问设置中。 CREATE，创建中。 FROZEN，冻结。 RESIZE_VOLUME，存储扩容中。 RESTORE_CHECK，恢复检查中。 RESTORE_FAILED_HANGUP，恢复失败。 CLOSE_AUDIT_ LOG ，关闭审计策略中。 OPEN_AUDIT_LOG，打开审计策略中。 PERIOD_RESOURCE_SPEC_CHG，包周期资源变更检查中。 CREATE_IP_SHARD，shard IP显示开启中。 CREATE_IP_CONFIG，config IP显示开启中。 GROWING，节点扩容中。 SET_CONFIGURATION，修改参数中。 RESTORE_TABLE，恢复中。 MODIFY_SECURITYGROUP，修改安全组中。 BIND_EIP，修改公网EIP中。 UNBIND_EIP，解绑EIP中。 SWITCH_SSL，切换SSL中。 SWITCH_PRIMARY，主备切换中。 CHANGE_DBUSER_PASSWORD，修改密码中。 MODIFY_PORT，修改端口号中。 MODIFY_IP，修改内网IP中。 DELETE_INSTANCE，实例删除中。 REBOOT，重启中。 BACKUP，备份中。 MIGRATE_AZ，可用区迁移中。 PWD_RESETING，重置密码中。 UPGRADE_DATABASE，补丁升级中。 DATA_MIGRATION，数据迁移中。 SHARD_GROWING，分片扩容中。 APPLY_CONFIGURATION，变更参数组中。 RESET_PASSWORD，重置密码中。 GROWING_REVERT，删除节点中。 SHARD_GROWING_REVERT，分片删除中。 ONDEMAND_TO_PERIOD，转包周期中。 LOG_PLAINTEXT_SWITCH，慢日志配置修改中。 CREATE_DATABASE_USER，创建数据库用户中。 CREATE_DATABASE_ROLE，创建数据库角色中。 MODIFY_NAME，修改名称中。 MODIFY_PRIVATE_DNS，修改内网 域名 中。 MODIFY_OP_LOG_SIZE，oplog大小修改中。 ADD_READONLY_NODES，只读节点扩容中。 order_id String 否 订单ID，仅包周期场景返回。 tags Array of objects 是 标签列表。 详情请参见表9。 表4 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库引擎。 version String 是 数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。 patch_available Boolean 是 当前实例是否有可升级的补丁，返回true时可以通过“数据库补丁升级”进行升级。 表5 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。 keep_days Integer 是 已生成备份文件可以保存的天数。取值范围：0~732。 表6 groups字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： shard config mongos replica single readonly id String 是 组ID。节点类型为shard、config和readonly时，该参数有效。 name String 是 组名称。节点类型为shard、config和readonly时，该参数有效。 status String 是 组状态。节点类型为shard、config和readonly时，该参数有效。 volume Object 是 volume信息。详情请参见表7。节点类型为shard、config、replica、single、readonly时，该参数有效。 nodes Array of objects 是 节点信息。详情请参见表8。 表7 volume字段数据结构说明 名称 参数类型 是否必选 描述 size String 是 磁盘大小。单位：GB。 used String 是 磁盘使用量。单位：GB。 表8 nodes字段数据结构说明 名称 参数类型 是否必选 描述 id String 是 节点ID。 name String 是 节点名称。 status String 是 节点状态。 role String 是 节点角色。 取值： master，mongos节点返回该值。 Primary，shard组主节点、config组主节点、副本集主节点、单节点返回该值。 Secondary，shard组备节点、config组备节点、副本集备节点返回该值。 Hidden，shard组隐藏节点、config组隐藏节点、副本集隐藏节点返回该值。 unknown，节点异常时返回该值。 Readonly, 只读节点返回改值。 private_ip String 是 节点内网IP。该参数默认仅针对集群实例的mongos节点、副本集实例、以及单节点实例有效，且在弹性云服务器创建成功后参数值存在，否则，值为""。 注意： 打开shard或者config IP 之后，集群实例的shard节点或者config节点的Primary、Secondary节点也会有该值。 public_ip String 是 绑定的外网IP。该参数仅针对集群实例的mongos节点、副本集实例的主节点和备节点、以及单节点实例有效。 spec_code String 是 资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。 availability_zone String 是 可用区。 表9 tag字段说明 名称 参数类型 是否必选 描述 key String 是 标签键。 value String 是 标签值。 响应示例中参数“region”和“availability_zone”的值为示例值。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value},{key}={value} URI样例 查询所有实例列表和详情 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances 根据指定条件查询实例列表和详情 https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&tags=key1=value1,key2=value2

请求消息 参数说明 表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

请求示例 根据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" } ] }

响应消息 参数说明 表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" } 若请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。