tencent cloud

云硬盘

新手指引
产品公告
腾讯云云硬盘快照正式商业化计费公告
腾讯云云硬盘快照跨地域复制功能正式商业化计费公告
产品简介
产品概述
产品优势
应用场景
地域和可用区
云硬盘实例
云硬盘快照
访问管理
相关产品
上一代产品
Service Regions and Service Providers
产品计费
计费概述
价格总览
购买指引
续费指引
欠费说明
快速入门
步骤1:创建云硬盘
步骤2:挂载云硬盘
步骤3:初始化云硬盘
用户指南
操作总览
使用限制
创建云硬盘
挂载云硬盘
初始化云硬盘
扩容云硬盘
卸载云硬盘
销毁云硬盘
查看云硬盘信息
调整云硬盘类型
调整云硬盘性能
云硬盘数据防护配置
云硬盘数据备份点
管理快照
监控与告警
实践教程
如何衡量云硬盘的性能
多块弹性云硬盘构建 LVM 逻辑卷
MBR 分区云硬盘扩容至大于 2TB
故障处理
Windows 云服务器无法卸载云硬盘
Linux 云服务器重启后云硬盘未自动挂载
API 文档
History
Introduction
API Category
Making API Requests
Snapshot APIs
Cloud Disk APIs
Data Types
Error Codes
常见问题
功能相关问题
计费相关问题
性能相关问题
快照相关问题
使用相关问题
服务等级协议
联系我们
词汇表

CopySnapshotCrossRegions

PDF
聚焦模式
字号
最后更新时间: 2023-07-10 16:36:12

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API is used to replicate a snapshot to another region.

  • This is an async API. A new snapshot ID is issued when the cross-region replication task is generated. It does not mean that the snapshot has been replicated successfully. You can all the DescribeSnapshots API in the destination region to check for this snapshot. If the snapshot status is NORMAL, the snapshot is replicated successfully.
  • The snapshot cross-region replication service will be commercialized in the Q3 of 2022. We will notify users about the commercialization in advance. Please check your messages in the Message Center.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CopySnapshotCrossRegions.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
DestinationRegions.N Yes Array of String Destination regions of the replication task. You can query the value of regions by calling DescribeRegions API. Note that you can only specify regions that support snapshots.
SnapshotId No String Snapshot ID, which can be queried via the DescribeSnapshots API.
SnapshotName No String Name of the snapshot replica. If it’s not specified, it defaults to “Copied [source snapshot ID from [region name]”

3. Output Parameters

Parameter Name Type Description
SnapshotCopyResultSet Array of SnapshotCopyResult Result of the cross-region replication task. The ID of the new snapshot replica is returned if the request succeeds. Otherwise Error is returned.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Replicating a snapshot from Guangzhou to Beijing

This example shows you how to replicate a snapshot from Guangzhou to Beijing.

Input Example

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CopySnapshotCrossRegions
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InsufficientSnapshotQuota Insufficient snapshot quota.
InternalError.ComponentError Dependent component request failed. Please contact customer service.
InvalidAccount.InsufficientBalance Insufficient account balance
InvalidParameterValue Invalid parameter value.
InvalidSnapshot.NotSupported Indicates that the operation is not supported for the snapshot.
InvalidSnapshotId.NotFound The ‘SnapshotId’ entered does not exist.
ResourceBusy The resource is busy. Try again later.
ResourceInUse.CopySnapshotConflict The specified snapshot is being replicated to the destination region.
UnsupportedOperation.SnapshotNotSupportCopy The snapshot does not support cross-region replication.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈