ModifyDiskReplicaPair - Elastic Compute Service - Alibaba Cloud Documentation Center

Operation description

Description

For information about the regions that support the asynchronous replication feature, see Overview of asynchronous replication.
You can modify the name or description of a replication pair only when the pair is in the Created (created) or Stopped (stopped) state.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ebs:ModifyDiskReplicaPair

update

*DiskReplicaPair

acs:ebs:{#regionId}:{#accountId}:diskreplicapair/{#ReplicaPairId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the primary or secondary disk in the replication pair. You can call DescribeRegions to query the regions that support async replication.	cn-beijing
ReplicaPairId	string	Yes	The ID of the replication pair.	pair-cn-dsa****
PairName	string	No	The name of the replication pair.	TestReplicaPair
Description	string	No	The description of the replication pair.	This is description.
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a value for this parameter from your client. Make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
Bandwidth	integer	No	The bandwidth for async replication, in Kbps. Note This parameter is not yet available.	10240
RPO	integer	No	The recovery point objective (RPO) of the replication pair-consistent group. Unit: seconds. Currently, only a value of 900 is supported.	900
EnableRtc	boolean	No	Specifies whether to enable replication time control (RTC). Valid values: false: Disables RTC. true: Enables RTC. Default value: false. Note If a replication pair is part of a replication group, its RTC setting is the same as the setting of the group.	true

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	C123F94F-4E38-19AE-942A-A8D6F44F****

Examples

Success response

JSON format

{
  "RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	The operation is not supported in the current state.
403	OperationDenied.OperateNotAllowedForPrimary	Operation is not allowed on the primary site.	The operation is not allowed on the primary site.
403	OperationDenied.OperateNotAllowedForStandby	Operation is not allowed on the secondary site.	The operation is not allowed on the secondary site.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.