Use DescribePairDrills to Monitor Disaster Recovery Drill Status - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the disaster recovery drills that were performed on the replication pair whose secondary disk resides in a specific region.

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:DescribePairDrills

list

*DiskReplicaPair

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the primary or secondary disk in the async replication pair. You can call the DescribeRegions operation to query the most recent list of regions in which async replication is supported.	cn-hangzhou
DrillId	string	No	The ID of the drill.	drill-xxxx
PairId	string	Yes	The ID of the replication pair. You can call the DescribeDiskReplicaPairs operation to query a list of asynchronous replication pairs, including replication pair IDs.	pair-xxxx
MaxResults	integer	No	The maximum number of entries to be returned. You can use this parameter together with NextToken. Valid values: 1 to 500. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Set the value to the NextToken value returned in the previous call to the DescribeDiskReplicaPairs operation. Leave this parameter empty the first time you call this operation. When you specify NextToken, the PageSize and PageNumber request parameters do not take effect and the TotalCount response parameter is invalid.	AAAAAdDWBF2****
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100.	10

Response elements

Element	Type	Description	Example
	object	The schema of the response.
Drills	array<object>	The information of disaster recovery drills that were performed on the replication pair.
	object
DrillId	string	The ID of the drill.	drill-xxx
Status	string	The status of the drill. Valid values: execute_failed executed executing clear_failed clearing	executing
DrillDiskId	string	The ID of the drill disk.	d-xxx
DrillDiskStatus	string	The status of the drill disk. Valid values: created deleted creating deleting Note This parameter can also display error code details if your drill disk fails to be created or deleted.	created
StartAt	integer	The beginning time of the drill. The value of this parameter is a timestamp. Unit: seconds.	1690855888
RecoverPoint	integer	The recovery point of the drill. The value of this parameter is a timestamp. Unit: seconds.	1690855931
StatusMessage	string	The error message that was displayed if the drill failed to be executed.	PAIR_SYNCPOINT_NOT_FOUND
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	AAAAAdDWBF2****
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	C46FF5A8-C5F0-4024-8262-B16B6392****

Examples

Success response

JSON format

{
  "Drills": [
    {
      "DrillId": "drill-xxx",
      "Status": "executing",
      "DrillDiskId": "d-xxx",
      "DrillDiskStatus": "created",
      "StartAt": 1690855888,
      "RecoverPoint": 1690855931,
      "StatusMessage": "PAIR_SYNCPOINT_NOT_FOUND"
    }
  ],
  "NextToken": "AAAAAdDWBF2****\n",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B6392****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.