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.

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 a GDN is locked, you cannot perform operations on a cluster in the GDN.
  • removing_member: The secondary cluster is being removed from the GDN.
Connections Array of Connection

Details about the connection of 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.

DBClusters Array of DBCluster

The clusters that are included in the GDN. Up to 16 clusters are allowed.

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 This parameter is returned only for subscription clusters that use the Prepaid billing method. An empty value is returned for pay-as-you-go clusters that use the Postpaid 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 subscription clusters that use the Prepaid billing method.
DBNodeClass String polar.mysql.x4.large

The specifications of the node.

PayType String Prepaid

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
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 used storage space. Unit: bytes.

DBClusterDescription String test

The description of the cluster.

Role String primary

The role of the cluster. Valid values:

  • Primary: primary cluster
  • standby: secondary cluster
Note A GDN consists of one primary cluster and up to four secondary clusters.

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>
    </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"
  } ]
}

Error codes

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