Creates a PolarDB cluster.
Operation description
DBLink can connect two PolarDB for PostgreSQL (Compatible with Oracle) clusters, or connect a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a self-managed PostgreSQL database on an ECS instance. You can use DBLink to query data across clusters.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| ZoneId |
string |
No |
The zone ID. |
cn-hangzhou-j |
| Architecture |
string |
No |
The CPU architecture. Valid values: |
X86 |
| DBType |
string |
Yes |
The database engine type. Valid values: |
MySQL |
| DBVersion |
string |
Yes |
The database engine version. |
5.6 |
| DBNodeClass |
string |
No |
The node specifications. For details, see the following topics: |
polar.mysql.x4.medium |
| ClusterNetworkType |
string |
No |
The network type of the cluster. Currently, only Virtual Private Cloud (VPC) is supported. Set the value to VPC. |
VPC |
| DBClusterDescription |
string |
No |
The cluster name. The cluster name must meet the following requirements: |
test |
| PayType |
string |
Yes |
The billing method. Valid values: |
Postpaid |
| AutoRenew |
boolean |
No |
Specifies whether to enable auto-renewal. Valid values: |
true |
| Period |
string |
No |
This parameter is required when PayType is set to Prepaid. Specifies whether the subscription cluster uses a yearly or monthly billing cycle. |
Month |
| UsedTime |
string |
No |
This parameter is required when PayType is set to Prepaid. |
1 |
| VPCId |
string |
No |
The VPC ID. |
vpc-********** |
| VSwitchId |
string |
No |
The vSwitch ID. |
vsw-********** |
| CreationOption |
string |
No |
The method used to create the cluster. Valid values: |
Normal |
| SourceResourceId |
string |
No |
The instance ID of the source ApsaraDB RDS instance or the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, CloneFromPolarDB, or RecoverFromRecyclebin. |
rm-************* |
| CloneDataPoint |
string |
No |
The point in time at which data is cloned. Valid values: |
LATEST |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and is unique among different requests. The value is case-sensitive and cannot exceed 64 ASCII characters in length. |
6000170000591aed949d0f5******************** |
| ResourceGroupId |
string |
No |
The resource group ID. |
rg-************ |
| SecurityIPList |
string |
No |
The IP whitelist of the PolarDB cluster. |
10.***.***.*** |
| TDEStatus |
boolean |
No |
Specifies whether to enable Transparent Data Encryption (TDE). Valid values: |
true |
| GDNId |
string |
No |
The global database network (GDN) ID. |
gdn-*********** |
| CreationCategory |
string |
No |
The edition of the cluster. Valid values: |
Normal |
| DefaultTimeZone |
string |
No |
The time zone of the cluster (UTC). The value can be set to any time frame within the range of -12:00 to +13:00, such as 00:00. Default value: SYSTEM. The default time zone is the same as the time zone of the region. |
SYSTEM |
| LowerCaseTableNames |
string |
No |
Specifies whether table names are case-sensitive. Valid values: |
1 |
| BackupRetentionPolicyOnClusterDeletion |
string |
No |
The data retention policy for backups when the cluster is deleted. Valid values: |
NONE |
| StorageSpace |
integer |
No |
The storage space for the space-based billing (subscription) plan. Unit: GB. |
50 |
| DBMinorVersion |
string |
No |
The minor version of the database engine. Valid values: |
8.0.1 |
| ParameterGroupId |
string |
No |
The parameter template ID. |
pcpg-************** |
| Tag |
array<object> |
No |
The list of tags. |
|
|
object |
No |
Note
You can call the DescribeDBClusters operation to query the tags of all clusters under your account. If this parameter is left empty, the default value is false. |
||
| Key |
string |
No |
The tag key. To add multiple tags to the cluster at a time, click Add to add tag keys. |
type |
| Value |
string |
No |
The tag value. To add multiple tags to the cluster at a time, click Add to add tag values. |
test |
| ServerlessType |
string |
No |
The serverless type. The value is fixed as AgileServerless. |
AgileServerless |
| ScaleMin |
string |
No |
The minimum scaling limit per node. Valid values: 1 PCU to 31 PCUs. |
1 |
| ScaleMax |
string |
No |
The maximum scaling limit per node. Valid values: 1 PCU to 32 PCUs. |
3 |
| AllowShutDown |
string |
No |
Specifies whether to enable No-activity Suspension. Valid values: |
true |
| ScaleRoNumMin |
string |
No |
The minimum number of read-only nodes for scaling. Valid values: 0 to 15. |
2 |
| ScaleRoNumMax |
string |
No |
The maximum number of read-only nodes for scaling. Valid values: 0 to 15. |
4 |
| StorageType |
string |
No |
The storage type for Enterprise Edition. Valid values: |
PSL4 |
| DBNodeNum |
integer |
No |
The number of nodes for Standard Edition and Enterprise Edition. Valid values: |
1 |
| HotStandbyCluster |
string |
No |
Specifies whether the hot standby cluster is enabled. Valid values: |
ON |
| StrictConsistency |
string |
No |
Specifies whether to enable multi-zone strong data consistency for the cluster. Valid values: |
ON |
| StandbyAZ |
string |
No |
The zone of the hot standby cluster. |
cn-hangzhou-g |
| ProxyType |
string |
No |
The database proxy type. Valid values: |
Exclusive |
| ProxyClass |
string |
No |
The specification of the database proxy for Standard Edition. Valid values: |
polar.maxscale.g2.medium.c |
| LoosePolarLogBin |
string |
No |
Specifies whether to enable the Binlog feature. Valid values: |
ON |
| LooseXEngine |
string |
No |
Specifies whether to enable the X-Engine storage engine. Valid values: |
ON |
| LooseXEngineUseMemoryPct |
string |
No |
The percentage of memory allocated to the X-Engine storage engine. Valid values: integers from 10 to 90. |
50 |
| StoragePayType |
string |
No |
The billing type for storage. Valid values: |
Prepaid |
| StorageAutoScale |
string |
No |
Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values: |
Enable |
| StorageUpperBound |
integer |
No |
The upper limit of automatic storage scaling for the Standard Edition cluster. Unit: GB. |
800 |
| ProvisionedIops |
integer |
No |
1000 |
|
| BurstingEnabled |
string |
No |
Specifies whether to enable I/O performance burst for the ESSD AutoPL cloud disk. Valid values: |
false |
| TargetMinorVersion |
string |
No |
The target minor engine version. |
8.0.1.1.54 |
| StorageEncryption |
boolean |
No |
Specifies whether to enable cloud disk encryption. Valid values: |
|
| StorageEncryptionKey |
string |
No |
The key ID of the custom Key Management Service (KMS) key for cloud disk encryption in the same region as the instance. Specifying this parameter automatically enables cloud disk encryption, which cannot be disabled after being enabled. Leave this parameter empty to use the default service key for cloud disk encryption. |
1022xxxxxxxx |
| SourceUid |
integer |
No |
The UID of the account that owns the source backup set in cross-account backup restoration scenarios. |
1022xxxxxxxx |
| CloudProvider |
string |
No |
The cloud service provider to which the instance belongs. |
ENS |
| EnsRegionId |
string |
No |
The ENS node ID required when creating an ENS database. |
vn-hanoi-3 |
| AutoUseCoupon |
boolean |
No |
Specifies whether to automatically use coupons. Valid values: |
true |
| PromotionCode |
string |
No |
The coupon code. If not specified, the default coupon is used. |
727xxxxxx934 |
| AgenticDbType |
string |
No |
The Agentic database engine type. Valid values: |
dedicated |
| AgenticDbClusterId |
string |
No |
The Agentic cluster ID. |
pagc-****** |
| AgenticDbClusterDescription |
string |
No |
The Agentic cluster description. |
pagc-****** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| DBClusterId |
string |
The cluster ID. |
pc-bp1s826a1up****** |
| OrderId |
string |
The order ID. |
211454967****** |
| RequestId |
string |
The request ID. |
E56531A4-E552-40BA-9C58-137B80****** |
| ResourceGroupId |
string |
The resource group ID. |
rg-*************** |
| AgenticDbClusterId |
string |
The Agentic cluster ID. |
pagc-*************** |
| AgenticDbClusterDescription |
string |
The Agentic cluster description. |
pagc-*************** |
Examples
Success response
JSON format
{
"DBClusterId": "pc-bp1s826a1up******",
"OrderId": "211454967******",
"RequestId": "E56531A4-E552-40BA-9C58-137B80******",
"ResourceGroupId": "rg-***************",
"AgenticDbClusterId": "pagc-***************",
"AgenticDbClusterDescription": "pagc-***************"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidBackupRetentionPolicyOnClusterDeletion.Malformed | The specified BackupRetentionPolicyOnClusterDeletion is invalid. | The specified BackupRetentionPolicyOnClusterDeletion parameter is invalid. |
| 400 | InvalidLowerCaseTableNames.Malformed | The specified LowerCaseTableNames is invalid. | The specified LowerCaseTableNames parameter is invalid. |
| 400 | InvalidDefaultTimeZone.Malformed | The specified DefaultTimeZone is invalid. | The specified DefaultTimeZone parameter is invalid. |
| 400 | Location.FailedGetSubDomain | The specified regionId does not match the zoneId or the zoneId does not exist. | The specified region ID or zone ID is invalid or the specified zone ID does not exist. |
| 400 | MissParameter.GDNId | The GDNId parameter is required. | The GDNId parameter is required. |
| 400 | EntityNotExist.ResourceGroup | The resource group does not exist.. | The resource group does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.