All Products
Search

This Product

    PolarDB:DescribeGlobalDataNetworkList

    Document Center

    PolarDB:DescribeGlobalDataNetworkList

    Last Updated:Sep 24, 2026

    Queries the details of Polarlakebase Global Database Networks (GDNs) across all regions.

    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:DescribeGlobalDataNetworkList

    list

    *All Resource

    *

    		 None None

    Request syntax

    GET  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNumber

    integer

    No

    The page number of the query results.

    1
    PageSize

    integer

    No

    The number of records per page.

    30

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    CD35F3-F3-44CA-AFFF-BAF869******
    TotalRecordCount

    string

    The total number of records.

    1
    PageRecordCount

    string

    The number of records on the current page.

    1
    PageNumber

    string

    The page number.

    1
    Items

    object

    The GDN details.

    Networks

    array<object>

    The list of GDN networks.

    array<object>

    The GDN network details.

    NetworkId

    string

    GDN ID

    gdn-xxx
    NetworkDescription

    string

    The description of the GDN.

    mygdn
    NetworkStatus

    string

    The GDN status. Valid values:

    • Creating: Being created.

    • Running: Running.

    • Syncing: Being synchronized.

    • SyncFinished: Synchronization completed.

    • SyncFailed: Synchronization failed.

    • SyncPartialFailed: Partial synchronization failed.

    • Stopped: Stopped.

    • Maintaining: Under maintenance.

    • Restarting: Being restarted.

    • Locking: Being locked.

    • Locked: Locked.

    • Unlocking: Being unlocked.

    • Deleting: Being deleted.

    • Deleted: Deleted.

    Running
    NetworkTopology

    object

    The GDN network topology.

    Sources

    array<object>

    The list of synchronization sources.

    object

    The synchronization source.

    SourceFileSystemPath

    string

    The source path.

    /
    SourceType

    string

    The source type. Valid values:

    • pfs: Polarlakebase High-performance Edition.

    • pcs: Polarlakebase Cold Storage Edition.

    pcs
    SourceRegion

    string

    The source region.

    cn-wulanchabu
    SourceId

    string

    The source Polarlakebase instance.

    pcs-xxx
    Destinations

    array<object>

    The list of synchronization destinations.

    object

    The synchronization destination.

    DestinationFileSystemPath

    string

    The destination path.

    /
    DestinationRegion

    string

    The destination region.

    cn-beijing
    DestinationType

    string

    The destination type. Valid values:

    • pfs: Polarlakebase High-performance Edition.

    • pcs: Polarlakebase Cold Storage Edition.

    pfs
    DestinationId

    string

    The destination Polarlakebase instance.

    pfs-xxx
    CreateTime

    string

    The creation time of the GDN.

    The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

    2025-03-25T09:37:10Z
    Channels

    array<object>

    The list of synchronization channels.

    object

    The synchronization channel.

    ChannelId

    string

    The synchronization channel ID.

    gdc-xxx
    ChannelStatus

    string

    The synchronization channel status. Valid values:

    • Creating: Being created.

    • Running: Running.

    • Syncing: Being synchronized.

    • SyncFinished: Synchronization completed.

    • SyncFailed: Synchronization failed.

    • SyncPartialFailed: Partial synchronization failed.

    • Stopped: Stopped.

    • Maintaining: Under maintenance.

    • Restarting: Being restarted.

    • Locking: Being locked.

    • Locked: Locked.

    • Unlocking: Being unlocked.

    • Deleting: Being deleted.

    • Deleted: Deleted.

    Syncing
    Progress

    string

    The current synchronization progress.

    Note

    The value is a floating-point percentage with two decimal places.

    11.45%
    FreezeSourceDuringSync

    boolean

    Specifies whether to freeze the source path during the transfer.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "PageNumber": "1",
  "Items": {
    "Networks": [
      {
        "NetworkId": "gdn-xxx",
        "NetworkDescription": "mygdn",
        "NetworkStatus": "Running",
        "NetworkTopology": {
          "Sources": [
            {
              "SourceFileSystemPath": "/",
              "SourceType": "pcs",
              "SourceRegion": "cn-wulanchabu",
              "SourceId": "pcs-xxx"
            }
          ],
          "Destinations": [
            {
              "DestinationFileSystemPath": "/",
              "DestinationRegion": "cn-beijing",
              "DestinationType": "pfs",
              "DestinationId": "pfs-xxx"
            }
          ]
        },
        "CreateTime": "2025-03-25T09:37:10Z",
        "Channels": [
          {
            "ChannelId": "gdc-xxx",
            "ChannelStatus": "Syncing",
            "Progress": "11.45%",
            "FreezeSourceDuringSync": true
          }
        ]
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.