適用対象の説明
現在のバージョンでは、スタンバイクラスタでのデータベース作成はサポートされていません。
機能の概要
このAPIは、指定されたテナント内に新しいデータベースを作成するために使用します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/databases
リクエストパラメータ
Query
プロパティ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースのインスタンスIDです。 | ob317v4uif**** |
| tenantId | string | はい | テナントIDです。 | ob2mr3oae0**** |
Body
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
| databaseName | string | はい | データベース名。testやmysqlなどの予約語は使用できません。 | databasetest |
| encoding | string | はい | データベースのエンコーディング方式。現在、utf8mb4とgbkエンコーディングをサポートしています。 | utf8mb4 |
| collation | string | いいえ | データベースの照合順序。 | utf8mb4_general_ci |
| description | string | いいえ | データベースの説明情報。 | this is a test database |
| requestId | string | いいえ | リクエストID。再実行防止の制御に使用されます。 | req-20231012094530-001 |
戻り値
名前 |
型 |
説明 |
|---|---|---|
| data | object | データベース情報。 |
| success | boolean | リクエストが成功したかどうかを示します。 |
例
リクエスト例
curl -v --request POST \
--digest -u '<あなたの AK:SK>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/databases' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
--data '{"instanceId":"ob4ioyiw82yhuo","tenantId":"t4ismze9nltds","databaseName":"databasetest","encoding":"utf8mb4","collation":"utf8mb4_general_ci","description":"this is a test database","requestId":"req-20231012094530-001"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {},
"success": true
}