All Products
Search
Document Center

Elastic Compute Service:DescribePairDrills

Last Updated:Sep 25, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ebs:DescribePairDrillslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
DrillIdstringNo

The ID of the drill.

drill-xxxx
PairIdstringYes

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
MaxResultslongNo

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
NextTokenstringNo

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****
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

Drillsarray<object>

The information of disaster recovery drills that were performed on the replication pair.

Drillobject
DrillIdstring

The ID of the drill.

drill-xxx
Statusstring

The status of the drill. Valid values:

  • execute_failed
  • executed
  • executing
  • clear_failed
  • clearing
executing
DrillDiskIdstring

The ID of the drill disk.

d-xxx
DrillDiskStatusstring

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
StartAtlong

The beginning time of the drill. The value of this parameter is a timestamp. Unit: seconds.

1690855888
RecoverPointlong

The recovery point of the drill. The value of this parameter is a timestamp. Unit: seconds.

1690855931
StatusMessagestring

The error message that was displayed if the drill failed to be executed.

PAIR_SYNCPOINT_NOT_FOUND
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

AAAAAdDWBF2****
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountlong

The total number of entries returned.

1
RequestIdstring

The request ID.

C46FF5A8-C5F0-4024-8262-B16B6392****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameterThe parameter %s is invalid.The specified parameter value is invalid.
400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.-
400InvalidParameter.FormatSpecified parameter format is not valid.english description
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403Forbidden.ActionUser 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.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.-
403LastTokenProcessingThe last token request is processing.The value of clientToken is used in another request that is being processed. Try again later.
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
403OperationDeniedThe operation is not allowed.The operation is not supported.
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.