创建手动备份

功能介绍

创建手动备份。

当前页面API为历史版本API，未来可能停止维护。建议及时切换到新接口创建手动备份。

调用方法

请参见如何调用API。

URI

POST /mysql/v3/{project_id}/backups/create

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的project ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language	否	String	请求语言类型。默认en-us。取值范围： en-us zh-cn

表3 请求Body参数
参数	是否必选	参数类型	描述
instance_id	是	String	实例ID，严格匹配UUID规则。
name	是	String	备份名称。取值范围：4~64个字符之间，（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中文、中划线或下划线，不能包含其他特殊字符。
description	否	String	备份描述，不能包含>!<"&'=特殊字符和回车，不大于256个字符。

响应参数

状态码： 201

表4 响应Body参数
参数	参数类型	描述
backup	backup object	备份信息。
job_id	String	工作流ID。

表5 backup
参数	参数类型	描述
id	String	备份ID
name	String	备份名称。
descriprion	String	备份描述。
begin_time	String	备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”，其中T指时间字段的开始；Z指时区偏移量。
status	Object	备份状态枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。
type	Object	备份类型，取值：枚举值： manual：手动全量备份。
instance_id	String	实例ID。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

创建手动备份

POST https://{endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create

{
  "instance_id" : "ef25188419f941309882d2986b2210b9in07",
  "name" : "backup-01",
  "description" : "create backup" 
}

响应示例

状态码： 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" : "ef25188419f941309882d2986b2210b9in07"
  }
  "job_id" : "e08bbfc8-1ac5-6721-b9e9-7dd685c6bdd7"
}