機能説明
このAPIは、クラスタノード数を変更するために使用します。変更後の設定が有効になるまでには、一定の時間がかかる場合があります。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/nodeNum
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Header
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | hxq3ztx3377nby3v87ry**** |
Body
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| nodeNum | integer | はい | 対象ノードサイズ。値の範囲は3～60で、3の倍数である必要があります。
説明デフォルトの最大値は60です。60を超える必要がある場合は、OB Cloudデータベースのテクニカルサポートにお問い合わせください。 |
1-1-1構成から2-2-2構成への変更では、入力値は6です |
| dryRun | boolean | いいえ | プリフライトチェックを行うかどうかを示します。デフォルト値：false。
|
true |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | Object | 注文情報 | |
| data.instanceId | String | インスタンスID | obxxx |
| data.orderId | String | 注文ID | NL2409******** |
| data.dryRunResult | Boolean | プリフライトチェックの結果。合格した場合はtrueを返し、不合格の場合はerrorCodeとerrorMessageを返します。 | - |
| errorCode | String | エラーコード | - |
| errorMessage | String | エラーメッセージ | - |
例
リクエスト例
curl --request PUT \
--digest -u '<Your AK:SK>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/nodeNum?requestId={requestId}' \
-H 'X-Ob-Project-Id: {X-Ob-Project-Id}' \
-H 'Content-Type: application/json' \
--data '{"nodeNum": 6, "dryRun": false}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDが指定されたプロジェクトIDと一致していることを確認してください。
レスポンス例
JSON形式
リクエストが成功した場合のレスポンス例。dryRunはtrueです。
{
"success": true,
"requestId": "cb32942e-bdf2-4d85-a26f-6bf871e189a9",
"data": {
"orderId": "NL2409********",
"instanceId": "obxxx"
}
}
リクエストが失敗した場合のレスポンス例。dryRunはtrueです。
{
"errorCode": "Privilege.OpenAPI.AuthFailed",
"errorMessage": "OpenAPI認証失敗",
"requestId": "cb32942e-bdf2-4d85-a26f-6bf871e189a9",
"success": false
}