Queries the details of all global database networks (GDNs) for an 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 No DescribeGlobalDatabaseNetworks

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

RegionId String No cn-hangzhou

The region ID of the cluster.

Note You can call the DescribeRegions operation to query the region information of all clusters within a specified account.
DBClusterId String No pc-**************

The ID of the PolarDB cluster.

Note You can call the DescribeDBClusters operation to query information of all clusters that are deployed in a specified region, such as the cluster ID.
PageSize Integer No 30

The number of entries to return on each page.

PageNumber Integer No 1

The number of the page to return.

Response parameters

Parameter Type Example Description
TotalRecordCount Integer 1

The total number of records that were returned.

PageRecordCount Integer 30

The number of records on the current page.

RequestId String 69A85BAF-1089-4CDF-A82F-0A140F******

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

Items Array of GlobalDatabaseNetwork

The GDN details.

DBVersion String 8.0

The version number of the database engine. Only the 8.0 version is supported.

GDNId String gdn-****************

The ID of the GDN.

CreateTime String 2020-03-23T05:46:54Z

The time when the GDN was created. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

GDNStatus String active

The status of the GDN. Valid values:

  • Creating: The GDN is being created.
  • active: The GDN is running.
  • Deleting: The GDN is being deleted.
  • locked: The GDN is locked. If the GDN is locked, you cannot perform operations on clusters in the GDN.
  • removing_member: The secondary cluster is being removed from the GDN.
DBClusters Array of DBCluster

The details of each cluster in the GDN.

DBClusterId String pc-****************

The ID of the PolarDB cluster.

Role String primary

The role of the cluster. Valid values:

  • Primary: the primary cluster
  • standby: the secondary cluster
Note A GDN consists of one primary cluster and up to four secondary clusters. For more information, see GDN.
RegionId String cn-hangzhou

The region ID of the cluster.

DBType String MySQL

The type of the database engine. Only MySQL is supported.

GDNDescription String test

The description of the GDN.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeGlobalDatabaseNetworks
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeGlobalDatabaseNetworksResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>30</PageRecordCount>
<RequestId>69A85BAF-1089-4CDF-A82F-0A140F******</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <GDNStatus>active</GDNStatus>
    <DBVersion>8.0</DBVersion>
    <GDNId>gdn-****************</GDNId>
    <CreateTime>2020-03-23T05:46:54Z</CreateTime>
    <GDNDescription>test</GDNDescription>
    <DBType>MySQL</DBType>
    <DBClusters>
        <Role>primary</Role>
        <DBClusterId>pc-****************</DBClusterId>
        <RegionId>cn-hangzhou</RegionId>
    </DBClusters>
    <DBClusters>
        <Role>standby</Role>
        <DBClusterId>pc-****************</DBClusterId>
        <RegionId>cn-shanghai</RegionId>
    </DBClusters>
</Items>
</DescribeGlobalDatabaseNetworksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 30,
  "RequestId" : "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber" : 1,
  "Items" : [ {
    "GDNStatus" : "active",
    "DBVersion" : "8.0",
    "GDNId" : "gdn-****************",
    "CreateTime" : "2020-03-23T05:46:54Z",
    "GDNDescription" : "test",
    "DBType" : "MySQL",
    "DBClusters" : [ {
      "Role" : "primary",
      "DBClusterId" : "pc-****************",
      "RegionId" : "cn-hangzhou"
    }, {
      "Role" : "standby",
      "DBClusterId" : "pc-****************",
      "RegionId" : "cn-shanghai"
    } ]
  } ]
}

Error codes

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