复制备份 - CopyBackup

功能介绍

跨区域复制备份。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/backups/{backup_id}/replicate

表1 路径参数
参数	是否必选	参数类型	描述
backup_id	是	String	复制的备份ID 获取方法请参见"获取备份ID"。
project_id	是	String	项目ID，默认取值不涉及。获取方法请参见"获取项目ID"。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。默认取值不涉及。

表3 请求Body参数
参数	是否必选	参数类型	描述
replicate	是	BackupReplicateReqBody object	复制参数

表4 BackupReplicateReqBody
参数	是否必选	参数类型	描述
description	否	String	复制的描述，不能包含“<”，“>”，最大支持255个字符。默认取值不涉及。
destination_project_id	是	String	复制的目标区域项目ID，默认取值不涉及。获取方法请参见"获取项目ID"。
destination_region	是	String	复制的目标区域，默认取值不涉及。获取方法请参见" 地区和终端节点查询 "。
destination_vault_id	是	String	复制的目标区域的存储库ID，默认取值不涉及。获取方法请参见"获取存储库ID"。其中project_id需填写目标区域的project_id。
enable_acceleration	否	Boolean	跨region复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速。如果启用加速，会额外收取加速的费用。 true：启用加速复制。 false：不启用加速复制。
name	否	String	复制名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。默认取值不涉及。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
replication	BackupReplicateRespBody object	复制返回参数

表6 BackupReplicateRespBody
参数	参数类型	描述
backup_id	String	待复制的备份ID。获取方法请参见"获取备份ID"。
destination_project_id	String	复制的目标项目ID。获取方法请参见"获取项目ID"，"查询支持region信息"。
destination_region	String	复制的目标区域。获取方法请参见"地区和终端节点查询"。
destination_vault_id	String	复制的目标区域的存储库ID。获取方法请参见"获取存储库ID"。其中project_id需填写目标区域的project_id。
project_id	String	执行复制的项目ID，取值范围不涉及。
provider_id	String	资源类型id，取值范围不涉及。
replication_record_id	String	复制记录ID，取值范围不涉及。
source_region	String	复制的源区域。获取方法请参见"地区和终端节点查询"。

请求示例

复制一个备份从源备份存储库到目标备份存储库。

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/replicate

{
  "replicate" : {
    "description" : "backup_description",
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "destination_region" : "region2",
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "enable_acceleration" : false,
    "name" : "backup_name"
  }
}

响应示例

状态码：200

{
  "replication" : {
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "destination_region" : "region2",
    "source_region" : "region1",
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "replication_record_id" : "1579a71e-8d8d-41e6-85dc-d77f5ce8d91a"
  }
}