华为云用户手册

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

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 参数说明 名称 参数类型 是否必选 描述 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）、中划线、下划线和点。

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

请求示例 开启或修改自动备份策略，可以保存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 }}

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

URI GET https://{Endpoint}/v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 表2 Query参数 参数 是否必选 参数类型 描述 job_name 否 String 任务名称，默认为空。对应取值如下： "RESIZE_FLAVOR"：变更实例的CPU和内存规格 job_status 否 String 任务执行状态，默认为空。 取值： 值为"Pending"，表示任务未执行。 值为"Running"，表示任务正在执行。 值为"Completed"，表示任务执行成功。 值为"Failed"，表示任务执行失败。 值为"Canceled"，表示任务取消执行。 instance_id 否 String 实例ID，不传该值默认查所有符合条件的实例。 start_time 否 String 任务创建起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传默认为当前时间前七天。 end_time 否 String 任务创建结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传默认为当前时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。 limit 否 Integer 查询记录数。不传该参数时，默认为10，取值范围1-100。

响应参数 表4 响应Body参数 参数 参数类型 描述 total_count Integer 记录数量。 schedules Array of objects 任务详情，请参考表5。 表5 schedules 参数 参数类型 描述 job_id String 任务ID。 job_name String 任务名称。对应取值如下： "RESIZE_FLAVOR"：变更实例的CPU和内存规格 job_status String 任务执行状态。 取值： 值为"Running"，表示任务正在执行。 值为"Completed"，表示任务执行成功。 值为"Failed"，表示任务执行失败。 值为"Pending"，表示任务未执行。 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。 取值： 值为“createfail”，表示实例创建失败。 值为“creating”，表示实例创建中。 值为“normal”，表示实例正常。 值为“abnormal”，表示实例异常。 值为“deleted”，表示实例已删除。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 start_time String 任务开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 任务结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

响应示例 状态码： 200 Success { "total_count" : 1, "schedules" : [ { "job_id" : "3861199d-c196-4791-bcd0-b45fde754f50", "job_name" : "RESIZE_FLAVOR", "job_status" : "Pending", "instance_id" : "a2b33e2077ee41e397e57cd2f022b72fin02", "instance_name" : "dds-zzx-recover", "instance_status" : "normal", "create_time" : "2019-05-26T10:41:14+0000", "start_time" : "2019-05-26T10:41:14+0000", "end_time" : "2019-05-26T12:51:14+0000" } ] }

请求消息 参数说明 表2 请求Body参数 名称 参数类型 是否必选 描述 lts_configs Array of 表3 objects 是 每个Item是实例需要设置的LTS策略。 表3 lts_configs 名称 参数类型 是否必选 描述 instance_id String 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 log_type String 是 LTS日志类型，不能为空，具有以下日志类型。 audit_log 枚举值： audit_log lts_group_id String 是 LTS日志组ID。可通过 云日志 服务-“查询账号下所有日志组”API接口获取。 lts_stream_id String 是 LTS日志流ID。可通过云日志服务-“查询指定日志组下的所有日志流”API接口获取。 请求示例 为实例审计日志配置LTS服务。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs { "lts_configs" : [ { "instance_id" : "520c58ba00a3497e97ce0b9604874dd6in02", "log_type" : "audit_log", "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc" } ] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs URI样例 https://dds.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

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

请求消息 参数说明 表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}/readonly-node URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/readonly-node 表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}/db-role URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/db-role

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 参数说明 名称 参数类型 是否必选 描述 role_name String 是 角色名称。系统自带的数据库用户不可删除。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。 db_name String 是 角色所在的数据库名称。 取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。 请求示例 { "role_name": "testRole", "db_name":"testDb" }

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

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

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

响应消息 参数说明 表2 响应Body参数 名称 参数类型 描述 databases Array of objects 数据库信息列表。请参考表3。 total_count Integer 总数。 表3 databases 参数 参数类型 描述 name String 数据库名称, config admin 库不做展示。 data_size String 数据库存储大小（以GB为单位）,保留两位小数。存储大小: 实际磁盘上占用的物理空间大小，包括数据文件、日志文件、索引文件等。 storage_size String 数据库逻辑大小（以GB为单位）,保留两位小数。逻辑大小指的是数据库中实际存储的数据大小，不包括索引大小、日志大小等。 collection_num Integer 数据库中的集合数。 响应示例 { "databases" : [ { "name" : "dds-test", "data_size" : "3593", "storage_size" : "256", "collection_num" : "5" } ], "total_count" : 1 }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/databases?offset=1&limit=10

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。

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

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs URI样例 https://dds.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs 表1 请求参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。