文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 备份与恢复/ 手动转储备份（MySQL） - TransferBackup
更新时间：2026-02-13 GMT+08:00
查看PDF
分享

手动转储备份（MySQL） - TransferBackup

功能介绍

手动转储备份。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:backup:download

write

-

-

-

-

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

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

    默认取值：

    不涉及。

    instance_id

    是

    String

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

backups

是

Array of String

参数解释：

备份ID列表。

约束限制：

不涉及。

取值范围：

backups内元素数量最小为1，并且元素要求唯一。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

destination

是

String

参数解释：

目标OBS桶名。

约束限制：

不涉及。

取值范围：

0~128个字符。

默认取值：

不涉及。

prefix

否

String

参数解释：

转储目标前缀，标识在OBS桶中存储位置的前缀。

约束限制：

不涉及。

取值范围：

0~96个字符，请以分隔符“/”结尾。

默认取值：

不涉及。

请求示例

手动转储备份。

POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e38d120bb5a640519fb2a1613140afd9in01/backups/transfer

{ 
     "instance_id":"9addef3bcf264a8a82e710d62b3f1439in01", 
     "backups":[ 
     "38e7f95bc332408e9b4d6409fc28f9a0br01" 
     ], 
     "destination":"obs-test", 
     "prefix":"test/" 
}

响应消息

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

    参数

    参数类型

    描述

    results

    Array of objects

    参数解释：

    转储任务结果。详情请参见表4。
    表4 results字段说明

    名称

    参数类型

    说明

    backup_id

    String

    参数解释：

    备份ID。

    取值范围：

    不涉及。

    status

    String

    参数解释：

    任务提交状态。

    取值范围：

    Success：任务提交成功。

    job_id

    String

    参数解释：

    任务ID。

    取值范围：

    不涉及。
  • 正常响应样例 
    { 
    "results":[ 
        { 
         "backup_id":"38e7f95bc332408e9b4d6409fc28f9a0br01", 
          "status":"Success", 
          "job_id":"9b0b2a50-e2ea-468a-90ce-a777217b7570" 
        } 
    ] 
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 备份与恢复