All Products
Search
Document Center

PolarDB:DescribeGlobalDatabaseNetworks

Last Updated:Mar 01, 2024

Queries the information about all Global Database Networks (GDNs) that belong to an account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeGlobalDatabaseNetworksREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FilterRegionstringNo

Specify the region in which you want to query GDNs. You can create secondary clusters for the GDNs.

cn-beijing
DBClusterIdstringNo

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query information about all clusters that are deployed in a specified region, such as the cluster ID.
pc-**************
PageSizeintegerNo

The number of entries per page. Default value: 30. Valid values:

  • 30
  • 50
  • 100
30
PageNumberintegerNo

The page number. Default value: 1. The value must be an integer that is greater than 0.

1
GDNDescriptionstringNo

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.
test
GDNIdstringNo

The ID of the GDN.

gdn-****************
ResourceGroupIdstringNo

The ID of the resource group.

rg-************

Response parameters

ParameterTypeDescriptionExample
object
TotalRecordCountinteger

The total number of returned entries.

1
PageRecordCountinteger

The number of records on the current page.

30
RequestIdstring

The ID of the request.

69A85BAF-1089-4CDF-A82F-0A140F******
PageNumberinteger

The page number.

1
Itemsobject []

Details about the GDNs.

DBVersionstring

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

8.0
GDNIdstring

The ID of the GDN.

gdn-****************
CreateTimestring

The time when the GDN was created. The time is in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2020-03-23T05:46:54Z
GDNStatusstring

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
DBClustersobject []

Details about clusters in the GDN.

DBClusterIdstring

The ID of the cluster.

pc-****************
Rolestring

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. For more information, see GDN .
primary
RegionIdstring

The region ID of the cluster.

cn-hangzhou
DBTypestring

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

MySQL
GDNDescriptionstring

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.
test

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******",
  "PageNumber": 1,
  "Items": [
    {
      "DBVersion": "8.0",
      "GDNId": "gdn-****************",
      "CreateTime": "2020-03-23T05:46:54Z",
      "GDNStatus": "active",
      "DBClusters": [
        {
          "DBClusterId": "pc-****************",
          "Role": "primary",
          "RegionId": "cn-hangzhou"
        }
      ],
      "DBType": "MySQL",
      "GDNDescription": "test"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.The specified PageSize parameter is invalid.
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.The specified PageNumber parameter is invalid.
404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
2023-08-15The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
2022-07-26The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: GDNDescription
    delete Input Parameters: Description
2022-06-30The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Description
    Added Input Parameters: GDNId