创建备份
更新时间：2023-11-07
说明
- 为指定实例创建备份。
- 实例须处于运行中状态。
请求结构
PUT /v{version}/instance/{instanceId}?backup HTTP/1.1
HOST: hbase.bj.baidubce.com
Authorization: authorization string
{
"backupAllTable":false,
"tables":"default:*",
"description": "xxx"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API版本号，当前取值1 |
| instanceId | string | 是 | URL参数 | 指定实例Id |
| target | string | 否 | RequestBody参数 | 备份的存储源，不填写则备份到实例的备份空间。当前不允许用户指定target。 |
| backupAllTable | boolean | 是 | RequestBody参数 | 是否对所有表进行备份。 |
| tables | string | 否 | RequestBody参数 | 如果backupAllTable为false，则需要指定备份的表。格式为namespace:table，其中namespace为命名空间，table是表名，支持*表示备份所有表。 例：default:table1,namesapce1:table2。 如果需要备份多个表，则用逗号（,）隔开。 |
| description | string | 否 | RequestBody参数 | 备份备注信息 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| backupId | string | 备份ID |
请求示例
PUT /v1/instance/hb-abc123?backup HTTP/1.1
HOST: hbase.bj.baidubce.com
Authorization: authorization string
{
"target": "bos://bucket/object_prefix",
"backupAllTable":false,
"tables":"default:*,namesapce1:table2",
"description": "xxx"
}此请求表示对命名空间default的所有表、命名空间namesapce1的table2表进行备份。
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Content-Type: application/json;charset=UTF-8
{
"backupId": "backup-xxxxxx"
}