DescribeGlobalDataNetworkList - - Alibaba Cloud Documentation Center

Queries the details of PolarFileSystem (PolarFS) Global Data Networks (GDNs) across gemini 建议 across，更地道 inall regions in your account.

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

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the query result.	1
PageSize	integer	No	The number of records per page.	30

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.The request ID	CD35F3-F3-44CA-AFFF-BAF869******
TotalRecordCount	string	The total number of GDN records.	1
PageRecordCount	string	The number of records on the current page.	1
PageNumber	string	The current page number.	1
Items	object	A container object for the list of GDNs.The GDN details
Networks	array<object>	An array of GDN network objects.The GDN network list
	array<object>	The GDN network details
NetworkId	string	The unique ID of the GDN.The GDN ID	gdn-xxx
NetworkDescription	string	The GDN description/remarks.	mygdn
NetworkStatus	string	The GDN status. Valid values: Creating: Creating Running: Running Syncing: Synchronizing SyncFinished: Synchronization completed SyncFailed: Synchronization failed SyncPartialFailed: Partial synchronization failed Stopped: Stopped Maintaining: In maintenance Restarting: Restarting Locking: Locking Locked: Locked Unlocking: Unlocking Deleting: Deleting Deleted: Deleted	Running
NetworkTopology	object	A container object describing the GDN's network topology.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: PolarFS High-performance Edition. pcs: PolarFS Cold Storage Edition.	pcs
SourceRegion	string	The source region.	cn-wulanchabu
SourceId	string	The source PolarFS 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: PolarFS High-performance Edition. pcs: PolarFS Cold Storage Edition.	pfs
DestinationId	string	The destination PolarFS instance.	pfs-xxx
CreateTime	string	The creation time of the GDN.	2025-03-25T09:37:10Z
Channels	array<object>	An array of objects describing the synchronization channels.The synchronization channel list
	object	The synchronization channel.
ChannelId	string	The synchronization channel ID	gdc-xxx
ChannelStatus	string	The synchronization channel status. Valid values:大小写不符合规范（冒号后的不完整句子不用大写） Creating: Creating Running: Running Syncing: Synchronizing SyncFinished: Synchronization completed SyncFailed: Synchronization failed SyncPartialFailed: Partial synchronization failed Stopped: Stopped Maintaining: In maintenance Restarting: Restarting Locking: Locking Locked: Locked Unlocking: Unlocking Deleting: Deleting Deleted: Deleted	Syncing
Progress	string	The current synchronization progress. Note The format is a floating-point percentage with two decimal places.	11.45%
FreezeSourceDuringSync	boolean	Indicates whether to freeze the source path during transmission.	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.