Query the details of a Global Database Network - PolarDB - Alibaba Cloud - PolarDB

Retrieves details for a Global Database Network (GDN).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeGlobalDatabaseNetwork

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
GDNStatus	string	The status of the Global Database Network (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. In this state, you cannot perform any operations on any cluster in the GDN. removing_member: A cluster is being removed from the GDN.	active
Connections	array<object>	The connection details.
	object
ConnectionString	string	The connection string.	abc.polardb.rds.aliyuncs.com
NetType	string	The network type.	Private
Port	string	The port number of the connection string.	3306
DBVersion	string	The database engine version. Only version 8.0 is supported.	8.0
RequestId	string	The request ID.	67F2E75F-AE67-4FB2-821F-A81237EACD15
GDNId	string	The GDN ID.	gdn-bp1fttxsrmv*****
CreateTime	string	The time when the GDN was created.	2020-02-24T11:57:54Z
DBType	string	The database engine type. Only MySQL is supported.	MySQL
GDNDescription	string	The description of the GDN. It must meet the following requirements: It cannot start with `http://` or `https://`. It must start with a letter or a Chinese character. It can contain only letters, Chinese characters, digits, underscores (_), and hyphens (-). It must be 2 to 126 characters in length.	GDN-fortest
GlobalDomainName	string	The global domain name.	[gdnid].gdn.rds.aliyuncs.com
DBClusters	array<object>	The clusters in the GDN.
	array<object>
ReplicaLag	string	The replication lag for cross-region replication between the primary and standby clusters. Unit: seconds.	1
ExpireTime	string	The expiration time of the cluster. Note This parameter is returned only for subscription clusters. An empty string is returned for pay-as-you-go clusters.	2020-11-14T16:00:00Z
Expired	string	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.	false
DBNodeClass	string	The node type.	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. Only MySQL is supported.	MySQL
RegionId	string	The region ID of the cluster.	cn-hangzhou
DBVersion	string	The database engine version. Only version 8.0 is supported.	8.0
DBClusterId	string	The cluster ID.	pc-wz9fb5nn44u1d****
DBClusterStatus	string	The status of the cluster. For more information, see Cluster statuses.	Running
StorageUsed	string	The amount of storage space used. Unit: bytes.	3012558848
DBClusterDescription	string	The description of the cluster.	test
Category	string	The edition of the cluster. Valid values: `Normal`: Cluster Edition `Basic`: Single-node Edition `Archive`: X-Engine Edition `NormalMultimaster`: Multi-master Cluster Edition `SENormal`: Standard Edition Note Single-node Edition is not supported for PolarDB for PostgreSQL clusters that run PostgreSQL 11. Standard Edition is supported for PolarDB for MySQL clusters that run MySQL 8.0 or 5.7 and for PolarDB for PostgreSQL clusters that run PostgreSQL 14. X-Engine Edition and Multi-master Cluster Edition are supported only for PolarDB for MySQL clusters that run MySQL 8.0.	Normal
Role	string	The role of the cluster in the GDN. Valid values: primary: the primary cluster standby: a standby cluster Note A GDN consists of one primary cluster and up to four standby clusters.	primary
ServerlessType	string	The type of the Serverless cluster. The value is fixed as `AgileServerless`. Note This parameter is returned only for Serverless clusters.	AgileServerless
DBNodes	array<object>	The details of the nodes in the cluster.
	object
DBNodeClass	string	The node type.	polar.mysql.x4.large
ZoneId	string	The zone ID.	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 being restarted. ClassChanging: The node type is being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified. MinorVersionUpgrading: The minor version is being upgraded. Maintaining: The cluster is being maintained. Switching: A failover is in progress.	Running
FailoverPriority	integer	The failover priority. In the event of a failover, the system promotes a read-only node to the primary node. A larger value indicates a higher priority. Each read-only node is assigned a failover priority. Valid values: 1 to 15.	1
MaxConnections	integer	The maximum number of concurrent connections.	8000
MaxIOPS	integer	The maximum I/O operations per second (IOPS).	32000
DBNodeId	string	The node ID.	pi-****************
DBClusterId	string	The cluster ID.	pc-bp1s826a1up******
ResourceGroupId	string	The resource group ID.	rg-************
Labels	object	The labels of the GDN.
GDNVersion	string	The version of the GDN.	2.0

Examples

Success response

JSON format

{
  "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",
  "GlobalDomainName": "[gdnid].gdn.rds.aliyuncs.com",
  "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",
      "Category": "Normal",
      "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-************",
  "Labels": {
    "GDNVersion": "2.0"
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.