You can call the DescribeGadInstances operation to query the details about the ApsaraDB RDS global active database clusters that are created within your Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGadInstances

The operation that you want to perform. Set the value to DescribeGadInstances.

GadInstanceName String No gad-rm-bp1npi2j8********

The ID of the single global active database cluster that you want to query.

  • If you leave this parameter empty, this operation returns the details about all global active database clusters that are created within your Alibaba Cloud account.
  • If you specify this parameter, this operation returns the details about the single global active database cluster that you specify.
Note You can call this operation with this parameter left empty to query the details about all global active database clusters that are created within your Alibaba Cloud account. Then, you can call this operation again with this parameter specified to query the details about the single global active database cluster that you specify.
RegionId String No cn-hangzhou

The ID of the region where the global active database clusters that you want to query reside. You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
GadInstances Array of GadInstances

An array that consists of the details about the global active database clusters that are returned.

CreationTime String 2021-10-21T02:57:08Z

The time when the global active database cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Description String GadTest

The name of the global active database cluster.

GadInstanceMembers Array of GadInstanceMembers

An array that consists of the details about the nodes in the global active database cluster.

DBInstanceID String rm-bp1npi2j8********

The ID of the node.

DtsInstance String {\"dtsInstanceId\":\"dtsm9t107c********\",\"dtsRequestId\":\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\"}

A JSON array that consists of the details about the Data Transmission Service (DTS) synchronization task.

Note Each unit node uses DTS to synchronize data with the central node. This parameter contains the ID of the DTS synchronization link and the ID of the DTS synchronization request.
Engine String mysql

The database engine that is run by the node.

Note The value of this parameter is fixed as mysql.
EngineVersion String 8.0

The database engine version that is run by the node.

RegionId String cn-hangzhou

The ID of the region where the node resides.

Role String CENTRAL

The type of the node. Valid values:

  • CENTRAL: The node is the central node. Each global active database cluster has only one central node. All unit nodes synchronize data from the central node.
  • UNIT: The node is a unit node. Each global active database cluster can have up to 10 unit nodes. All unit nodes synchronize data from the central node.
Status String activation

The status of the node. Valid values:

  • activation: The node is running.
  • creating: The node is being created.
GadInstanceName String gad-rm-bp1npi2j8********

The ID of the global active database cluster.

ModificationTime String 2021-10-21T03:01:20Z

The time when the most recent modification was made to the global active database cluster. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Service String mysql

The database engine that is run by the global active database cluster.

Note The value of this parameter is fixed as mysql.
Status String activation

The status of the global active database cluster. Valid values:

  • activation: The global active database cluster is running.
  • creating: The global active database cluster is being created.
  • replica_adding: Nodes are being added to the global active database cluster.
RequestId String 76AF0609-4195-5DFC-BC78-3AD76FF872BB

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeGadInstances
&GadInstanceName=gad-rm-bp1npi2j8********
&<Common request parameters>

Sample success responses

XML format

<DescribeGadInstancesResponse>
  <RequestId>76AF0609-4195-5DFC-BC78-3AD76FF872BB</RequestId>
  <GadInstances>
        <Status>activation</Status>
        <Description>test gad</Description>
        <GadInstanceName>gad-rm-bp1npi2j8********</GadInstanceName>
        <CreationTime>2021-10-21T02:57:08Z</CreationTime>
        <Service>mysql</Service>
        <ModificationTime>2021-10-21T03:01:20Z</ModificationTime>
        <GadInstanceMembers>
              <Role>CENTRAL</Role>
              <Status>activation</Status>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceID>rm-bp1npi2j8********</DBInstanceID>
              <RegionId>cn-hangzhou</RegionId>
              <Engine>mysql</Engine>
        </GadInstanceMembers>
        <GadInstanceMembers>
              <Role>UNIT</Role>
              <Status>activation</Status>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceID>rm-bp10iyemc********</DBInstanceID>
              <RegionId>cn-hangzhou</RegionId>
              <DtsInstance>{"dtsInstanceId":"dtsoai1091********","dtsRequestId":"8E762933-4945-5FD0-B73E-B34DE97711D7"}</DtsInstance>
              <Engine>mysql</Engine>
        </GadInstanceMembers>
        <GadInstanceMembers>
              <Role>UNIT</Role>
              <Status>activation</Status>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceID>rm-bp12srz4r********</DBInstanceID>
              <RegionId>cn-hangzhou</RegionId>
              <DtsInstance>{"dtsInstanceId":"dtsqu710mn********","dtsRequestId":"38500624-625E-503F-B3F7-D958BD092814"}</DtsInstance>
              <Engine>mysql</Engine>
        </GadInstanceMembers>
        <GadInstanceMembers>
              <Role>UNIT</Role>
              <Status>activation</Status>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceID>rm-bp13f617l********</DBInstanceID>
              <RegionId>cn-hangzhou</RegionId>
              <DtsInstance>{"dtsInstanceId":"dtsm9t107c********","dtsRequestId":"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C"}</DtsInstance>
              <Engine>mysql</Engine>
        </GadInstanceMembers>
  </GadInstances>
</DescribeGadInstancesResponse>

JSON format

{
    "RequestId": "76AF0609-4195-5DFC-BC78-3AD76FF872BB",
    "GadInstances": [
        {
            "Status": "activation",
            "Description": "test gad",
            "GadInstanceName": "gad-rm-bp1npi2j8********",
            "CreationTime": "2021-10-21T02:57:08Z",
            "Service": "mysql",
            "ModificationTime": "2021-10-21T03:01:20Z",
            "GadInstanceMembers": [
                {
                    "Role": "CENTRAL",
                    "Status": "activation",
                    "EngineVersion": "8.0",
                    "DBInstanceID": "rm-bp1npi2j8********",
                    "RegionId": "cn-hangzhou",
                    "Engine": "mysql"
                },
                {
                    "Role": "UNIT",
                    "Status": "activation",
                    "EngineVersion": "8.0",
                    "DBInstanceID": "rm-bp10iyemc********",
                    "RegionId": "cn-hangzhou",
                    "DtsInstance": "{\"dtsInstanceId\":\"dtsoai1091********\",\"dtsRequestId\":\"8E762933-4945-5FD0-B73E-B34DE97711D7\"}",
                    "Engine": "mysql"
                },
                {
                    "Role": "UNIT",
                    "Status": "activation",
                    "EngineVersion": "8.0",
                    "DBInstanceID": "rm-bp12srz4r********",
                    "RegionId": "cn-hangzhou",
                    "DtsInstance": "{\"dtsInstanceId\":\"dtsqu710mn********\",\"dtsRequestId\":\"38500624-625E-503F-B3F7-D958BD092814\"}",
                    "Engine": "mysql"
                },
                {
                    "Role": "UNIT",
                    "Status": "activation",
                    "EngineVersion": "8.0",
                    "DBInstanceID": "rm-bp13f617l********",
                    "RegionId": "cn-hangzhou",
                    "DtsInstance": "{\"dtsInstanceId\":\"dtsm9t107c********\",\"dtsRequestId\":\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\"}",
                    "Engine": "mysql"
                }
            ]
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.