快照跨地域复制

最近更新时间:2024-03-12 01:12:38

我的收藏

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com 。

本接口(CopySnapshotCrossRegions)用于快照跨地域复制。

  • 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的DescribeSnapshots接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
  • 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2022年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CopySnapshotCrossRegions。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DestinationRegions.N Array of String 快照需要复制到的目标地域,各地域的标准取值可通过接口DescribeRegions查询,且只能传入支持快照的地域。
示例值:["ap-beijing\r\n"]
SnapshotId String 需要跨地域复制的源快照ID,可通过DescribeSnapshots查询。
示例值:snap-ckgjwkqh
SnapshotName String 新复制快照的名称,如果不传,则默认取值为“Copied 源快照ID from 地域名”。
示例值:snap-hfdadhusads

3. 输出参数

参数名称 类型 描述
SnapshotCopyResultSet Array of SnapshotCopyResult 快照跨地域复制的结果,如果请求下发成功,则返回相应地地域的新快照ID,否则返回Error。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 将快照从广州复制到北京

将快照从广州复制到北京

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CopySnapshotCrossRegions
<公共请求参数>

{
    "SnapshotId": "snap-ckgjwkqh",
    "DestinationRegions": [
        "ap-beijing"
    ]
}

输出示例

{
    "Response": {
        "SnapshotCopyResultSet": [
            {
                "SnapshotId": "snap-d012rm6t",
                "DestinationRegion": "ap-beijing",
                "Code": "Success",
                "Message": ""
            }
        ],
        "RequestId": "98f0b5f0-7d84-4d11-9819-ee7804e524a4"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InsufficientSnapshotQuota 快照配额不足。
InternalError.ComponentError 依赖组件请求失败,请联系客服人员解决。
InvalidAccount.InsufficientBalance 账户余额不足。
InvalidParameterValue 参数取值错误。
InvalidSnapshot.NotSupported 快照不支持该操作。
InvalidSnapshotId.NotFound 输入的SnapshotId不存在。
ResourceBusy 资源繁忙,请稍后重试。
ResourceInUse.CopySnapshotConflict 指定快照正在复制到目标地域。
UnsupportedOperation.SnapshotNotSupportCopy 快照不支持跨地域复制。