文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 备份恢复管理/ 创建手动备份
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

创建手动备份

功能介绍

创建手动备份。

调试

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

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 参数说明

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

name

是

String

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

最小长度：4

最大长度：64

description

否

String

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

最大长度：256

请求示例

创建GaussDB手动全量备份。

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups
{
  "instance_id" : "7e01ac5ac5274957ba506f3851d11d51in14",
  "name" : "backupwqwq3",
  "description" : "manual backup"
}

响应参数

表3 响应Body参数

参数

参数类型

描述

backup

Object

备份信息。

详情请参见表4。

job_id

String

任务ID。
表4 backup字段数据结构说明

参数

参数类型

描述

id

String

备份ID。

name

String

备份名称，不可重复。

description

String

备份描述。

begin_time

String

备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

status

String

备份状态，取值：

  • BUILDING：备份中。
  • COMPLETED：备份完成。
  • FAILED：备份失败。

type

String

备份类型，“manual”表示手动全量备份。

instance_id

String

实例ID。

响应示例

{
    "backup": {
        "id": "e76112bfb2074871bf54cb8df5af7f64br14",
        "name": "backupwqwq32",
        "description": "mannual backup",
        "status": "BUILDING",
        "type": "manual",
        "begin_time": "2022-05-09T18:02:31+0800",
        "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
    },
    "job_id": "e4733090-b2c8-4ea7-a33a-f55f65723fb3"
}

状态码

错误码

请参见错误码。

父主题： 备份恢复管理

相关文档