OceanBase Cloud

PDF をダウンロード

CreateInstance - クラスタの作成

最終更新:2026-09-23 11:03:36

機能の概要

このAPIは、OceanBaseクラスタインスタンスを作成するために使用されます。

注意

クラスタインスタンス作成APIが正常に呼び出されると、対応するアカウントから料金が引き落とされます。料金の詳細については、課金の概要を参照してください。

呼び出しの説明

API制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。

リクエストパス

POST /api/v2/instances

リクエストパラメータ

名前	型	必須	説明	例値
X-Ob-Project-Id	string	はい	プロジェクトID。	hxq3ztx3377nby3v87ry****

Query

名前	型	必須	説明	例値
requestId	string	はい	追跡用のリクエストID。	dc302d76-66b5-48d8-ab53-a035********

Body

名前	型	必須	説明	例値
chargeType	String	いいえ、省略した場合はデフォルトで "PostPay" になります	インスタンスの支払い方法。現在はPostPayのみサポートしています：従量課金（デフォルトは時間単位で課金されます）。	PostPay
cloudProvider	String	はい	クラウドプロバイダ： Alibaba Cloud：ALIYUN AWS：AWS Huawei Cloud：HUAWEI GCP：GCP	ALIYUN
diskSize	Integer	はい	ストレージ容量。単位はGiBです。ストレージ容量の制限はクラスタ仕様によって異なり、詳細は以下のとおりです： 8C16GiB:50～2500GiB 8C32GiB：100～10000GiB 16C32GiB:100～10000GiB 16C70GiB：200～20000GiB 32C70GiB：200～10000GiB 32C180GiB：400～40000GiB 64C180GiB：400～20000GiB 64C400GiB：800～80000GiB	100
region	String	はい	インスタンスが属するリージョン。	cn-shanghai
obVersion	String	はい	OceanBase Serverのバージョン番号。4.2.1のように、ドットで区切られた3つの数値からなるバージョン番号のみをサポートします。	4.2.1
zones	String	はい	インスタンスが属するゾーンIDです。複数のゾーンIDを入力すると、作成するインスタンスにいくつのゾーンがあるか（データセンターの数も表す）を示します。複数のゾーンを入力する場合は、カンマで区切り、重複しないようにしてください。 1つを入力する：単一データセンター構成。 2つを入力する：デュアルデータセンター構成。 3つを入力する：マルチデータセンター構成。	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
instanceClass	String	はい	クラスタ仕様情報。現在、以下のプランをサポートしています： 4C16GB 8C16GB 8C32GB 16C32GB 16C70GB 32C70GB 32C180GB 64C180GB 64C400GB	16C70GB
replicaMode	String	はい	フル機能レプリカの数。zonesフィールドと一致させて入力してください。3ゾーン（マルチデータセンター）構成では、フル機能レプリカ数は3つのみ指定できます。2ゾーン（デュアルデータセンター）構成では、フル機能レプリカ数は2つのみ指定できます。1ゾーン（単一データセンター）構成では、フル機能レプリカは2つまたは3つサポートされ、デフォルトは2つです。 3：3つのフル機能レプリカを意味します。 2：2つのフル機能レプリカを意味します。	3
dryRun	Boolean	いいえ	このリクエストの事前チェックのみを行うかどうかを指定します。デフォルトはfalseです。値の範囲： true：チェックリクエストを送信しますが、インスタンスは作成しません。チェックに合格した場合はDryRunResult=trueを返し、不合格の場合は対応するエラーコードを返します。 false（デフォルト）：通常のリクエストを送信し、チェックに合格した後、直接インスタンスを作成します。falseの場合、事前チェックは行いません。 DryRunResultはデフォルトでfalseを返します。	false
saleChannel	String	いいえ。デフォルト値は、中国向けが domestic、中国国外向けが overseas です。	注文チャネル。デフォルトは直営チャネルです。説明現在、normandyチャネルからの注文のみをサポートしています。 overseas：グローバル直営チャネル normandy_domestic：normandyチャネル aliyun_domestic：Alibaba Cloud中国サイト huawei_mp_domestic：Huawei Cloud中国サイト aws_mp_domestic：AWS中国サイト aws-mp：AWS Marketplace aliyun_overseas：Alibaba Cloudグローバルサイト aliyun_common_mp_overseas：Alibaba Cloudグローバルマーケットプレイス	normandy_domestic
instanceType	String	いいえ	インスタンスタイプ。デフォルトはCLUSTERです。値の範囲： CLUSTER：TPクラスタインスタンス KV_CLUSTER: KVクラスタインスタンス ANALYTICAL_CLUSTER：APクラスタインスタンス	CLUSTER
instanceName	String	いいえ	長さは2～64文字で、数字、英字、アンダースコア、ハイフンのみ含めることができます。	xxx_test
storageArchitecture	String	いいえ	ストレージアーキテクチャ。現在、standardStorageのみサポートしています：コンピュート・ストレージ一体型。	standardStorage
diskType	String	いいえ	ディスクタイプ。
storageDiskType	String	いいえ	ストレージディスクタイプ。

レスポンス

名称	型	説明	サンプル値
success	boolean	リクエストが成功したかどうか。	true/false
data	Object	注文情報。
data.orderId	String	注文ID。	NL240919********
data.instanceId	String	インスタンスID。	ob677efwh8********
data.dryRunResult	boolean	dryRunが合格したかどうか。合格した場合はtrue、不合格の場合は対応するエラーメッセージを返します。	TRUE
requestId	String	trace	dc302d76-66b5-48d8-ab53-a035********（64ビット）
errorCode	String	エラーコード	Params.InstanceName.Invalid
errorMessage	String	エラーメッセージ	クラスタ名の検証に失敗しました

例

リクエスト例

curl --request POST \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances?requestId={requestId}' \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}' \
-H 'Content-Type: application/json' \
--data '{
    "cloudProvider": "ALIYUN",
    "diskSize": 100,
    "region": "cn-shanghai",
    "obVersion": "4.2.1",
    "zones": "cn-shanghai-e",
    "instanceClass": "4C16GB",
    "replicaMode": "3",
    "saleChannel": "normandy_domestic",
    "instanceType": "CLUSTER",
    "chargeType": "PostPay",
    "instanceName": "test_instance_name",
    "dryRun": true
}'

説明

プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。

レスポンス例

リクエストが成功した場合の応答例（dryRunがfalseの場合）：

{
    "data": {
        "instanceId": "ob677efwh8********",
        "orderId": "ND241030********"
    },
    "requestId": "cf97d046-5200-4870-8007-ee35********",
    "success": true
}

リクエストが成功した場合の応答例（dryRunがtrueの場合）：

{
    "data": {
        "dryRunResult": true
    },
    "requestId": "dc302d76-66b5-48d8-ab53-a035********",
    "success": true
}

リクエストが失敗した場合の応答例：

{
    "errorCode": "Params.InstanceName.Invalid",
    "errorMessage": "クラスタ名の検証に失敗しました",
    "requestId": "cb32942e-bdf2-4d85-a26f-6bf8********",
    "success": false
}

前のトピック

DescribeInstance - クラスタ情報の取得

次のトピック

DeleteInstance - クラスタの削除