更新时间:2024-03-12 GMT+08:00
分享

创建手动备份

功能介绍

创建手动备份。

调试

您可以在API Explorer中调试该接口。

接口约束

  • SQL Server数据库引擎对单库创建手动备份时,支持批量执行。
  • 只读实例不支持创建手动备份。
  • 备份名称不能和已有备份重名。

URI

  • URI格式

    POST /v3/{project_id}/backups

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一Region下的项目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

用户自建数据库名。

请求示例

  • 创建RDS for MySQL实例的手动备份mybackup。
    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups
    {
    	"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    	"name": "mybackup",
    	"description": "manual backup"
    }
  • 创建RDS for PostgreSQL实例的手动备份mybackup。
    {
    	"instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03",
    	"name": "mybackup",
    	"description": "manual backup"
    }
  • 创建RDS for SQL Server实例的手动备份mybackup。
    {
    	"instance_id": "34029da944074135a3bc24c75b3bb3edin04",
    	"name": "mybackup",
    	"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

    只支持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: 自动增量。
  • 正常响应样例
    RDS for MySQL实例:
    {
    	"backup": {
    		"id": "cb211c0075104151a748a854bc8bd87dbr01",
    		"name": "mybackup",
    		"description": "manual backup",
    		"begin_time": "2022-08-23T07:41:50Z",
    		"status": "BUILDING",
    		"type": "manual",
    		"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
    	}
    }
    RDS for PostgreSQL实例:
    {
    	"backup": {
    		"id": "104b59afd83d4fc7b2c03ad14c4be080br03",
    		"name": "mybackup",
    		"description": "manual backup",
    		"begin_time": "2022-08-23T07:20:36Z",
    		"status": "BUILDING",
    		"type": "manual",
    		"instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03"
    	}
    }
    RDS for SQL Server实例:
    {
    	"backup": {
    		"id": "6f7b5904b04043b38ad764e33daba810br04",
    		"name": "mybackup",
    		"description": "manual backup",
    		"begin_time": "2022-08-23T07:15:28Z",
    		"status": "BUILDING",
    		"type": "manual",
    		"instance_id": "34029da944074135a3bc24c75b3bb3edin04",
    		"databases": [{
    			"name": "db1"
                    }, {
    			"name": "db2"
    		}]
    	}
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品