全部产品
Search
文档中心

PolarDB:CreateDBCluster

更新时间:Dec 15, 2025

Operasi ini membuat kluster PolarDB.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

polardb:CreateDBCluster

create

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

  • polardb:EncryptionRequired
None

Parameter permintaan

Parameter

Type

Required

Description

Example

RegionId

string

Yes

ID wilayah.

Catatan

Anda dapat memanggil operasi DescribeRegions untuk mengambil daftar wilayah terbaru.

cn-hangzhou

ZoneId

string

No

ID zona.

Catatan

Anda dapat memanggil operasi DescribeRegions untuk mengambil daftar zona yang tersedia.

cn-hangzhou-j

Architecture

string

No

Arsitektur CPU. Nilai yang valid:

  • X86

  • ARM

X86

DBType

string

Yes

Mesin database. Nilai yang valid:

  • MySQL

  • PostgreSQL

  • Oracle

MySQL

DBVersion

string

Yes

Versi mesin database.

  • Nilai yang valid untuk MySQL:
    • 5.6

    • 5.7

    • 8.0

  • Nilai yang valid untuk PostgreSQL:
    • 11

    • 14

    • 15

Catatan

Untuk membuat kluster serverless untuk PolarDB for PostgreSQL, Anda harus mengatur parameter ini ke 14.

* Nilai yang valid untuk Oracle: * **11** * **14**

5.6

DBNodeClass

string

No

Spesifikasi node. Untuk informasi selengkapnya, lihat dokumen berikut:

Catatan
  • Untuk membuat kluster serverless untuk PolarDB untuk MySQL Edisi Kluster, atur parameter ini ke polar.mysql.sl.small.

  • Untuk membuat kluster serverless untuk PolarDB untuk MySQL Edisi Standar, atur parameter ini ke polar.mysql.sl.small.c.

polar.mysql.x4.medium

ClusterNetworkType

string

No

Jenis jaringan kluster. Saat ini, hanya virtual private cloud (VPC) yang didukung. Nilainya tetap sebagai VPC.

VPC

DBClusterDescription

string

No

Deskripsi kluster. Deskripsi harus memenuhi persyaratan berikut:

  • Tidak boleh diawali dengan http:// atau https://.

  • Panjangnya harus antara 2 hingga 256 karakter.

test

PayType

string

Yes

Metode penagihan. Nilai yang valid:

  • Postpaid: pay-as-you-go.

  • Prepaid: subscription.

Postpaid

AutoRenew

boolean

No

Menentukan apakah perpanjangan otomatis diaktifkan. Nilai yang valid:

  • true

  • false

Nilai default: false.

Catatan

Parameter ini hanya berlaku jika parameter PayType diatur ke Prepaid.

true

Period

string

No

Parameter ini wajib jika parameter PayType diatur ke Prepaid. Jenis langganan untuk klaster langganan.

  • Year: Durasi langganan dalam satuan tahun.

  • Month: Durasi langganan dalam satuan bulan.

Month

UsedTime

string

No

Parameter ini wajib jika parameter PayType diatur ke Prepaid.

  • Jika Period diatur ke Month, nilai UsedTime adalah bilangan bulat dari [1-9].

  • Jika Period diatur ke Year, nilai UsedTime adalah bilangan bulat dari [1-3].

1

VPCId

string

No

ID VPC.

vpc-**********

VSwitchId

string

No

ID virtual switch.

Catatan

Jika Anda menentukan VPCId, Anda juga harus menentukan parameter ini.

vsw-**********

CreationOption

string

No

Metode yang digunakan untuk membuat kluster. Nilai yang valid:

Nilai default: Normal.

Catatan

Jika DBType diatur ke MySQL dan DBVersion diatur ke 8.0, parameter ini dapat diatur ke CreateGdnStandby.

Normal

SourceResourceId

string

No

ID instans ApsaraDB RDS atau kluster PolarDB sumber. Parameter ini wajib hanya jika Anda mengatur CreationOption ke MigrationFromRDS, CloneFromRDS, CloneFromPolarDB, atau RecoverFromRecyclebin.

  • Jika Anda mengatur CreationOption ke MigrationFromRDS atau CloneFromRDS, Anda harus mengatur parameter ini ke ID instans ApsaraDB RDS sumber. Instans ApsaraDB RDS sumber harus merupakan instans ApsaraDB RDS untuk MySQL 5.6, 5.7, atau 8.0 Edisi Ketersediaan Tinggi.

  • Jika Anda mengatur CreationOption ke CloneFromPolarDB, Anda harus mengatur parameter ini ke ID kluster PolarDB sumber. Secara default, kluster baru akan memiliki mesin database yang sama dengan kluster sumber. Misalnya, jika kluster sumber adalah kluster MySQL 8.0, Anda harus mengatur DBType ke MySQL dan DBVersion ke 8.0 untuk kluster baru.

  • Jika Anda mengatur CreationOption ke RecoverFromRecyclebin, Anda harus mengatur parameter ini ke ID kluster PolarDB sumber yang telah dirilis. Mesin database kluster yang ingin Anda pulihkan dari Keranjang daur ulang harus sama dengan mesin database kluster sumber. Misalnya, jika kluster sumber adalah kluster MySQL 8.0, Anda harus mengatur DBType ke MySQL dan DBVersion ke 8.0 untuk kluster yang ingin Anda pulihkan dari Keranjang daur ulang.

rm-*************

CloneDataPoint

string

No

Titik waktu untuk kloning. Nilai yang valid:

  • LATEST: titik waktu terbaru.

  • BackupID: ID set cadangan historis. Anda harus menentukan ID set cadangan tersebut.

  • Timestamp: titik waktu tertentu. Anda harus menentukan titik waktu dalam format YYYY-MM-DDThh:mm:ssZ. Waktu harus dalam UTC.

Nilai default: LATEST.

Catatan

Jika Anda mengatur CreationOption ke CloneFromRDS, Anda hanya dapat mengatur parameter ini ke LATEST.

LATEST

ClientToken

string

No

Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan nilai ini dari sisi klien, tetapi pastikan nilainya unik di antara permintaan yang berbeda. Token bersifat case-sensitive dan tidak boleh melebihi 64 karakter ASCII.

6000170000591aed949d0f5********************

ResourceGroupId

string

No

ID kelompok sumber daya.

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

SecurityIPList

string

No

Daftar putih IP kluster.

Catatan

Anda dapat menambahkan beberapa alamat IP ke daftar putih. Pisahkan alamat IP dengan koma (,).

10.***.***.***

TDEStatus

boolean

No

Menentukan apakah Enkripsi Data Transparan (TDE) diaktifkan. Nilai yang valid:

  • true: mengaktifkan TDE.

  • false: menonaktifkan TDE. Ini adalah nilai default.

Catatan
  • Parameter ini hanya berlaku jika Anda mengatur DBType ke PostgreSQL atau Oracle.

  • Anda dapat memanggil operasi ModifyDBClusterTDE untuk mengaktifkan TDE pada kluster PolarDB untuk MySQL.

  • Anda tidak dapat menonaktifkan TDE setelah diaktifkan.

true

GDNId

string

No

ID Jaringan Basis Data Global (GDN).

Catatan

Parameter ini wajib jika CreationOption diatur ke CreateGdnStandby.

gdn-***********

CreationCategory

string

No

Seri produk. Nilai yang valid:

  • Normal: Edisi Kluster (default)

  • Basic: Edisi Node Tunggal

  • ArchiveNormal: Edisi X-Engine

  • NormalMultimaster: Edisi Kluster Multi-master

  • SENormal: Edisi Standar

Catatan
  • Basic didukung untuk PolarDB untuk MySQL 5.6, 5.7, dan 8.0, PolarDB untuk PostgreSQL 14, dan PolarDB untuk PostgreSQL (Oracle Compatible) 2.0.

  • ArchiveNormal dan NormalMultimaster didukung untuk PolarDB untuk MySQL 8.0.

  • SENormal didukung untuk PolarDB untuk MySQL 5.6, 5.7, dan 8.0 serta PolarDB untuk PostgreSQL 14.

Untuk informasi selengkapnya tentang seri produk, lihat Seri produk.

Normal

DefaultTimeZone

string

No

Zona waktu kluster. Zona waktu harus berupa nilai dari **-12:00 hingga +13:00** dalam format UTC+. Nilainya harus tepat pada jam. Sebagai contoh, Anda dapat mengatur nilainya ke **00:00**. Nilai default adalah **SYSTEM**, yang menunjukkan bahwa kluster menggunakan zona waktu yang sama dengan wilayah.

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

SYSTEM

LowerCaseTableNames

string

No

Menentukan apakah nama tabel bersifat case-sensitive. Nilai yang valid:

  • 1: Nama tabel tidak case-sensitive.

  • 0: Nama tabel case-sensitive.

Nilai default: 1.

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

1

BackupRetentionPolicyOnClusterDeletion

string

No

Kebijakan retensi backup untuk kluster saat dihapus. Nilai yang valid:

  • ALL: Semua backup disimpan secara permanen.

  • LATEST: Backup terakhir disimpan secara permanen. Backup otomatis dilakukan sebelum kluster dihapus.

  • NONE: Tidak ada set cadangan yang disimpan saat kluster dihapus.

Nilai default adalah NONE saat Anda membuat kluster. Ini menunjukkan bahwa tidak ada set cadangan yang disimpan saat kluster dihapus.

Catatan
  • Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

  • Parameter ini tidak didukung untuk kluster serverless.

NONE

StorageSpace

integer

No

Storage space kluster langganan yang menggunakan metode penagihan langganan untuk penyimpanan. Satuan: GB.

Catatan
  • Storage space kluster PolarDB untuk MySQL Edisi Perusahaan berkisar antara 10 GB hingga 50000 GB.

  • Storage space kluster PolarDB untuk MySQL Edisi Standar berkisar antara 20 GB hingga 64000 GB.

  • Jika kelas penyimpanan kluster Edisi Standar adalah ESSDAUTOPL, storage space berkisar antara 40 GB hingga 64000 GB. Ukuran langkahnya adalah 10 GB. Anda hanya dapat menentukan nilai seperti 40, 50, dan 60.

50

DBMinorVersion

string

No

Versi minor mesin database. Nilai yang valid:

  • 8.0.2

  • 8.0.1

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL dan DBVersion ke 8.0.

8.0.1

ParameterGroupId

string

No

ID template parameter.

Catatan

Anda dapat memanggil operasi DescribeParameterGroups untuk mengambil template parameter di suatu wilayah, termasuk ID setiap template parameter.

pcpg-**************

Tag

array<object>

No

Tag kluster.

object

No

Key

string

No

Kunci tag N.

Catatan

Anda dapat menambahkan hingga 20 tag. Tag.N.Key berkorespondensi dengan Tag.N.Value.

type

Value

string

No

Nilai tag N.

Catatan

Anda dapat menambahkan hingga 20 tag. Tag.N.Value berkorespondensi dengan Tag.N.Key.

test

ServerlessType

string

No

Jenis kluster serverless. Nilainya tetap sebagai AgileServerless.

Catatan

Parameter ini hanya didukung untuk kluster serverless.

AgileServerless

ScaleMin

string

No

Jumlah minimum Unit Kapasitas PolarDB (PCU) untuk satu node. Nilai yang valid: 1 hingga 31.

Catatan

Parameter ini hanya didukung untuk kluster serverless.

1

ScaleMax

string

No

Jumlah maksimum PCU untuk satu node. Nilai yang valid: 1 hingga 32.

Catatan

Parameter ini hanya didukung untuk kluster serverless.

3

AllowShutDown

string

No

Menentukan apakah Penangguhan Tanpa Aktivitas diaktifkan. Nilai yang valid:

  • true

  • false (default)

Catatan

Parameter ini hanya didukung untuk kluster serverless.

true

ScaleRoNumMin

string

No

Jumlah minimum node read-only untuk penskalaan. Nilai yang valid: 0 hingga 15.

Catatan

Parameter ini hanya didukung untuk kluster serverless.

2

ScaleRoNumMax

string

No

Jumlah maksimum node read-only untuk penskalaan. Nilai yang valid: 0 hingga 15.

Catatan

Parameter ini hanya didukung untuk kluster serverless.

4

StorageType

string

No

Kelas penyimpanan kluster Edisi Perusahaan. Nilai yang valid:

  • PSL5

  • PSL4

Kelas penyimpanan kluster Edisi Standar. Nilai yang valid:

  • ESSDPL0

  • ESSDPL1

  • ESSDPL2

  • ESSDPL3

  • ESSDAUTOPL

PSL4

DBNodeNum

integer

No

Jumlah node untuk kluster Edisi Standar atau Edisi Perusahaan. Nilai yang valid:

  • Edisi Standar: 1 hingga 8. Anda dapat menambahkan satu node baca/tulis dan tujuh node read-only.

  • Edisi Perusahaan: 1 hingga 16. Anda dapat menambahkan satu node baca/tulis dan 15 node read-only.

Catatan
  • Secara default, kluster Edisi Perusahaan memiliki dua node dan kluster Edisi Standar memiliki satu node.

  • Parameter ini hanya berlaku untuk PolarDB untuk MySQL.

  • Anda tidak dapat mengubah jumlah node untuk Kluster Multi-master.

1

HotStandbyCluster

string

No

Menentukan apakah fitur kluster hot standby diaktifkan. Nilai yang valid:

  • ON (default): mengaktifkan fitur klaster penyimpanan siaga panas.

  • OFF: menonaktifkan fitur kluster hot standby.

  • STANDBY: mengaktifkan fitur Hot Standby Cluster.

  • EQUAL: mengaktifkan hot standby untuk penyimpanan dan komputasi.

  • 3AZ: mengaktifkan konsistensi kuat untuk data multi-zona.

Catatan

STANDBY hanya berlaku untuk PolarDB untuk PostgreSQL.

ON

StrictConsistency

string

No

Menentukan apakah konsistensi kuat untuk data multi-zona diaktifkan. Nilai yang valid:

  • ON: mengaktifkan konsistensi kuat untuk data multi-zona. Nilai ini berlaku untuk skenario 3AZ pada Edisi Standar.

  • OFF: menonaktifkan konsistensi kuat untuk data multi-zona.

ON

StandbyAZ

string

No

Zona kluster hot standby.

Catatan

Parameter ini hanya berlaku jika Anda mengaktifkan fitur kluster hot standby atau konsistensi kuat untuk data multi-zona.

cn-hangzhou-g

ProxyType

string

No

Jenis proksi database. Nilai yang valid:

  • EXCLUSIVE: Edisi Perusahaan Khusus

  • GENERAL: Edisi Perusahaan Standar

Catatan

Jenis proxy harus konsisten dengan jenis spesifikasi node kluster. Contohnya:

  • Jika spesifikasi node bersifat tujuan umum, jenis proxy harus Edisi Perusahaan Standar.

  • Jika spesifikasi node bersifat spesifikasi khusus, jenis proxy harus Edisi Perusahaan Khusus.

Exclusive

ProxyClass

string

No

Spesifikasi proksi database untuk kluster Edisi Standar. Nilai yang valid:

  • polar.maxscale.g2.medium.c: 2 core.

  • polar.maxscale.g2.large.c: 4 core.

  • polar.maxscale.g2.xlarge.c: 8 core.

  • polar.maxscale.g2.2xlarge.c: 16 core.

  • polar.maxscale.g2.3xlarge.c: 24 core.

  • polar.maxscale.g2.4xlarge.c: 32 core.

  • polar.maxscale.g2.8xlarge.c: 64 core.

polar.maxscale.g2.medium.c

LoosePolarLogBin

string

No

Menentukan apakah binary logging diaktifkan. Nilai yang valid:

  • ON: mengaktifkan binary logging untuk kluster.

  • OFF: menonaktifkan binary logging untuk kluster.

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

ON

LooseXEngine

string

No

Menentukan apakah mesin penyimpanan X-Engine diaktifkan. Nilai yang valid:

  • ON: mengaktifkan mesin penyimpanan X-Engine untuk kluster.

  • OFF: menonaktifkan mesin penyimpanan X-Engine untuk kluster.

Catatan

Parameter ini hanya berlaku jika Anda mengatur CreationOption ke nilai selain CreateGdnStandby, DBType ke MySQL, dan DBVersion ke 8.0. Memori node dengan X-Engine yang diaktifkan harus minimal 8 GB.

ON

LooseXEngineUseMemoryPct

string

No

Persentase memori yang dialokasikan untuk mesin penyimpanan X-Engine. Nilai yang valid: bilangan bulat dari 10 hingga 90.

Catatan

Parameter ini hanya berlaku jika Anda mengatur LooseXEngine ke ON.

50

StoragePayType

string

No

Metode penagihan untuk penyimpanan. Nilai yang valid:

  • Postpaid: pay-as-you-go.

  • Prepaid: subscription.

Prepaid

StorageAutoScale

string

No

Menentukan apakah penskalaan penyimpanan otomatis diaktifkan untuk kluster Edisi Standar. Nilai yang valid:

  • Enable: mengaktifkan penskalaan penyimpanan otomatis.

  • Disable: menonaktifkan penskalaan penyimpanan otomatis.

Enable

StorageUpperBound

integer

No

Batas atas storage space untuk penskalaan otomatis kluster Edisi Standar. Satuan: GB.

Catatan

Nilai maksimum adalah 32000.

800

ProvisionedIops

integer

No

1000

BurstingEnabled

string

No

Menentukan apakah fitur lonjakan performa diaktifkan untuk disk ESSD AutoPL. Nilai yang valid:

  • true: mengaktifkan fitur.

  • false: menonaktifkan fitur (default).

Catatan

Parameter ini hanya berlaku ketika Anda mengatur StorageType ke ESSDAUTOPL.

false

TargetMinorVersion

string

No

StorageEncryption

boolean

No

Menentukan apakah enkripsi disk diaktifkan. Nilai yang valid:

  • true: mengaktifkan enkripsi disk.

  • false: menonaktifkan enkripsi disk (default).

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

Catatan

Parameter ini hanya berlaku ketika parameter StorageType diatur ke kelas penyimpanan Edisi Standar.

StorageEncryptionKey

string

No

ID kunci kustom untuk enkripsi disk di wilayah yang sama dengan instans. Jika Anda menentukan parameter ini, enkripsi disk akan diaktifkan secara otomatis. Setelah enkripsi disk diaktifkan, Anda tidak dapat menonaktifkannya. Jika Anda ingin menggunakan kunci layanan default untuk enkripsi disk, biarkan parameter ini kosong.

Anda dapat melihat ID kunci atau membuat kunci di Konsol Key Management Service (KMS).

Catatan

Parameter ini hanya berlaku jika Anda mengatur DBType ke MySQL.

Catatan

Parameter ini hanya berlaku ketika parameter StorageType diatur ke kelas penyimpanan Edisi Standar.

SourceUid

integer

No

1022xxxxxxxx

CloudProvider

string

No

ENS

EnsRegionId

string

No

vn-hanoi-3

AutoUseCoupon

boolean

No

PromotionCode

string

No

727xxxxxx934

Elemen respons

Element

Type

Description

Example

object

DBClusterId

string

ID kluster.

pc-bp1s826a1up******

OrderId

string

ID pesanan.

211454967******

RequestId

string

ID permintaan.

E56531A4-E552-40BA-9C58-137B80******

ResourceGroupId

string

ID kelompok sumber daya.

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

Contoh

Respons sukses

JSONformat

{
  "DBClusterId": "pc-bp1s826a1up******",
  "OrderId": "211454967******",
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
  "ResourceGroupId": "rg-***************"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 InvalidBackupRetentionPolicyOnClusterDeletion.Malformed The specified BackupRetentionPolicyOnClusterDeletion is invalid.
400 InvalidLowerCaseTableNames.Malformed The specified LowerCaseTableNames is invalid.
400 InvalidDefaultTimeZone.Malformed The specified DefaultTimeZone is invalid.
400 Location.FailedGetSubDomain The specified regionId does not match the zoneId or the zoneId does not exist.
400 MissParameter.GDNId The GDNId parameter is required.
400 EntityNotExist.ResourceGroup The resource group does not exist..

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.