更新时间:2024-04-01 GMT+08:00

创建手动备份

功能介绍

创建手动备份。

该接口计划于2025-03-31下线,建议及时切换到新接口创建手动备份

URI

  • URI格式

    POST https://{endpoint}/mysql/v3/{project_id}/backups/create

  • URI样例

    POST https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/backups/create

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一Region下的project ID。

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

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

instance_id

String

实例ID,严格匹配UUID规则。

name

String

备份名称。

取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

description

String

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

  • 请求样例
    {
       "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
       "name": "backup-1",
       "description": "manual backup"
    }

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    backup

    Object

    备份信息。

    详情请参见表 backup字段数据结构说明

    表4 backup字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    备份ID。

    name

    String

    备份名称。

    description

    String

    备份描述。

    begin_time

    String

    备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。

    status

    String

    备份状态,取值:

    • BUILDING: 备份中。
    • COMPLETED: 备份完成。
    • FAILED:备份失败。
    • AVAILABLE:备份可用。

    type

    String

    备份类型,取值:

    • manual: 手动全量。

    instance_id

    String

    实例ID。

  • 正常响应样例:
    {
    "backup": {
    "id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
    "name": "backup-1",
    "begin_time": "2020-07-07T01:17:05+0800",
    "status": "BUILDING",
    "type": "manual",
    "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
    "description": "desc"
    }
    }

状态码

请参见状态码

错误码

请参见错误码