文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 备份与恢复/ 创建手动备份
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

创建手动备份

接口说明

创建数据库实例的手动备份。

URI

  • URI格式

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

请求参数

表1 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。
表2 参数说明

名称

参数类型

是否必选

描述

backup

Object

是

备份参数对象。详情请参见表3。
表3 backup字段数据结构说明

名称

参数类型

是否必选

描述

instance_id

String

是

实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

name

String

是

手动备份名称。

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

description

String

否

手动备份描述。

取值范围：长度不超过256位，且不能包含>!<"&'=特殊字符。
  • 请求示例 
    {
        "backup":{
                "instance_id": "a89dab5e39394eccbdb77b19d57b0180in02",
                "name": "mybackup1",
                "description": "The first Manual backup"
        }
}

响应参数

  • 参数说明
    表4 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    是

    手动备份的异步任务ID。

    backup_id

    String

    是

    手动备份ID。
  • 响应示例 
    {
    "job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec",    
    "backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 备份与恢复