すべてのプロダクト
Search

このプロダクト

    :CreateDBCluster

    ドキュメントセンター

    :CreateDBCluster

    最終更新日:Dec 12, 2025

    この操作は、PolarDB クラスターを作成します。

    今すぐお試しください

    この 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 クラスター版のサーバーレスクラスターを作成するには、このパラメーターを polar.mysql.sl.small に設定します。

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

    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 に設定されている場合に必要です。

    • Period が Month に設定されている場合、UsedTime の値は [1-9] の整数です。

    • Period が Year に設定されている場合、UsedTime の値は [1-3] の整数です。

    1
    VPCId

    string

    任意

    VPC ID。

    vpc-**********
    VSwitchId

    string

    任意

    vSwitch ID。

    説明

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

    vsw-**********
    CreationOption

    string

    任意

    クラスターの作成に使用されるメソッド。有効値：

    デフォルト値：Normal。

    説明

    DBType が MySQL に、DBVersion が 8.0 に設定されている場合、このパラメーターは CreateGdnStandby に設定できます。

    Normal
    SourceResourceId

    string

    任意

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

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

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

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

    rm-*************
    CloneDataPoint

    string

    任意

    クローンの時点。有効値：

    • LATEST：最新の時点。

    • BackupID：過去のバックアップセットの ID。バックアップセットの ID を指定する必要があります。

    • Timestamp：特定の時点。時点を YYYY-MM-DDThh:mm:ssZ 形式で指定する必要があります。時間は UTC である必要があります。

    デフォルト値：LATEST。

    説明

    CreationOption を CloneFromRDS に設定した場合、このパラメーターは LATEST にしか設定できません。

    LATEST
    ClientToken

    string

    任意

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

    6000170000591aed949d0f5********************
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-************
    SecurityIPList

    string

    任意

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

    説明

    ホワイトリストには複数の IP アドレスを追加できます。IP アドレスはカンマ (,) で区切ります。

    10.***.***.***
    TDEStatus

    boolean

    任意

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

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

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

    説明

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

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

    • TDE は有効にすると無効にできません。

    true
    GDNId

    string

    任意

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

    説明

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

    gdn-***********
    CreationCategory

    string

    任意

    プロダクトシリーズ。有効値：

    • Normal：クラスター版 (デフォルト)

    • Basic：シングルノード版

    • ArchiveNormal：X-Engine 版

    • NormalMultimaster：Multi-master Cluster Edition

    • SENormal：Standard Edition

    説明

    • Basic は、PolarDB for MySQL 5.6、5.7、8.0、PolarDB for PostgreSQL 14、および PolarDB for PostgreSQL (Oracle Compatible) 2.0 でサポートされています。

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

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

    プロダクトシリーズの詳細については、「プロダクトシリーズ」をご参照ください。

    Normal
    DefaultTimeZone

    string

    任意

    クラスターのタイムゾーン。タイムゾーンは、UTC+ 形式で **-12:00 から +13:00** までの値である必要があります。値は正時である必要があります。たとえば、値を **00:00** に設定できます。デフォルト値は **SYSTEM** で、クラスターがリージョンと同じタイムゾーンを使用することを示します。

    説明

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

    SYSTEM
    LowerCaseTableNames

    string

    任意

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

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

    • 0：テーブル名の大文字と小文字は区別されます。

    デフォルト値：1。

    説明

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

    1
    BackupRetentionPolicyOnClusterDeletion

    string

    任意

    クラスター削除時のバックアップ保持ポリシー。有効値：

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

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

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

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

    説明

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

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

    NONE
    StorageSpace

    integer

    任意

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

    説明

    • PolarDB for MySQL Enterprise Edition クラスターのストレージ容量は 10 GB から 50000 GB の範囲です。

    • PolarDB for MySQL Standard Edition クラスターのストレージ容量は 20 GB から 64000 GB の範囲です。

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

    50
    DBMinorVersion

    string

    任意

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

    • 8.0.2

    • 8.0.1

    説明

    このパラメーターは、DBType を MySQL に、DBVersion を 8.0 に設定した場合にのみ有効です。

    8.0.1
    ParameterGroupId

    string

    任意

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

    説明

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

    pcpg-**************
    Tag

    array<object>

    任意

    クラスターのタグ。

    object

    任意

    Key

    string

    任意

    タグ N のキー。

    説明

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

    type
    Value

    string

    任意

    タグ N の値。

    説明

    最大 20 個のタグを追加できます。Tag.N.Value は Tag.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：クラスターのバイナリログを無効にします。

    説明

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

    ON
    LooseXEngine

    string

    任意

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

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

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

    説明

    このパラメーターは、CreationOption を CreateGdnStandby 以外の値に設定し、DBType を MySQL に、DBVersion を 8.0 に設定した場合にのみ有効です。X-Engine が有効なノードのメモリは 8 GB 以上である必要があります。

    ON
    LooseXEngineUseMemoryPct

    string

    任意

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

    説明

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

    50
    StoragePayType

    string

    任意

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

    • Postpaid：従量課金。

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

    Prepaid
    StorageAutoScale

    string

    任意

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

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

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

    Enable
    StorageUpperBound

    integer

    任意

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

    説明

    最大値は 32000 です。

    800
    ProvisionedIops

    integer

    任意

    1000
    BurstingEnabled

    string

    任意

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

    • true：機能を有効にします。

    • false：機能を無効にします (デフォルト)。

    説明

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

    false
    TargetMinorVersion

    string

    任意

    StorageEncryption

    boolean

    任意

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

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

    • false：ディスク暗号化を無効にします (デフォルト)。

    説明

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

    説明

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

    StorageEncryptionKey

    string

    任意

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

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

    説明

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

    説明

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

    SourceUid

    integer

    任意

    1022xxxxxxxx
    CloudProvider

    string

    任意

    ENS
    EnsRegionId

    string

    任意

    vn-hanoi-3
    AutoUseCoupon

    boolean

    任意

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

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

    変更履歴

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