创建一个云盘异步复制关系。
接口说明
云盘异步复制是一种基于块存储数据复制能力实现跨地域数据保护的功能。该功能可以将某一块云盘的数据,异步复制到其他地域内的另一块云盘中,实现存储数据的跨地域容灾备份。您可以通过该功能建立关键业务的容灾能力,保护数据库数据的同时提升业务的连续性。关于功能注意事项以及计费的更多信息,请参见云盘异步复制概述。同时,异步复制功能以包年包月的计费方式收取带宽费用,也支持以后付费方式收取流量费用。
目前异步复制功能仅支持 ESSD 云盘,且云盘功能会受到一定的限制。
在创建异步复制关系前,您需要注意:
-
已准备好需要容灾的源云盘(异步复制关系中的主盘)以及已创建好的目标云盘(异步复制关系中的从盘)。您可以调用 CreateDisk 创建云盘。
-
创建的从盘所属的地域不能与主盘相同,当前异步复制功能支持的地域请参见云盘异步复制概述。
-
调用该接口只是创建主盘和从盘之间的异步复制关系,创建完成后,您还需要调用 StartDiskReplicaPair 激活异步复制功能,以实现周期性地将主盘数据跨地域异步复制到从盘。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ebs:CreateDiskReplicaPair | create | *DiskReplicaPair acs:ebs:{#regionId}:{#accountId}:diskreplicapair/* |
|
|
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 异步复制关系所属的地域 ID。 | cn-shanghai |
SourceZoneId | string | 是 | 源云盘(主盘)所属的可用区 ID。 | cn-beijing-f |
DiskId | string | 是 | 源云盘(主盘)的云盘 ID。 | d-iq80sgp4d0xbk24q**** |
DestinationRegionId | string | 是 | 目标云盘(从盘)所属的地域 ID。您可以调用 DescribeRegions 查询异步复制功能支持的地域信息。 | cn-shanghai |
DestinationDiskId | string | 是 | 目标云盘(从盘)的云盘 ID。 | d-sa1f82p58p1tdw9g**** |
DestinationZoneId | string | 是 | 目标云盘(从盘)所属的可用区 ID。 | cn-shanghai-e |
PairName | string | 否 | 异步复制关系的名称。长度为 2~128 个字符,必须以大小写字母或中文开头,不能以 | TestReplicaPair |
Description | string | 否 | 异步复制关系的描述信息。长度为 2~256 个英文或中文字符,不能以 | This is description. |
ChargeType | string | 否 | 异步复制关系的付费方式。取值范围:
默认值:POSTPAY。 | PREPAY |
Period | long | 否 | 异步复制关系的购买时长。当 | 1 |
PeriodUnit | string | 否 | 异步复制关系购买时长的单位。当前仅支持 Month。 Month:月。 | Month |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
Bandwidth | long | 否 | 云盘之间异步复制数据时的带宽。单位为 Kbps。取值范围:
默认值:10240。 当 ChargeType 取值为 POSTPAY 时,不能指定本参数值,系统取值为 0,表示云盘异步复制时根据数据写入变化动态分配。 | 10240 |
RPO | long | 否 | 云盘异步复制关系设定的 RPO 值,单位:秒。当前仅支持 900 秒。 | 900 |
ResourceGroupId | string | 否 | 异步复制对所在的企业资源组 ID。 | rg-acfmvs**** |
Tag | array<object> | 否 | 标签列表,最多包含 20 个子项。 | |
object | 否 | 标签信息。 | ||
Key | string | 否 | 异步复制对的标签键。 | TestKey |
Value | string | 否 | 异步复制对的标签值。 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****",
"ReplicaPairId": "pair-cn-dsa****",
"OrderId": "123456****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 该请求超时,请稍后再重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-29 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-08 | OpenAPI 错误码发生变更 | 查看变更详情 |