機能説明
このAPIは、OceanBaseクラスタインスタンスのリソース仕様を変更するために使用されます。ノード数、CPU、メモリ、ディスク容量などの設定が含まれます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/spec
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースインスタンスID。 | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Header
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | string | はい | プロジェクトID。 | hxq3ztx3377nby3v87ry**** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceClass | string | はい | OceanBaseクラスタインスタンス仕様。 | 8C32GB |
| diskSize | integer | いいえ | OceanBaseクラスタのディスクサイズ。 | 150 |
| dryRun | Boolean | はい | プリフライトチェックを実行するかどうかを示します。 | true |
実行結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | クラスタ情報。 | |
| orderId | string | 注文ID。 | NL25******** |
| instanceId | string | インスタンスID。 | ob******** |
| dryRun | Boolean | プリフライトチェックを実行するかどうかを示します。 | NL25******** |
| dryRunResult | Boolean | プリフライトチェックの結果 | NL25******** |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X PUT \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/spec?requestId={requestId}' \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}' \
-H 'Content-Type: application/json' \
--data '{
"instanceClass": "8C32GB",
"diskSize": 150,
"dryRun": true
}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理 を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
実行結果例
JSON形式
{
"data": {
"instanceId": "ob********",
"orderId": "NL25********"
},
"requestId": "f257f51e-****-****-8fba-ec1b9554cc78",
"success": true
}