All Products
Search
Document Center

PolarDB:CreateGlobalDatabaseNetwork

Last Updated:Mar 01, 2024

Creates a global database network (GDN).

Operation description

Note A cluster belongs to only one GDN.

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:CreateGlobalDatabaseNetworkWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the primary cluster.

pc-bp1q76364ird*****
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.
GDN-fortest
ResourceGroupIdstringNo

The ID of the resource group.

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

Response parameters

ParameterTypeDescriptionExample
object
GDNIdstring

The ID of the GDN.

gd-m5ex5wqfqbou*****
RequestIdstring

The request ID.

C61892A4-0850-4516-9E26-44D96C1782DE

Examples

Sample success responses

JSONformat

{
  "GDNId": "gd-m5ex5wqfqbou*****",
  "RequestId": "C61892A4-0850-4516-9E26-44D96C1782DE"
}

Error codes

HTTP status codeError codeError messageDescription
400MemberIns.ExistSpecified member ins already exist.The specified member ins already exists.
400InvalidEngineVersion.UnsupportedThe specified engineVersion is not supported.The specified engineVersion parameter is not supported.
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.NotFoundThe DBInstanceId 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-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 404 change
2021-06-21Add Operationsee changesets