Build a PolarFS Global Data Network for Cross-Region Sync via API - PolarDB

Create a new PolarLakeBase Global Data Network (GDN).

Operation description

Note

This API creates a PolarFileSystem (PolarFS) Global Data Network (GDN). Do not confuse it with the CreateGlobalDatabaseNetwork API, which operates on a PolarDB cluster. Ensure you are using the correct API to avoid unintended actions.

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

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description or remarks for the GDN.	mygdn
SourceId	string	No	Source PolarFileSystem (PolarFS) instance.	pcs-xxx
DestinationId	string	No	Target PolarFileSystem (PolarFS) instance	pfs-xxx
SourceFileSystemPath	string	No	The source path.	/
DestinationFileSystemPath	string	No	Destination path	/
SourceType	string	No	The type of the source instance. Valid values: pfs: PolarFS High-Performance Edition. pcs: PolarFS Cold Storage Edition.	pcs
DestinationType	string	No	The type of the destination instance. Valid values: pfs: PolarFS High-Performance Edition. pcs: PolarFS Cold Storage Edition.	pfs
SourceRegion	string	No	The region of the source PolarFS instance.	cn-wulanchabu
DestinationRegion	string	No	The region of the destination PolarFS instance.	cn-beijing
FreezeSourceDuringSync	string	No	Whether to freeze the source path during transmission. Valid values: true: Freeze. false: Do not freeze. Note Currently only supports oss source.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique request ID.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
NetworkId	string	The unique ID of the newly created GDN.	gdn-xxx
ChannelId	string	The unique ID of the newly created synchronization channel.	gdc-xxx

Examples

Success response

JSON format

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "NetworkId": "gdn-xxx",
  "ChannelId": "gdc-xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.