すべてのプロダクト
Search
ドキュメントセンター

:CreateDBCluster

最終更新日:Feb 02, 2026

DB クラスターを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:CreateDBCluster

create

*DBCluster

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

  • polardb:EncryptionRequired
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

説明

DescribeRegions 操作を呼び出して、利用可能なリージョンを照会できます。

cn-hangzhou

ZoneId

string

任意

ゾーン ID。

説明

DescribeRegions 操作を呼び出して、利用可能なゾーンを照会できます。

cn-hangzhou-j

Architecture

string

任意

CPU アーキテクチャ。 有効値:

  • X86

  • ARM

X86

DBType

string

必須

データベースエンジン。 有効値:

  • MySQL

  • PostgreSQL

  • Oracle

MySQL

DBVersion

string

必須

データベースエンジンのバージョン。

  • MySQL の有効値:
    • 5.6

    • 5.7

    • 8.0

  • PostgreSQL の有効値:
    • 11

    • 14

    • 15

説明

PolarDB for PostgreSQL のサーバーレスクラスターを作成するには、このパラメーターを 14 に設定します。

Oracle の有効値: 11 14

5.6

DBNodeClass

string

任意

ノード仕様。 詳細については、次のドキュメントをご参照ください。:

説明
  • PolarDB for MySQL Cluster Edition のサーバーレスクラスターを作成するには、このパラメーターを polar.mysql.sl.small に設定します。

  • PolarDB for MySQL Standard Edition のサーバーレスクラスターを作成するには、このパラメーターを polar.mysql.sl.small.c に設定します。

  • PolarDB for PostgreSQL Cluster Edition のサーバーレスクラスターを作成するには、このパラメーターを polar.pg.sl.small に設定します。

  • PolarDB for PostgreSQL Standard Edition のサーバーレスクラスターを作成するには、このパラメーターを polar.pg.sl.small.c に設定します。

  • PolarDB for PostgreSQL (Oracle 互換) クラスターのサーバーレスクラスターを作成するには、このパラメーターを polar.o.sl.small に設定します。

polar.mysql.x4.medium

ClusterNetworkType

string

任意

クラスターのネットワークタイプ。 VPC のみがサポートされています。 値を VPC に設定します。

VPC

DBClusterDescription

string

任意

クラスター名。 クラスター名は、次の要件を満たす必要があります。:

  • http:// または https:// で始めることはできません。

  • 長さは 2~256 文字である必要があります。

test

PayType

string

必須

課金方法。 有効値:

  • Postpaid:従量課金。

  • Prepaid:サブスクリプション。

Postpaid

AutoRenew

boolean

任意

自動更新を有効にするかどうかを指定します。 有効値:

  • true:自動更新を有効にします。

  • false:自動更新を無効にします。

デフォルト値:false

説明

このパラメーターは、PayType パラメーターを Prepaid に設定した場合にのみ有効です。

true

Period

string

任意

サブスクリプションクラスターのサブスクリプション期間の単位。 このパラメーターは、PayType パラメーターを Prepaid に設定した場合に必要です。 有効値:

  • Year:サブスクリプション期間は年単位です。

  • Month:サブスクリプション期間は月単位です。

Month

UsedTime

string

任意

サブスクリプション期間。 このパラメーターは、PayType パラメーターを Prepaid に設定した場合に必要です。

  • PeriodMonth に設定した場合、UsedTime の値は 1~9 の整数です。

  • PeriodYear に設定した場合、UsedTime の値は 1~3 の整数です。

1

VPCId

string

任意

VPC ID。

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

VSwitchId

string

任意

vSwitch ID。

説明

VPCId を指定する場合は、このパラメーターも指定する必要があります。

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

CreationOption

string

任意

クラスターの作成方法。 有効値:

デフォルト値:Normal

説明

DBTypeMySQL に設定され、DBVersion8.0 に設定されている場合、このパラメーターは CreateGdnStandby に設定できます。

Normal

SourceResourceId

string

任意

ソース ApsaraDB RDS インスタンスまたは PolarDB クラスターの ID。 このパラメーターは、CreationOptionMigrationFromRDSCloneFromRDSCloneFromPolarDB、または RecoverFromRecyclebin に設定した場合にのみ必要です。

  • CreationOptionMigrationFromRDS または CloneFromRDS に設定した場合、このパラメーターをソース ApsaraDB RDS インスタンスの ID に設定する必要があります。 ソース ApsaraDB RDS インスタンスは、ApsaraDB RDS for MySQL 5.6、5.7、または 8.0 High-availability Edition インスタンスである必要があります。

  • CreationOptionCloneFromPolarDB に設定した場合、このパラメーターをソース PolarDB クラスターの ID に設定する必要があります。 デフォルトでは、新しいクラスターはデータベースエンジンの点でソースクラスターと同じです。 たとえば、ソースクラスターが MySQL 8.0 クラスターの場合、新しいクラスターの DBTypeMySQL に、DBVersion8.0 に設定する必要があります。

  • CreationOptionRecoverFromRecyclebin に設定した場合、このパラメーターをリリースされたソース PolarDB クラスターの ID に設定する必要があります。 ゴミ箱から復元するクラスターのデータベースエンジンは、ソースクラスターのデータベースエンジンと同じである必要があります。 たとえば、ソースクラスターが MySQL 8.0 クラスターの場合、ゴミ箱から復元するクラスターの DBTypeMySQL に、DBVersion8.0 に設定する必要があります。

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

CloneDataPoint

string

任意

クローンのポイントインタイム。 有効値:

  • LATEST:最新のポイントインタイム。

  • BackupID:履歴バックアップセットの ID。 バックアップセットの ID を指定する必要があります。

  • Timestamp:特定のポイントインタイム。 ポイントインタイムを YYYY-MM-DDThh:mm:ssZ 形式で指定する必要があります。 時刻は UTC である必要があります。

デフォルト値:LATEST

説明

CreationOptionCloneFromRDS に設定した場合、このパラメーターは LATEST にのみ設定できます。

LATEST

ClientToken

string

任意

リクエストのべき等性を保証するためのクライアントトークン。 トークンは生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンでは大文字と小文字が区別され、長さは 64 ASCII 文字を超えることはできません。

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

ResourceGroupId

string

任意

リソースグループ ID。

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

SecurityIPList

string

任意

クラスターの IP アドレスホワイトリスト。

説明

複数の IP アドレスを追加するには、コンマ (,) で区切ります。

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

TDEStatus

boolean

任意

TDE (透過的データ暗号化) を有効にするかどうかを指定します。 有効値:

  • true:TDE を有効にします。

  • false:TDE を無効にします。 これがデフォルト値です。

説明
  • このパラメーターは、DBTypePostgreSQL または Oracle に設定した場合にのみ有効です。

  • ModifyDBClusterTDE 操作を呼び出して、PolarDB for MySQL クラスターの TDE を有効にします。

  • TDE は有効にした後、無効にすることはできません。

true

GDNId

string

任意

グローバルデータベースネットワーク (GDN) の ID。

説明

このパラメーターは、CreationOptionCreateGdnStandby に設定されている場合に必要です。

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

CreationCategory

string

任意

クラスターのエディション。 有効値:

  • Normal:Cluster Edition (デフォルト)

  • Basic:Single Node Edition

  • ArchiveNormal:X-Engine Edition

  • NormalMultimaster:Multi-master Cluster Edition

  • SENormal:Standard Edition

説明
  • Basic は、PolarDB for MySQL 5.65.78.0、PolarDB for PostgreSQL 14、および PolarDB for PostgreSQL (Oracle 互換) 2.0 でサポートされています。

  • ArchiveNormalNormalMultimaster は、PolarDB for MySQL 8.0 でサポートされています。

  • SENormal は、PolarDB for MySQL 5.65.78.0 および PolarDB for PostgreSQL 14 でサポートされています。

製品エディションの詳細については、「製品エディション」をご参照ください。

Normal

DefaultTimeZone

string

任意

クラスターのタイムゾーン。 値は、**-12:00** から **+13:00** までの 1 時間単位の UTC オフセットである必要があります。 例:**00:00**。 デフォルト値は **SYSTEM** で、クラスターがそのリージョンと同じタイムゾーンを使用することを意味します。

説明

このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

SYSTEM

LowerCaseTableNames

string

任意

テーブル名で大文字と小文字を区別するかどうかを指定します。 有効値:

  • 1:テーブル名で大文字と小文字は区別されません。

  • 0:テーブル名で大文字と小文字が区別されます。

デフォルト値:1

説明

このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

1

BackupRetentionPolicyOnClusterDeletion

string

任意

クラスターが削除されたときのバックアップ保持ポリシー。 有効値:

  • ALL:すべてのバックアップが永続的に保持されます。

  • LATEST:最後のバックアップが永続的に保持されます。 クラスターが削除される前に自動バックアップが実行されます。

  • NONE:クラスターが削除されてもバックアップセットは保持されません。

デフォルト値は NONE で、クラスターが削除されてもバックアップセットは保持されないことを意味します。

説明
  • このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

  • このパラメーターはサーバーレスクラスターではサポートされていません。

NONE

StorageSpace

integer

任意

ストレージにサブスクリプション課金方法を使用するサブスクリプションクラスターのストレージ容量。 単位:GB。

説明
  • PolarDB for MySQL Enterprise Edition クラスターのストレージ容量は 10 GB~50,000 GB です。

  • PolarDB for MySQL Standard Edition クラスターのストレージ容量は 20 GB~64,000 GB です。

  • Standard Edition クラスターのストレージクラスが ESSDAUTOPL の場合、ストレージ容量は 40 GB~64,000 GB です。 ステップサイズは 10 GB です。 40、50、60 などの値のみ指定できます。

50

DBMinorVersion

string

任意

データベースエンジンのマイナーバージョン。 有効値:

  • 8.0.2

  • 8.0.1

説明

このパラメーターは、DBTypeMySQL に、DBVersion8.0 に設定した場合にのみ有効です。

8.0.1

ParameterGroupId

string

任意

パラメーターテンプレートの ID。

説明

DescribeParameterGroups 操作を呼び出して、各パラメーターテンプレートの ID を含む、リージョン内のパラメーターテンプレートを照会します。

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

Tag

array<object>

任意

クラスターのタグ。

object

任意

Key

string

任意

タグ N のキー。 クラスターに複数のタグを追加するには、[追加] をクリックしてタグキーを追加します。

説明

最大 20 個のタグを追加できます。 Tag.N.KeyTag.N.Value に対応します。

type

Value

string

任意

タグ N の値。 クラスターに複数のタグを追加するには、[追加] をクリックしてタグ値を追加します。

説明

最大 20 個のタグを追加できます。 Tag.N.ValueTag.N.Key に対応します。

test

ServerlessType

string

任意

サーバーレスクラスターのタイプ。 値を AgileServerless に設定します。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

AgileServerless

ScaleMin

string

任意

単一ノードの PolarDB Capacity Unit (PCU) の最小数。 有効値:1~31。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

1

ScaleMax

string

任意

単一ノードの PCU の最大数。 有効値:1~32。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

3

AllowShutDown

string

任意

無操作サスペンドを有効にするかどうかを指定します。 有効値:

  • true:無操作サスペンドを有効にします。

  • false:無操作サスペンドを無効にします。 これがデフォルト値です。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

true

ScaleRoNumMin

string

任意

スケーリング用の読み取り専用ノードの最小数。 有効値:0~15。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

2

ScaleRoNumMax

string

任意

スケーリング用の読み取り専用ノードの最大数。 有効値:0~15。

説明

このパラメーターはサーバーレスクラスターにのみ適用されます。

4

StorageType

string

任意

Enterprise Edition クラスターのストレージクラス。 有効値:

  • PSL5

  • PSL4

Standard Edition クラスターのストレージクラス。 有効値:

  • ESSDPL0

  • ESSDPL1

  • ESSDPL2

  • ESSDPL3

  • ESSDAUTOPL

PSL4

DBNodeNum

integer

任意

Standard Edition または Enterprise Edition クラスターのノード数。 有効値:

  • Standard Edition:1~8。 1 つの読み取り/書き込みノードと 7 つの読み取り専用ノードを追加できます。

  • Enterprise Edition:1~16。 1 つの読み取り/書き込みノードと 15 の読み取り専用ノードを追加できます。

説明
  • デフォルトでは、Enterprise Edition クラスターには 2 つのノードがあり、Standard Edition クラスターには 1 つのノードがあります。

  • このパラメーターは PolarDB for MySQL でのみ有効です。

  • Multi-master Cluster のノード数は変更できません。

1

HotStandbyCluster

string

任意

ホットスタンバイクラスター機能を有効にするかどうかを指定します。 有効値:

  • ON (デフォルト):ストレージホットスタンバイクラスター機能を有効にします。

  • OFF:ホットスタンバイクラスター機能を無効にします。

  • STANDBY:ホットスタンバイクラスター機能を有効にします。

  • EQUAL:ストレージとコンピューティングの両方でホットスタンバイを有効にします。

  • 3AZ:マルチゾーンデータの強力な整合性を有効にします。

説明

STANDBY は PolarDB for PostgreSQL でのみ有効です。

ON

StrictConsistency

string

任意

マルチゾーンデータの強力な整合性を有効にするかどうかを指定します。 有効値:

  • ON:マルチゾーンデータの強力な整合性を有効にします。 この値は、Standard Edition の 3AZ シナリオで有効です。

  • OFF:マルチゾーンデータの強力な整合性を無効にします。

ON

StandbyAZ

string

任意

ホットスタンバイクラスターのゾーン。

説明

このパラメーターは、ホットスタンバイクラスター機能またはマルチゾーンデータの強力な整合性を有効にした場合にのみ有効です。

cn-hangzhou-g

ProxyType

string

任意

データベースプロキシのタイプ。 有効値:

  • EXCLUSIVE:Dedicated Enterprise Edition

  • GENERAL:Standard Enterprise Edition

説明

プロキシタイプは、クラスターのノード仕様のタイプと一致している必要があります。 例:

  • ノード仕様が汎用の場合、プロキシタイプは Standard Enterprise Edition である必要があります。

  • ノード仕様が専用の場合、プロキシタイプは Dedicated Enterprise Edition である必要があります。

Exclusive

ProxyClass

string

任意

Standard Edition クラスターのデータベースプロキシの仕様。 有効値:

  • polar.maxscale.g2.medium.c:2 コア。

  • polar.maxscale.g2.large.c:4 コア。

  • polar.maxscale.g2.xlarge.c:8 コア。

  • polar.maxscale.g2.2xlarge.c:16 コア。

  • polar.maxscale.g2.3xlarge.c:24 コア。

  • polar.maxscale.g2.4xlarge.c:32 コア。

  • polar.maxscale.g2.8xlarge.c:64 コア。

polar.maxscale.g2.medium.c

LoosePolarLogBin

string

任意

バイナリログを有効にするかどうかを指定します。 有効値:

  • ON:クラスターのバイナリログを有効にします。

  • OFF:クラスターのバイナリログを無効にします。

説明

このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

ON

LooseXEngine

string

任意

X-Engine ストレージエンジンを有効にするかどうかを指定します。 有効値:

  • ON:クラスターの X-Engine ストレージエンジンを有効にします。

  • OFF:クラスターの X-Engine ストレージエンジンを無効にします。

説明

このパラメーターは、CreationOptionCreateGdnStandby 以外の値に設定し、DBTypeMySQL に、DBVersion8.0 に設定した場合にのみ有効です。 X-Engine が有効なノードのメモリは 8 GB 以上である必要があります。

ON

LooseXEngineUseMemoryPct

string

任意

X-Engine ストレージエンジンに割り当てられるメモリの割合。 有効値:10~90 の整数。

説明

このパラメーターは、LooseXEngineON に設定した場合にのみ有効です。

50

StoragePayType

string

任意

ストレージの課金方法。 有効値:

  • Postpaid:ストレージ容量による従量課金。

  • Prepaid:ストレージ容量によるサブスクリプション。

Prepaid

StorageAutoScale

string

任意

Standard Edition クラスターのストレージの自動スケーリングを有効にするかどうかを指定します。 有効値:

  • Enable:ストレージの自動スケーリングを有効にします。

  • Disable:ストレージの自動スケーリングを無効にします。

Enable

StorageUpperBound

integer

任意

Standard Edition クラスターの自動スケーリングのためのストレージ容量の上限。 単位:GB。

説明

最大値は 32,000 です。

800

ProvisionedIops

integer

任意

1000

BurstingEnabled

string

任意

ESSD AutoPL ディスクのパフォーマンスバースト機能を有効にするかどうかを指定します。 有効値:

  • true:この機能を有効にします。

  • false:この機能を無効にします。 これがデフォルト値です。

説明

このパラメーターは、StorageType を ESSDAUTOPL に設定した場合にのみ有効です。

false

TargetMinorVersion

string

任意

StorageEncryption

boolean

任意

ディスク暗号化を有効にするかどうかを指定します。 有効値:

  • true:ディスク暗号化を有効にします。

  • false:ディスク暗号化を無効にします。 これがデフォルト値です。

説明

このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

説明

このパラメーターは、StorageType パラメーターが Standard Edition のストレージクラスに設定されている場合にのみ有効です。

StorageEncryptionKey

string

任意

インスタンスと同じリージョンにあるディスク暗号化用のカスタムキーの ID。 このパラメーターを指定すると、ディスク暗号化が自動的に有効になります。 ディスク暗号化を有効にした後、無効にすることはできません。 ディスク暗号化にデフォルトのサービスキーを使用する場合は、このパラメーターを空のままにします。

Key Management Service (KMS) コンソールでキー ID を表示したり、キーを作成したりできます。

説明

このパラメーターは、DBTypeMySQL に設定した場合にのみ有効です。

説明

このパラメーターは、StorageType パラメーターが Standard Edition のストレージクラスに設定されている場合にのみ有効です。

SourceUid

integer

任意

ソースバックアップセットを所有するアカウントの UID。 このパラメーターは、クロスアカウントのバックアップと復元に必要です。

1022xxxxxxxx

CloudProvider

string

任意

インスタンスのクラウドサービスプロバイダー。

ENS

EnsRegionId

string

任意

Edge Node Service (ENS) ノードの ID。 このパラメーターは、ENS データベースを作成するときに必要です。

vn-hanoi-3

AutoUseCoupon

boolean

任意

クーポンを自動的に使用するかどうかを指定します。 有効値:

  • true (デフォルト):クーポンを自動的に使用します。

  • false:クーポンを使用しません。

true

PromotionCode

string

任意

プロモーションコード。 このパラメーターを指定しない場合、デフォルトのクーポンが使用されます。

727xxxxxx934

レスポンスフィールド

フィールド

説明

object

DBClusterId

string

クラスター ID。

pc-bp1s826a1up******

OrderId

string

注文 ID。

211454967******

RequestId

string

リクエスト ID。

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

ResourceGroupId

string

リソースグループ ID。

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

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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..

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。