CreateDiskReplicaPair

更新时间: 2023-11-01 15:13:09

调用CreateDiskReplicaPair创建一个云盘异步复制关系。

接口说明

云盘异步复制是一种基于块存储数据复制能力实现跨地域数据保护的功能。该功能可以将某一块云盘的数据,异步复制到其他地域内的另一块云盘中,实现存储数据的跨地域容灾备份。您可以通过该功能建立关键业务的容灾能力,保护数据库数据的同时提升业务的连续性。关于功能注意事项以及计费的更多信息,请参见云盘异步复制概述。同时,异步复制功能以包年包月的计费方式收取带宽费用,也支持以后付费方式收取流量费用。

目前异步复制功能仅支持ESSD云盘,且云盘功能会受到一定的限制。

在创建异步复制关系前,您需要注意:

  • 已准备好需要容灾的源云盘(异步复制关系中的主盘)以及已创建好的目标云盘(异步复制关系中的从盘)。您可以调用CreateDisk创建云盘。
  • 创建的从盘所属的地域不能与主盘相同,当前异步复制功能支持的地域请参见云盘异步复制概述
  • 调用该接口只是创建主盘和从盘之间的异步复制关系,创建完成后,您还需要调用StartDiskReplicaPair激活异步复制功能,以实现周期性地将主盘数据跨地域异步复制到从盘。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateDiskReplicaPair

系统规定参数。取值:CreateDiskReplicaPair

RegionId String cn-shanghai

异步复制关系所属的地域ID。

SourceZoneId String cn-beijing-f

源云盘(主盘)所属的可用区ID。

DiskId String d-iq80sgp4d0xbk24q****

源云盘(主盘)的云盘ID。

DestinationRegionId String cn-shanghai

目标云盘(从盘)所属的地域ID。您可以调用DescribeRegions查询异步复制功能支持的地域信息。

DestinationDiskId String d-sa1f82p58p1tdw9g****

目标云盘(从盘)的云盘ID。

DestinationZoneId String cn-shanghai-e

目标云盘(从盘)所属的可用区ID。

PairName String TestReplicaPair

异步复制关系的名称。长度为2~128个字符,必须以大小写字母或中文开头,不能以http://https://开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

Description String This is description.

异步复制关系的描述信息。长度为2~256个英文或中文字符,不能以http://https://开头。

ChargeType String PREPAY

异步复制关系的付费方式。取值范围:

  • PREPAY:包年包月。
  • POSTPAY:按量付费。

默认值:POSTPAY。

Period Long 1

异步复制关系的购买时长。当ChargeType=PREPAY时,该参数为必选参数。时长单位由PeriodUnit指定,取值范围:1、2、3、6、12、24、36、60。

PeriodUnit String Month

异步复制关系购买时长的单位。当前仅支持Month。

Month:月。

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

Bandwidth Long 10240

云盘之间异步复制数据时的带宽。单位为Kbps。取值范围:

  • 10240
  • 20480
  • 51200
  • 102400

默认值:10240。

当ChargeType取值为POSTPAY时,不能指定本参数值,系统取值为0,表示云盘异步复制时根据数据写入变化动态分配。

RPO Long 900

云盘异步复制关系设定的RPO值,单位:秒。当前仅支持900秒。

ResourceGroupId String rg-acfmvs****

异步复制对所在的企业资源组ID。

Tag.N.Key String TestKey

异步复制对的标签键。

Tag.N.Value String TestValue

异步复制对的标签值。

返回数据

名称

类型

示例值

描述

RequestId String C123F94F-4E38-19AE-942A-A8D6F44F****

请求ID。

ReplicaPairId String pair-cn-dsa****

异步复制关系ID。

OrderId String 123456****

订单ID。

示例

请求示例

http(s)://ebs.cn-beijing.aliyuncs.com/?Action=CreateDiskReplicaPair
&RegionId=cn-shanghai
&SourceZoneId=cn-beijing-f
&DiskId=d-iq80sgp4d0xbk24q****
&DestinationRegionId=cn-shanghai
&DestinationDiskId=d-sa1f82p58p1tdw9g****
&DestinationZoneId=cn-shanghai-e
&PairName=TestReplicaPair
&Description=This is description.
&ChargeType=PREPAY
&Period=1
&PeriodUnit=Month
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Bandwidth=10240
&RPO=900
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDiskReplicaPairResponse>
    <RequestId>C123F94F-4E38-19AE-942A-A8D6F44F****</RequestId>
    <ReplicaPairId>pair-cn-dsa****</ReplicaPairId>
    <OrderId>123456****</OrderId>
</CreateDiskReplicaPairResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C123F94F-4E38-19AE-942A-A8D6F44F****",
  "ReplicaPairId" : "pair-cn-dsa****",
  "OrderId" : "123456****"
}

错误码

HttpCode

错误码

错误信息

描述

400 IdempotentParameterMismatch The specified parameter has changed while using an already used clientToken. 如果您提供了一个已经使用过的ClientToken,但其他请求参数有变化。
403 OperationDenied The operation is not allowed. 当前操作不允许执行。
403 OperationDenied.InvalidStatus The operation is not allowed in current status. 当前状态下该操作不允许执行。
403 OperationDenied.QuotaExceed The operation is not allowed due to quota exceed. 当前操作已超过使用配额。
403 LastTokenProcessing The last token request is processing. 相同clientToken的请求正在执行,请稍后再重试。
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance. 您的账户余额不足。
403 Forbidden User is not authorized to operate. 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403 Forbidden.Action User is not authorized to operate this action. 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
404 NoSuchResource The specified resource does not exist. 指定的资源不存在。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
504 RequestTimeout The request is timeout, please try again later. 该请求超时,请稍后再重试。

访问错误中心查看更多错误码。

阿里云首页 云服务器 ECS 相关技术圈