DB クラスターを作成します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:CreateDBCluster |
create |
*DBCluster
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 説明
DescribeRegions 操作を呼び出して、利用可能なリージョンを照会できます。 |
cn-hangzhou |
| ZoneId |
string |
任意 |
ゾーン ID。 説明
DescribeRegions 操作を呼び出して、利用可能なゾーンを照会できます。 |
cn-hangzhou-j |
| Architecture |
string |
任意 |
CPU アーキテクチャ。 有効値:
|
X86 |
| DBType |
string |
必須 |
データベースエンジン。 有効値:
|
MySQL |
| DBVersion |
string |
必須 |
データベースエンジンのバージョン。
説明
PolarDB for PostgreSQL のサーバーレスクラスターを作成するには、このパラメーターを 14 に設定します。 |
5.6 |
| DBNodeClass |
string |
任意 |
ノード仕様。 詳細については、次のドキュメントをご参照ください。:
説明
|
polar.mysql.x4.medium |
| ClusterNetworkType |
string |
任意 |
クラスターのネットワークタイプ。 VPC のみがサポートされています。 値を VPC に設定します。 |
VPC |
| DBClusterDescription |
string |
任意 |
クラスター名。 クラスター名は、次の要件を満たす必要があります。:
|
test |
| PayType |
string |
必須 |
課金方法。 有効値:
|
Postpaid |
| AutoRenew |
boolean |
任意 |
自動更新を有効にするかどうかを指定します。 有効値:
デフォルト値:false。 説明
このパラメーターは、PayType パラメーターを Prepaid に設定した場合にのみ有効です。 |
true |
| Period |
string |
任意 |
サブスクリプションクラスターのサブスクリプション期間の単位。 このパラメーターは、PayType パラメーターを Prepaid に設定した場合に必要です。 有効値:
|
Month |
| UsedTime |
string |
任意 |
サブスクリプション期間。 このパラメーターは、PayType パラメーターを Prepaid に設定した場合に必要です。
|
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 に設定した場合にのみ必要です。
|
rm-************* |
| CloneDataPoint |
string |
任意 |
クローンのポイントインタイム。 有効値:
デフォルト値:LATEST。 説明
CreationOption を CloneFromRDS に設定した場合、このパラメーターは LATEST にのみ設定できます。 |
LATEST |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するためのクライアントトークン。 トークンは生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンでは大文字と小文字が区別され、長さは 64 ASCII 文字を超えることはできません。 |
6000170000591aed949d0f5******************** |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-************ |
| SecurityIPList |
string |
任意 |
クラスターの IP アドレスホワイトリスト。 説明
複数の IP アドレスを追加するには、コンマ (,) で区切ります。 |
10.***.***.*** |
| TDEStatus |
boolean |
任意 |
TDE (透過的データ暗号化) を有効にするかどうかを指定します。 有効値:
説明
|
true |
| GDNId |
string |
任意 |
グローバルデータベースネットワーク (GDN) の ID。 説明
このパラメーターは、CreationOption が CreateGdnStandby に設定されている場合に必要です。 |
gdn-*********** |
| CreationCategory |
string |
任意 |
クラスターのエディション。 有効値:
説明
製品エディションの詳細については、「製品エディション」をご参照ください。 |
Normal |
| DefaultTimeZone |
string |
任意 |
クラスターのタイムゾーン。 値は、**-12:00** から **+13:00** までの 1 時間単位の UTC オフセットである必要があります。 例:**00:00**。 デフォルト値は **SYSTEM** で、クラスターがそのリージョンと同じタイムゾーンを使用することを意味します。 説明
このパラメーターは、DBType を MySQL に設定した場合にのみ有効です。 |
SYSTEM |
| LowerCaseTableNames |
string |
任意 |
テーブル名で大文字と小文字を区別するかどうかを指定します。 有効値:
デフォルト値:1。 説明
このパラメーターは、DBType を MySQL に設定した場合にのみ有効です。 |
1 |
| BackupRetentionPolicyOnClusterDeletion |
string |
任意 |
クラスターが削除されたときのバックアップ保持ポリシー。 有効値:
デフォルト値は NONE で、クラスターが削除されてもバックアップセットは保持されないことを意味します。 説明
|
NONE |
| StorageSpace |
integer |
任意 |
ストレージにサブスクリプション課金方法を使用するサブスクリプションクラスターのストレージ容量。 単位:GB。 説明
|
50 |
| DBMinorVersion |
string |
任意 |
データベースエンジンのマイナーバージョン。 有効値:
説明
このパラメーターは、DBType を MySQL に、DBVersion を 8.0 に設定した場合にのみ有効です。 |
8.0.1 |
| ParameterGroupId |
string |
任意 |
パラメーターテンプレートの ID。 説明
DescribeParameterGroups 操作を呼び出して、各パラメーターテンプレートの ID を含む、リージョン内のパラメーターテンプレートを照会します。 |
pcpg-************** |
| Tag |
array<object> |
任意 |
クラスターのタグ。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグ N のキー。 クラスターに複数のタグを追加するには、[追加] をクリックしてタグキーを追加します。 説明
最大 20 個のタグを追加できます。 |
type |
| Value |
string |
任意 |
タグ N の値。 クラスターに複数のタグを追加するには、[追加] をクリックしてタグ値を追加します。 説明
最大 20 個のタグを追加できます。 |
test |
| ServerlessType |
string |
任意 |
サーバーレスクラスターのタイプ。 値を AgileServerless に設定します。 説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
AgileServerless |
| ScaleMin |
string |
任意 |
単一ノードの PolarDB Capacity Unit (PCU) の最小数。 有効値:1~31。 説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
1 |
| ScaleMax |
string |
任意 |
単一ノードの PCU の最大数。 有効値:1~32。 説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
3 |
| AllowShutDown |
string |
任意 |
無操作サスペンドを有効にするかどうかを指定します。 有効値:
説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
true |
| ScaleRoNumMin |
string |
任意 |
スケーリング用の読み取り専用ノードの最小数。 有効値:0~15。 説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
2 |
| ScaleRoNumMax |
string |
任意 |
スケーリング用の読み取り専用ノードの最大数。 有効値:0~15。 説明
このパラメーターはサーバーレスクラスターにのみ適用されます。 |
4 |
| StorageType |
string |
任意 |
Enterprise Edition クラスターのストレージクラス。 有効値:
Standard Edition クラスターのストレージクラス。 有効値:
|
PSL4 |
| DBNodeNum |
integer |
任意 |
Standard Edition または Enterprise Edition クラスターのノード数。 有効値:
説明
|
1 |
| HotStandbyCluster |
string |
任意 |
ホットスタンバイクラスター機能を有効にするかどうかを指定します。 有効値:
説明
STANDBY は PolarDB for PostgreSQL でのみ有効です。 |
ON |
| StrictConsistency |
string |
任意 |
マルチゾーンデータの強力な整合性を有効にするかどうかを指定します。 有効値:
|
ON |
| StandbyAZ |
string |
任意 |
ホットスタンバイクラスターのゾーン。 説明
このパラメーターは、ホットスタンバイクラスター機能またはマルチゾーンデータの強力な整合性を有効にした場合にのみ有効です。 |
cn-hangzhou-g |
| ProxyType |
string |
任意 |
データベースプロキシのタイプ。 有効値:
説明
プロキシタイプは、クラスターのノード仕様のタイプと一致している必要があります。 例:
|
Exclusive |
| ProxyClass |
string |
任意 |
Standard Edition クラスターのデータベースプロキシの仕様。 有効値:
|
polar.maxscale.g2.medium.c |
| LoosePolarLogBin |
string |
任意 |
バイナリログを有効にするかどうかを指定します。 有効値:
説明
このパラメーターは、DBType を MySQL に設定した場合にのみ有効です。 |
ON |
| LooseXEngine |
string |
任意 |
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 |
任意 |
ストレージの課金方法。 有効値:
|
Prepaid |
| StorageAutoScale |
string |
任意 |
Standard Edition クラスターのストレージの自動スケーリングを有効にするかどうかを指定します。 有効値:
|
Enable |
| StorageUpperBound |
integer |
任意 |
Standard Edition クラスターの自動スケーリングのためのストレージ容量の上限。 単位:GB。 説明
最大値は 32,000 です。 |
800 |
| ProvisionedIops |
integer |
任意 |
|
1000 |
| BurstingEnabled |
string |
任意 |
ESSD AutoPL ディスクのパフォーマンスバースト機能を有効にするかどうかを指定します。 有効値:
説明
このパラメーターは、StorageType を ESSDAUTOPL に設定した場合にのみ有効です。 |
false |
| TargetMinorVersion |
string |
任意 |
||
| StorageEncryption |
boolean |
任意 |
ディスク暗号化を有効にするかどうかを指定します。 有効値:
説明
このパラメーターは、DBType を MySQL に設定した場合にのみ有効です。 説明
このパラメーターは、StorageType パラメーターが Standard Edition のストレージクラスに設定されている場合にのみ有効です。 |
|
| StorageEncryptionKey |
string |
任意 |
インスタンスと同じリージョンにあるディスク暗号化用のカスタムキーの ID。 このパラメーターを指定すると、ディスク暗号化が自動的に有効になります。 ディスク暗号化を有効にした後、無効にすることはできません。 ディスク暗号化にデフォルトのサービスキーを使用する場合は、このパラメーターを空のままにします。 Key Management Service (KMS) コンソールでキー ID を表示したり、キーを作成したりできます。 説明
このパラメーターは、DBType を MySQL に設定した場合にのみ有効です。 説明
このパラメーターは、StorageType パラメーターが Standard Edition のストレージクラスに設定されている場合にのみ有効です。 |
|
| SourceUid |
integer |
任意 |
ソースバックアップセットを所有するアカウントの UID。 このパラメーターは、クロスアカウントのバックアップと復元に必要です。 |
1022xxxxxxxx |
| CloudProvider |
string |
任意 |
インスタンスのクラウドサービスプロバイダー。 |
ENS |
| EnsRegionId |
string |
任意 |
Edge Node Service (ENS) ノードの ID。 このパラメーターは、ENS データベースを作成するときに必要です。 |
vn-hanoi-3 |
| AutoUseCoupon |
boolean |
任意 |
クーポンを自動的に使用するかどうかを指定します。 有効値:
|
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.. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。