文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 创建手动备份
更新时间：2025-10-17 GMT+08:00
查看PDF
分享

创建手动备份

功能介绍

创建手动备份。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

URI

POST /v3/{project_id}/instances/{instance_id}/backups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释：

手动备份名称。

约束限制：

长度为4~64位，必须以字母开头（A~Z或a~z），区分大小写，可以包含字母、数字（0~9）、中划线（-）或者下划线（_），不能包含其他特殊字符。

取值范围：

不涉及。

默认取值：

不涉及。

description

是

String

参数解释：

手动备份描述。

约束限制：

长度不超过256位，且不能包含>!<"&'=特殊字符。

取值范围：

不涉及。

默认取值：

不涉及。

database_tables

否

Array of objects

参数解释：

备份里的库表信息。详情请参考表4。

约束限制：

该参数仅针对GeminiDB Cassandra。

取值范围：

  • 字段为空，表示创建实例级备份。
  • 字段非空，表示创建库表级备份。

默认取值：

不涉及。
表4 DatabaseTableInfo

参数

是否必选

参数类型

描述

database_name

是

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

table_names

否

Array of strings

参数解释：

数据表名称列表。

约束限制：

不涉及。

取值范围：

  • table_names为空的时候，表示库级别备份。
  • table_names非空的时候，表示表级别备份。

默认取值：

不涉及。

响应参数

状态码： 202

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

任务ID。

取值范围：

不涉及。

backup_id

String

参数解释：

备份ID。

取值范围：

不涉及。

请求示例

  • URI样例 
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups
  • 创建库表级手动备份 
    {
   "name" : "创建库表级手动备份", 
   "description" : "创建库表级手动备份", 
   "database_tables" : [ { 
     "database_name" : "databaseNameA", 
     "table_names" : [ "table_A", "table_B" ] 
   }, { 
     "database_name" : "databaseNameB", 
     "table_names" : null 
   } ] 
 }

响应示例

状态码： 202

Success

{ 
  "job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05", 
  "backup_id" : "646d88d0b03f4fd2ae944ae2a33bcb6ain06" 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复