Views the details about a Global Database Network (GDN).

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 DescribeGlobalDatabaseNetwork

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

RegionId String No cn-qingdao

The region ID of the cluster.

GDNId String Yes gdn-bp1fttxsrmv*****

The ID of the GDN.

ResourceGroupId String No rg-************

The ID of the resource group.

Response parameters

Parameter Type Example Description
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.
Connections Array of Connection

The information about the connection to the cluster.

ConnectionString String abc.polardb.rds.aliyuncs.com

The endpoint of the cluster.

NetType String Private

The network type of the cluster.

Port String 3306

The port number of the cluster endpoint.

DBVersion String 8.0

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

RequestId String 67F2E75F-AE67-4FB2-821F-A81237EACD15

The ID of the request.

GDNId String gdn-bp1fttxsrmv*****

The ID of the GDN.

CreateTime String 2020-02-24T11:57:54Z

The time at which the GDN was created.

DBType String MySQL

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

GDNDescription String GDN-fortest
The description of the GDN. The description must meet the following requirements:
  • It cannot start with http:// or https://.
  • It must start with a letter.
  • It can contain letters, digits, underscores (_), and hyphens (-).
  • It must be 2 to 126 characters in length.
DBClusters Array of DBCluster

The clusters that are included in the GDN.
ReplicaLag String 1

The latency of cross-region data replication between the primary cluster and secondary clusters. Unit: seconds.

ExpireTime String 2020-11-14T16:00:00Z

The time at which the cluster expires.

Note Expiration time is returned only for clusters that use the subscription billing method. An empty string is returned for clusters that use the pay-as-you-go billing method.
Expired String false

Indicates whether the cluster has expired. Valid values:

  • true: The cluster has expired.
  • false: The cluster has not expired.
Note This parameter is returned only for clusters that use the subscription billing method.
DBNodeClass String polar.mysql.x4.large

The instance type of the node.

PayType String Prepaid

The billing method of the cluster. Valid values:

  • Postpaid: the pay-as-you-go billing method
  • Prepaid: the subscription billing method
DBType String MySQL

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

RegionId String cn-hangzhou

The region ID of the cluster.

DBVersion String 8.0

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

DBClusterId String pc-wz9fb5nn44u1d****

The ID of the cluster in the GDN.

DBClusterStatus String Running

The status of the cluster in the GDN. For more information, see the Cluster status table.

StorageUsed String 3012558848

The storage space consumed by the cluster. Unit: bytes.

DBClusterDescription String test

The description of the 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.
DBNodes Array of DBNode

The information about the node.

DBNodeClass String polar.mysql.x4.large

The instance type of the node.

ZoneId String cn-hangzhou-i

The ID of the zone.

CreationTime String 2020-03-23T21:35:43Z

The time when the node was created.

DBNodeRole String Reader

The role of the node. Valid values:

  • Writer: The node is the primary node.
  • Reader: The node is a read-only node.
DBNodeStatus String Running

The status of the node. Valid values:

  • Creating: The cluster is being created.
  • Running: The cluster is running.
  • Deleting: The cluster is being deleted.
  • Rebooting: The cluster is restarting.
  • DBNodeCreating: The node is being added.
  • DBNodeDeleting: The node is being deleted.
  • ClassChanging: The instance type of the node is being changed.
  • NetAddressCreating: The network connection is being created.
  • NetAddressDeleting: The network connection is being deleted.
  • NetAddressModifying: The network connection is being modified.
  • MinorVersionUpgrading: The minor version is being updated.
  • Maintaining: The cluster is being maintained.
  • Switching: A failover is being performed.
FailoverPriority Integer 1

The failover priority. Each node is assigned a failover priority. If a failover occurs, a node can be selected as a primary node. The priority determines the probability at which a node is selected as a primary node. A larger value indicates a higher priority. Valid values: 1 to 15.

MaxConnections Integer 8000

The maximum number of concurrent connections to the cluster.

MaxIOPS Integer 32000

The maximum number of IOPS.

DBNodeId String pi-****************

The ID of the node.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeGlobalDatabaseNetwork
&GDNId=gdn-bp1fttxsrmv*****
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeGlobalDatabaseNetworkResponse>
    <GDNStatus>active</GDNStatus>
    <Connections>
        <ConnectionString>abc.polardb.rds.aliyuncs.com</ConnectionString>
        <NetType>Private</NetType>
        <Port>3306</Port>
    </Connections>
    <DBVersion>8.0</DBVersion>
    <RequestId>67F2E75F-AE67-4FB2-821F-A81237EACD15</RequestId>
    <GDNId>gdn-bp1fttxsrmv*****</GDNId>
    <CreateTime>2020-02-24T11:57:54Z</CreateTime>
    <DBType>MySQL</DBType>
    <GDNDescription>GDN-fortest</GDNDescription>
    <DBClusters>
        <ReplicaLag>1</ReplicaLag>
        <ExpireTime>2020-11-14T16:00:00Z</ExpireTime>
        <Expired>false</Expired>
        <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
        <PayType>Prepaid</PayType>
        <DBType>MySQL</DBType>
        <RegionId>cn-hangzhou</RegionId>
        <DBVersion>8.0</DBVersion>
        <DBClusterId>pc-wz9fb5nn44u1d****</DBClusterId>
        <DBClusterStatus>Running</DBClusterStatus>
        <StorageUsed>3012558848</StorageUsed>
        <DBClusterDescription>test</DBClusterDescription>
        <Role>primary</Role>
        <DBNodes>
            <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <CreationTime>2020-03-23T21:35:43Z</CreationTime>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeStatus>Running</DBNodeStatus>
            <FailoverPriority>1</FailoverPriority>
            <MaxConnections>8000</MaxConnections>
            <MaxIOPS>32000</MaxIOPS>
            <DBNodeId>pi-****************</DBNodeId>
        </DBNodes>
    </DBClusters>
</DescribeGlobalDatabaseNetworkResponse>

JSON format 

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

{
  "GDNStatus" : "active",
  "Connections" : [ {
    "ConnectionString" : "abc.polardb.rds.aliyuncs.com",
    "NetType" : "Private",
    "Port" : "3306"
  } ],
  "DBVersion" : "8.0",
  "RequestId" : "67F2E75F-AE67-4FB2-821F-A81237EACD15",
  "GDNId" : "gdn-bp1fttxsrmv*****",
  "CreateTime" : "2020-02-24T11:57:54Z",
  "DBType" : "MySQL",
  "GDNDescription" : "GDN-fortest",
  "DBClusters" : [ {
    "ReplicaLag" : "1",
    "ExpireTime" : "2020-11-14T16:00:00Z",
    "Expired" : "false",
    "DBNodeClass" : "polar.mysql.x4.large",
    "PayType" : "Prepaid",
    "DBType" : "MySQL",
    "RegionId" : "cn-hangzhou",
    "DBVersion" : "8.0",
    "DBClusterId" : "pc-wz9fb5nn44u1d****",
    "DBClusterStatus" : "Running",
    "StorageUsed" : "3012558848",
    "DBClusterDescription" : "test",
    "Role" : "primary",
    "DBNodes" : [ {
      "DBNodeClass" : "polar.mysql.x4.large",
      "ZoneId" : "cn-hangzhou-i",
      "CreationTime" : "2020-03-23T21:35:43Z",
      "DBNodeRole" : "Reader",
      "DBNodeStatus" : "Running",
      "FailoverPriority" : 1,
      "MaxConnections" : 8000,
      "MaxIOPS" : 32000,
      "DBNodeId" : "pi-****************"
    } ]
  } ]
}

Error codes

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