创建手动备份
接口说明
创建数据库实例的手动备份。
URI
名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
X-Auth-Token |
string |
是 |
参数解释: 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
string |
是 |
参数解释: 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求消息
- 参数说明
表2 backup字段数据结构说明 名称
参数类型
是否必选
描述
backup
Object
是
参数解释:
备份参数对象。详情请参见表2。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
instance_id
String
是
参数解释:
实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
name
String
是
参数解释:
手动备份名称。
约束限制:
长度为4~64位,必须以字母开头(A~Z或a~z),区分大小写,可以包含字母、数字(0~9)、中划线(-)或者下划线(_),不能包含其他特殊字符。
取值范围:
不涉及。
默认取值:
不涉及。
description
String
否
参数解释:
手动备份描述。
约束限制:
长度不超过256位,且不能包含>!<"&'=特殊字符。
取值范围:
不涉及。
默认取值:
不涉及。
请求示例
{ "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" }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。