Views the details of all the global database networks (GDNs) for an account.
A GDN consists of PolarDB clusters that are distributed across regions around the globe. Data is synchronized across all the clusters in each GDN. If your services are deployed in multiple regions, GDNs allow the applications to access databases at low latency and with a high stability.
Debugging
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 ID of the region. Note you can call the DescribeRegions operation to query the region information about all the clusters for a specified
account.
|
DBClusterId | String | No | pc-************** |
The ID of the cluster. Note You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specified
region, such as the cluster ID.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array of GlobalDatabaseNetwork |
The GDN details. |
|
CreateTime | String | 2020-03-23T05:46:54Z |
The time when the GDN was created. The time is in the |
DBClusters | Array of DBCluster |
The details of each cluster in the GDN. |
|
DBClusterId | String | pc-**************** |
The ID of the cluster. |
RegionId | String | cn-hangzhou |
The ID of the region. |
Role | String | primary |
The role of the cluster. Valid values:
Note A GDN consists of one primary cluster and a maximum of four secondary clusters. For
more information, see GDN.
|
DBType | String | MySQL |
The type of the database engine. Only the MySQL type is supported. |
DBVersion | String | 8.0 |
The version number of the database engine. Only the 8.0 version is supported. |
GDNDescription | String | test |
The name of the GDN. |
GDNId | String | gdn-**************** |
The ID of the GDN. |
GDNStatus | String | active |
The status of the GDN. Valid values:
|
PageNumber | Integer | 1 |
The number of pages returned. |
PageRecordCount | Integer | 30 |
The number of entries on the current page. |
RequestId | String | 69A85BAF-1089-4CDF-A82F-0A140F****** |
The ID of the request. |
TotalRecordCount | Integer | 1 |
The total number of entries. |
Examples
Sample requests
http(s)://polardb.aliyuncs.com/? Action=DescribeGlobalDatabaseNetworks
&<Common request parameters>
Sample success responses
XML
format
<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
{
"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.