创建手动备份

功能介绍

创建手动备份。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

• 只读实例不支持创建手动备份。
• 备份名称不能和已有备份重名。

URI

• URI格式

  POST https://{Endpoint}/v3/{project_id}/backups

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。

请求消息

• 参数说明

  表2 参数说明

  名称	是否必选	参数类型	说明
  instance_id	是	String	实例ID。
  name	是	String	备份名称，4~64个字符，必须以英文字母开头，区分大小写，可以包含英文字母、数字、中划线或者下划线，不能包含其他特殊字符。 备份名称不能和已有备份重名。
  description	否	String	备份描述，不能包含>!<"&'=特殊字符，不大于256个字符。
  databases	否	Array of objects	只支持Microsoft SQL Server，局部备份的用户自建数据库名列表，当有此参数时以局部备份为准。 详情请参见表3。

  表3 databases字段数据结构说明

  名称	是否必选	参数类型	说明
  name	是	String	用户自建数据库名。

• 请求样例
  MySQL/PostgreSQL实例：

  {
  	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
  	"name": "backup",
  	"description": "manual backup"
  }

  Microsoft SQL Server实例：

  {
  	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04",
  	"name": "backup",
  	"description": "manual backup",
  	"databases": [{
  		"name": "db1"
  	}, {
  		"name": "db2"
  	}]
  }

响应消息

• 正常响应要素说明

  表4 要素说明

  名称	参数类型	说明
  backup	Object	备份信息。 详情请参见表5。

  表5 backup字段数据结构说明

  名称	参数类型	说明
  id	String	备份ID。
  instance_id	String	实例ID。
  name	String	备份名称。
  description	String	备份描述。
  databases	Array of objects	只支持Microsoft SQL Server，局部备份的用户自建数据库名列表，当有此参数时以局部备份为准。 详情请参见表3。
  begin_time	String	备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”，其中T指时间字段的开始；Z指时区偏移量。
  status	String	备份状态，取值： BUILDING: 备份中 COMPLETED: 备份完成 FAILED：备份失败 DELETING：备份删除中
  type	String	备份类型，取值： auto: 自动全量 manual: 手动全量 fragment: 差异全量 incremental: 自动增量。

• 正常响应样例
  MySQL/PostgreSQL实例：

  {
  	"backup": {
  		"id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
  		"name": "backupDemo",
  		"description": "This is a description",
  		"begin_time": "2016-09-12T01:17:05",
  		"status": "BUILDING",
  		"type": "manual",
  		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
  	}
  }

  Microsoft SQL Server实例：

  {
  	"backup": {
  		"id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
  		"name": "backupDemo",
  		"description": "This is a description",
  		"begin_time": "2016-09-12T01:17:05",
  		"status": "BUILDING",
  		"type": "manual",
  		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
  		"databases": [{
  			"name": "db1"
  		}]
  	}
  }

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。