创建手动备份
功能介绍
创建手动备份。
接口约束
备份名称不能和已有备份重名。
URI
- URI格式
- 参数说明
表1 参数说明 名称
是否必选
参数类型
说明
project_id
是
String
参数解释：
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
instance_id |
是 |
String |
参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
name |
是 |
String |
参数解释： 备份名称。 约束限制： 备份名称不能和已有备份重名。 取值范围： 4~64个字符，必须以英文字母开头，区分大小写，可以包含英文字母、数字、中划线或者下划线，不能包含其他特殊字符。 默认取值： 不涉及。 |
|
description |
否 |
String |
参数解释： 备份描述。 约束限制： 不涉及。 取值范围： 不能包含>!<"&'=特殊字符，不大于256个字符。 默认取值： 不涉及。 |
请求示例
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups
{
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
"name": "mybackup",
"description": "manual backup"
}
响应消息
- 正常响应要素说明
表3 要素说明 名称
参数类型
说明
backup
Object
参数解释：
备份信息。详情请参见表4。
表4 backup字段数据结构说明 名称
参数类型
说明
id
String
参数解释：
备份ID。
取值范围：
不涉及。
instance_id
String
参数解释：
实例ID。
取值范围：
不涉及。
name
String
参数解释：
备份名称。
取值范围：
4~64个字符，必须以英文字母开头，区分大小写，可以包含英文字母、数字、中划线或者下划线，不能包含其他特殊字符。
description
String
参数解释：
备份描述。
取值范围：
不能包含>!<"&'=特殊字符，不大于256个字符。
begin_time
String
参数解释：
备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”，其中T指时间字段的开始；Z指时区偏移量。
取值范围：
不涉及。
status
String
参数解释：
备份状态。
取值范围：
- BUILDING：备份中
- COMPLETED：备份完成
- FAILED：备份失败
- DELETING：备份删除中
type
String
参数解释：
备份类型。
取值范围：
- auto：自动全量
- manual：手动全量
- fragment：差异全量
- incremental：自动增量。
- 正常响应样例
{ "backup": { "id": "cb211c0075104151a748a854bc8bd87dbr01", "name": "mybackup", "description": "manual backup", "begin_time": "2022-08-23T07:41:50Z", "status": "BUILDING", "type": "manual", "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
