DescribeGlobalDatabaseNetwork - PolarDB - Alibaba Cloud Documentation Center

Queries the information 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GDNId	string	Yes	The ID of the GDN.	gdn-bp1fttxsrmv*****
ResourceGroupId	string	No	The ID of the resource group.	rg-************

Response parameters

Parameter	Type	Description	Example
	object
GDNStatus	string	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.	active
Connections	array<object>	The information about the connection to the cluster.
	object
ConnectionString	string	The endpoint URL of the database service.	abc.polardb.rds.aliyuncs.com
NetType	string	The network type for the database connection.	Private
Port	string	The port number for the database connection.	3306
DBVersion	string	The version of the database engine. Only version 8.0 is supported.	8.0
RequestId	string	The ID of the request.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	The ID of the GDN.	gdn-bp1fttxsrmv*****
CreateTime	string	The time at which the GDN was created.	2020-02-24T11:57:54Z
DBType	string	The type of the database engine. Only MySQL is supported.	MySQL
GDNDescription	string	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.	GDN-fortest
DBClusters	array<object>	The clusters in the GDN.
	object
ReplicaLag	string	The cross-region data replication latency between the primary cluster and secondary clusters. Unit: seconds.	1
ExpireTime	string	The expiration time of the cluster. Note A specific value is returned only for subscription (Prepaid) clusters. No value is returned for pay-as-you-go (Postpaid) clusters.	2020-11-14T16:00:00Z
Expired	string	Indicates whether the cluster has expired. Valid values: true (default) false Note This parameter is returned only for subscription (Prepaid) clusters.	false
DBNodeClass	string	The node specifications of the cluster.	polar.mysql.x4.large
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Prepaid
DBType	string	The database engine type of the cluster. Only MySQL is supported.	MySQL
RegionId	string	The region ID of the cluster.	cn-hangzhou
DBVersion	string	The version of the database engine. Only version 8.0 is supported.	8.0
DBClusterId	string	The ID of the cluster.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	The status of the cluster. For more information, see Cluster status table.	Running
StorageUsed	string	The storage usage of the cluster. Unit: bytes.	3012558848
DBClusterDescription	string	The description of the cluster.	test
Role	string	The role of the cluster. Valid values: Primary: the primary cluster standby: a secondary cluster Note A GDN consists of one primary cluster and up to four secondary clusters.	primary
ServerlessType	string	Indicates whether the cluster is a serverless cluster. The value is fixed at AgileServerless. Note This parameter is returned only for serverless clusters.	AgileServerless
DBNodes	array<object>	The nodes of the cluster.
	object
DBNodeClass	string	The specifications of the node.	polar.mysql.x4.large
ZoneId	string	The zone ID of the node.	cn-hangzhou-i
CreationTime	string	The time when the node was created.	2020-03-23T21:35:43Z
DBNodeRole	string	The role of the node. Valid values: Writer: the primary node Reader: a read-only node	Reader
DBNodeStatus	string	The status of the node. Valid values: Creating: The node is being created. Running: The node is running. Deleting: The node is being deleted. Rebooting: The node is restarting. ClassChanging: The specifications of the node are 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 of the node is being updated. Maintaining: The node is being maintained. Switching: A failover is being performed.	Running
FailoverPriority	integer	The failover priority. Each node is assigned a failover priority. The failover priority determines which node is selected as the primary node when a failover occurs. A larger value indicates a higher priority. Valid values: 1 to 15.	1
MaxConnections	integer	The maximum number of concurrent connections.	8000
MaxIOPS	integer	The maximum input/output operations per second (IOPS).	32000
DBNodeId	string	The node ID.	pi-****************
DBClusterId	string	The ID of the cluster.	pc-bp1s826a1up******
ResourceGroupId	string	The ID of the resource group.	rg-************

Examples

Sample success responses

JSONformat

{
  "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",
      "ServerlessType": "AgileServerless",
      "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-****************"
        }
      ]
    }
  ],
  "DBClusterId": "pc-bp1s826a1up******",
  "ResourceGroupId": "rg-************"
}

Error codes

HTTP status code	Error code	Error message	Description
400	GDN.NotFound	Failed to found GdnInstance by name:%s	Failed to find cluster %s by GDN name.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-24	The Error code has changed. The response structure of the API has changed	View Change Details
2021-06-21	Add Operation	View Change Details