更新时间:2024-04-11 GMT+08:00

创建手动备份

功能介绍

创建手动备份。

接口约束

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

URI

  • URI格式

    POST /v3/{project_id}/backups

  • URI样例

    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    说明

    instance_id

    String

    实例ID。

    name

    String

    备份名称,4~64个字符,必须以英文字母开头,区分大小写,可以包含英文字母、数字、中划线或者下划线,不能包含其他特殊字符。

    备份名称不能和已有备份重名。

    description

    String

    备份描述,不能包含>!<"&'=特殊字符,不大于256个字符。

  • 请求样例
    RDS for MySQL实例:
    {
    	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    	"name": "backup",
    	"description": "manual backup"
    }
    RDS for PostgreSQL实例:
    {
    	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    	"name": "backup",
    	"description": "manual backup"
    }

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    backup

    Object

    备份信息。

    详情请参见表4

    表4 backup字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    备份ID。

    instance_id

    String

    实例ID。

    name

    String

    备份名称。

    description

    String

    备份描述。

    begin_time

    String

    备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。

    status

    String

    备份状态,取值:

    • BUILDING: 备份中
    • COMPLETED: 备份完成
    • FAILED:备份失败
    • DELETING:备份删除中

    type

    String

    备份类型,取值:

    • auto: 自动全量
    • manual: 手动全量
    • fragment: 差异全量
    • incremental: 自动增量。
  • 正常响应样例
    RDS for MySQL实例:
    {
    	"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"
    	}
    }
    RDS for 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"
    	}
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码