PolarDB クラスターを作成します。
操作説明
DBLink を使用すると、2 つの PolarDB for PostgreSQL (Oracle 互換) クラスターを接続したり、PolarDB for PostgreSQL (Oracle 互換) クラスターを ECS インスタンス上のセルフマネージド PostgreSQL データベースに接続したりできます。DBLink を使用して、クラスター間でデータのクエリを実行できます。
1 つのクラスターに対して最大 10 個の DBLink を作成できます。
1 つの DBLink は、ソースクラスターと送信先クラスターの両方で 1 つの DBLink クォータを消費します。
ソースクラスターと送信先クラスターまたは送信先 ECS インスタンスは、同じリージョンにある必要があります。
今すぐお試しください
テスト
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 |
必須 |
データベース DPI エンジンのバージョン番号。
説明
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 を指定する場合は、VSwitchId も指定する必要があります。 |
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 |
任意 |
PolarDB クラスターの IP ホワイトリスト。 説明
ホワイトリストには複数の IP アドレスを設定できます。複数の IP アドレスはコンマ (,) で区切ります。 |
10.***.***.*** |
| TDEStatus |
boolean |
任意 |
TDE (透過的データ暗号化) を有効にするかどうかを指定します。有効な値:
説明
|
true |
| GDNId |
string |
任意 |
Global Database Network (GDN) の ID。 説明
このパラメーターは、CreationOption が CreateGdnStandby に設定されている場合に必須です。 |
gdn-*********** |
| CreationCategory |
string |
任意 |
クラスターのエディション。有効な値:
説明
エディションの詳細については、プロダクトエディション を参照してください。 |
Normal |
| DefaultTimeZone |
string |
任意 |
クラスターのデフォルトのタイムゾーン (協定世界時 (UTC))。値は、-12:00~+13:00 の範囲内の任意の時間枠 (例: 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 |
任意 |
説明
DescribeDBClusters 操作を呼び出して、アカウント配下のすべてのクラスターのタグをクエリできます。このパラメーターが空の場合、デフォルト値は false です。 |
||
| Key |
string |
任意 |
タグキー。ターゲットクラスターに複数のタグを同時に追加するには、[追加] をクリックしてタグキーを追加します。 説明
一度に最大 20 個のタグペアを追加できます。 |
type |
| Value |
string |
任意 |
タグ値。ターゲットクラスターに複数のタグを同時に追加するには、[追加] をクリックしてタグ値を追加します。 説明
一度に最大 20 個のタグペアを追加できます。 |
test |
| ServerlessType |
string |
任意 |
サーバーレスタイプ。値を AgileServerless (アジャイル) に設定します。 説明
このパラメーターはサーバーレスクラスターでのみサポートされています。 |
AgileServerless |
| ScaleMin |
string |
任意 |
シングルノードの最小値スケーリング制限。有効な値: 1 PCU~31 PCU。 説明
このパラメーターはサーバーレスクラスターでのみサポートされています。 |
1 |
| ScaleMax |
string |
任意 |
シングルノードの最大値スケーリング制限。有効な値: 1 PCU~32 PCU。 説明
このパラメーターはサーバーレスクラスターでのみサポートされています。 |
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 |
任意 |
Binlog 機能を有効にするかどうかを指定します。有効な値:
説明
このパラメーターは、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。 説明
最大値は 32000 です。 |
800 |
| ProvisionedIops |
integer |
任意 |
|
1000 |
| BurstingEnabled |
string |
任意 |
ESSD AutoPL クラウドディスクの I/O バースト機能を有効にするかどうかを指定します。有効な値:
説明
このパラメーターは、StorageType が ESSDAUTOPL に設定されている場合にのみサポートされています。 列挙値:
|
false |
| TargetMinorVersion |
string |
任意 |
対象のマイナーバージョン。 |
8.0.1.1.54 |
| StorageEncryption |
boolean |
任意 |
クラウドディスク暗号化を有効にするかどうかを指定します。有効な値:
説明
このパラメーターは、DBType が MySQL にセットされている場合にのみ効果があります。 説明
このパラメーターは、StorageType が Standard Edition のストレージタイプにセットされている場合にのみ効果があります。 |
|
| StorageEncryptionKey |
string |
任意 |
インスタンスと同じリージョンにあるクラウドディスク暗号化用のカスタム暗号鍵の ID。このパラメーターを指定すると、クラウドディスク暗号化が自動的に有効になり、無効にすることはできません。クラウドディスク暗号化にデフォルトのサービスキーを使用する場合は、このパラメーターを空にします。 キー ID は KMS コンソールで確認するか、新しいキーを作成できます。 説明
このパラメーターは、DBType が MySQL にセットされている場合にのみ効果があります。 説明
このパラメーターは、StorageType が Standard Edition のストレージタイプにセットされている場合にのみ効果があります。 |
1022xxxxxxxx |
| SourceUid |
integer |
任意 |
アカウント間バックアップ復元シナリオで、ソースバックアップセットを所有するアカウントの UID。 |
1022xxxxxxxx |
| CloudProvider |
string |
任意 |
インスタンスが属するクラウドサービスプロバイダー。 |
ENS |
| EnsRegionId |
string |
任意 |
エッジノードサービス (ENS) ノードの ID。このパラメーターは、ENS データベースを作成するときに必須です。 |
vn-hanoi-3 |
| AutoUseCoupon |
boolean |
任意 |
クーポンを自動的に使用するかどうかを指定します。有効な値:
|
true |
| PromotionCode |
string |
任意 |
クーポンコード。このパラメーターを指定しない場合、デフォルトのクーポンが使用されます。 |
727xxxxxx934 |
| AgenticDbType |
string |
任意 |
Agentic データベースエンジンタイプ。有効な値:
|
dedicated |
| AgenticDbClusterId |
string |
任意 |
Agentic クラスターの ID。 |
pagc-****** |
| AgenticDbClusterDescription |
string |
任意 |
Agentic クラスターの説明。 |
pagc-****** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| DBClusterId |
string |
クラスターの ID。 |
pc-bp1s826a1up****** |
| OrderId |
string |
注文の ID。 |
211454967****** |
| RequestId |
string |
リクエストの ID。 |
E56531A4-E552-40BA-9C58-137B80****** |
| ResourceGroupId |
string |
リソースグループの ID。 |
rg-*************** |
| AgenticDbClusterId |
string |
Agentic クラスターの ID。 |
pagc-*************** |
| AgenticDbClusterDescription |
string |
Agentic クラスターの説明。 |
pagc-*************** |
例
成功レスポンス
JSONJSON
{
"DBClusterId": "pc-bp1s826a1up******",
"OrderId": "211454967******",
"RequestId": "E56531A4-E552-40BA-9C58-137B80******",
"ResourceGroupId": "rg-***************",
"AgenticDbClusterId": "pagc-***************",
"AgenticDbClusterDescription": "pagc-***************"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidBackupRetentionPolicyOnClusterDeletion.Malformed | The specified BackupRetentionPolicyOnClusterDeletion is invalid. | 現在の BackupRetentionPolicyOnClusterDeletion パラメーターが無効です。 |
| 400 | InvalidLowerCaseTableNames.Malformed | The specified LowerCaseTableNames is invalid. | 指定されたテーブル名の大文字小文字の秘密度パラメーター (LowerCaseTableNames) は無効です。 |
| 400 | InvalidDefaultTimeZone.Malformed | The specified DefaultTimeZone is invalid. | 指定されたデフォルトのタイムゾーンパラメーター (DefaultTimeZone) はエラーです。 |
| 400 | Location.FailedGetSubDomain | The specified regionId does not match the zoneId or the zoneId does not exist. | 指定されたリージョン ID がゾーン ID と一致しないか、ゾーン ID が存在しません。 |
| 400 | MissParameter.GDNId | The GDNId parameter is required. | GDNId パラメーターは必須です。 |
| 400 | EntityNotExist.ResourceGroup | The resource group does not exist.. | リソースグループが存在しません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。