创建手动备份 - CreateGaussMySqlBackup
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdbformysql:backup:create
Write
-
-
gaussdb:backup:create
-
URI
POST /v3/{project_id}/backups/create
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
|
name |
是 |
String |
参数解释: 备份名称。 取值范围: 最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
|
description |
否 |
String |
参数解释: 备份描述。 取值范围: 不能包含特殊字符 ! < " = ' > &和回车,不大于256个字符。 |
响应参数
状态码: 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
backup |
backup object |
参数解释: 备份信息。 |
|
job_id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 备份ID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 备份名称。 取值范围: 取值范围:最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
|
description |
String |
参数解释: 备份描述。 取值范围: 不能包含特殊字符 ! < " = ' > &和回车,不大于256个字符。 |
|
begin_time |
String |
参数解释: 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 备份状态。 取值范围: |
|
type |
String |
参数解释: 备份类型。 取值范围: manual:手动全量备份。 |
|
instance_id |
String |
参数解释: 实例ID。 取值范围: 与请求参数保持一致。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
请求示例
创建手动备份。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
{
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07",
"name" : "backup-1",
"description" : "手动备份"
}
响应示例
状态码: 201
Success.
{
"backup" : {
"id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
"name" : "backup-1",
"description" : "手动备份",
"begin_time" : "2020-07-07T01:17:05+0800",
"status" : "BUILDING",
"type" : "manual",
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
},
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}
状态码
请参见状态码。
错误码
请参见错误码。