DescribeDiskReplicaGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries information about one or more replication pair-consistent groups in a specified region.

Operation description

Description

To perform a paged query, specify the MaxResults and NextToken parameters.

When you perform a paged query for the first page, set MaxResults to limit the number of returned items. The NextToken in the response is the token for querying subsequent pages. When you query a subsequent page, set the NextToken parameter to the NextToken value obtained from the previous response.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the replication pair-consistent group.	cn-beijing
MaxResults	integer	No	The maximum number of entries to return for a single query. You can use this parameter with NextToken. Valid values: 1 to 500. Default value: 10.	10
NextToken	string	No	The query token. Set this parameter to the NextToken value returned from the previous call to this operation. You do not need to set this parameter for the first call. If you set NextToken, the PageSize and PageNumber parameters are ignored, and the TotalCount in the response is invalid.	AAAAAdDWBF2****
GroupIds	string	No	The IDs of the replication pair-consistent groups. You can specify one or more replication pair-consistent group IDs. Separate multiple IDs with commas (,). The default value is empty, which means all replication pair-consistent groups in the current region are queried. You can specify up to 100 replication group IDs.	AAAAAdDWBF2****
Site	string	No	Queries and returns the records of a specified site. This parameter is mainly used for replication pairs that are deployed in different zones. If you do not specify this parameter, the records and status information of replication pairs at the production site are returned. If you specify this parameter, only the records and status information of replication pairs at the specified site are returned. Valid values: production: The production site. backup: The disaster recovery site.	production
PageNumber	integer	No	The page number for paged queries.	5
PageSize	integer	No	The number of entries to return on each page for paged queries. Valid values: 1 to 100.	10
ResourceGroupId	string	No	The ID of the resource group to which the replication pair-consistent group belongs.	rg-aekz*****
Name	string	No	The name of the replication group. Fuzzy match is supported.	pg-name***
Tag	array<object>	No	The list of tags. The list can contain up to 20 tags.
	object	No	The tag.
Value	string	No	The value of the tag of the replication pair-consistent group.	tag-value
Key	string	No	The key of the tag of the replication pair-consistent group.	tag-key

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextToken	string	The query token returned in this call.	AAAAAdDWBF2****
ReplicaGroups	array<object>	A collection of replication pair-consistent group information.
	object
GroupName	string	The name of the replication pair-consistent group.	myreplicagrouptest
Site	string	The source of the site information of the replication pair and the replication pair-consistent group. Valid values: production: The production site. backup: The disaster recovery site.	production
Description	string	The description of the replication pair-consistent group.	This is description.
StandbyZone	string	The initial destination zone of the replication group.	cn-shanghai-e
ResourceGroupId	string	The ID of the resource group to which the replication group belongs.	rg-aek2a*******
LastRecoverPoint	integer	The time when the last asynchronous replication was completed for the replication pair-consistent group. This parameter is a UNIX timestamp. Unit: seconds.	1637835114
ReplicaGroupId	string	The ID of the replication pair-consistent group.	pg-myreplica****
RPO	integer	The RPO of the replication pair-consistent group. Unit: seconds.	180
SourceRegionId	string	The region ID of the production site.	cn-beijing
DestinationRegionId	string	The region ID of the disaster recovery site.	cn-shanghai
Bandwidth	integer	The bandwidth. Unit: Kbit/s. This parameter is not yet available. The return value is preset by the system.	0
PrimaryZone	string	The initial source zone of the replication group.	cn-beijing-h
SourceZoneId	string	The zone ID of the production site.	cn-beijing-f
Tags	array<object>	The tags of the replication group.
	object
TagKey	string	The key of the tag of the replication group.	testKey
TagValue	string	The value of the tag of the replication group.	testValue
Status	string	The status of the replication pair-consistent group. Valid values: invalid: The replication pair-consistent group is invalid. This status indicates that a replication pair in the group is abnormal. creating: The replication pair-consistent group is being created. created: The replication pair-consistent group is created. create_failed: The replication pair-consistent group failed to be created. manual_syncing: The replication pair-consistent group is in a one-time synchronization. The group is also in this state during the first one-time synchronization. syncing: The replication pair-consistent group is synchronizing data. When data is asynchronously replicated from the primary disk to the secondary disk for a subsequent time, the group is in this state. normal: Normal. When data replication is complete in the current asynchronous replication cycle, the group is in this state. stopping: The replication pair-consistent group is being stopped. stopped: The replication pair-consistent group is stopped. stop_failed: The replication pair-consistent group failed to be stopped. failovering: A failover is being performed. failovered: The failover is complete. failover_failed: The failover failed. reprotecting: A reverse replication is being performed. reprotect_failed: The reverse replication failed. deleting: The replication pair-consistent group is being deleted. delete_failed: The replication pair-consistent group failed to be deleted. deleted: The replication pair-consistent group is deleted.	created
PairNumber	integer	The number of replication pairs in the replication pair-consistent group.	2
PrimaryRegion	string	The initial source region of the replication group.	cn-beijing
PairIds	array	The list of replication pair IDs in the replication pair-consistent group.
	string	The list of replication pair IDs in the replication pair-consistent group.	pair-cn-dsa**,pair-cn-asd**
EnableRtc	boolean	Indicates whether replication time control is enabled.	true
DestinationZoneId	string	The zone ID of the disaster recovery site.	cn-shanghai-e
StandbyRegion	string	The initial destination region of the replication group.	cn-shanghai
PageNumber	integer	The page number for paged queries.	1
PageSize	integer	The number of entries returned per page for paged queries.	10
TotalCount	integer	The total number of entries returned for the paged query.	60

Examples

Success response

JSON format

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
  "NextToken": "AAAAAdDWBF2****",
  "ReplicaGroups": [
    {
      "GroupName": "myreplicagrouptest",
      "Site": "production",
      "Description": "This is description.",
      "StandbyZone": "cn-shanghai-e",
      "ResourceGroupId": "rg-aek2a*******",
      "LastRecoverPoint": 1637835114,
      "ReplicaGroupId": "pg-myreplica****",
      "RPO": 180,
      "SourceRegionId": "cn-beijing",
      "DestinationRegionId": "cn-shanghai",
      "Bandwidth": 0,
      "PrimaryZone": "cn-beijing-h",
      "SourceZoneId": "cn-beijing-f",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "Status": "created",
      "PairNumber": 2,
      "PrimaryRegion": "cn-beijing",
      "PairIds": [
        "pair-cn-dsa****,pair-cn-asd****"
      ],
      "EnableRtc": true,
      "DestinationZoneId": "cn-shanghai-e",
      "StandbyRegion": "cn-shanghai\n"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 60
}

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	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.