ウェアハウスのスケールアップまたはスケールダウン
ウェアハウスをスケールアップまたはスケールダウンします。
注意
この操作には、クラスタの変更権限が必要です。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://cloud-api.celerdata.com/api/1.0/warehouses/:warehouse_id/scale-size |
| HTTP メソッド | POST |
| 頻度 | 600/分 |
パス変数
| パラメーター | 例 | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| warehouse_id | ff09d6ac-b821-447d-b4c1-59167d022c8b | はい | String | ウェアハウスのIDです。 |
ヘッダーパラメータ
| パラメータ | 例 | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| Authorization | Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY | はい | String | CelerData Cloud BYOC API にアクセスするためのアクセストークン。フォーマット: Bearer <access_token>。 |
アクセストークンの取得 を参照してください。
リクエストボディ
| パラメータ | 例 | 必須 | タイプ | 説明 |
|---|---|---|---|---|
| vm_cate | 6 | はい | INT | スケールアウト先のノード(仮想マシン)のタイプ。サポートされているインスタンスタイプについては、サポートされているインスタンスタイプ を参照してください。 |
| iops | 5000 | いいえ | INT | スケールアウト先のノード(仮想マシン)上のクラウドストレージディスクの IOPS。この項目は、ローカルストレージを備えたインスタンスからクラウドストレージを備えたインスタンスへノードをスケールする場合にのみ有効です。 |
| throughput | 400 | いいえ | INT | スケールアウト先のノード(仮想マシン)上のクラウドストレージディスクのスループット。この項目は、ローカルストレージを備えたインスタンスからクラウドストレージを備えたインスタンスへノードをスケールする場合にのみ有効です。 |
| vm_vol_size | 100 | いいえ | INT | スケールアウト先のノード(仮想マシン)上の各クラウドストレージディスクの容量。単位:GB。この項目は、ローカルストレージを備えたインスタンスからクラウドストレージを備えたインスタンスへノードをスケールする場合にのみ有効です。 |
| vm_vol_num | 2 | いいえ | INT | スケールアウト先のノード(仮想マシン)上のクラウドストレージディスクの数。この項目は、ローカルストレージを備えたインスタンスからクラウドストレージを備えたインスタンスへノードをスケールする場合にのみ有効です。 |
例:
{
"vm_cate": "m6i.4xlarge",
"iops": 5000,
"throughput": 400,
"vm_vol_size": 100,
"vm_vol_num": 2
}
レスポンス
サンプルレスポンス
{
"code": 20000,
"data": {
"action_id": "9d71aae6-a35da-40d5-b213-27bb1f57ifj5"
}
}
レスポンス要素
| パラメータ | 例 | タイプ | 説明 |
|---|---|---|---|
| code | 20000 | Integer | エラーコード。エラーコードが 20000 の場合、リクエストは成功しました。それ以外のエラーコードが返された場合、リクエストは失敗しました。 |
| data | - | Object | API 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。以下の要素を含みます: action_id。 |
| data.action_id | - | String | アクションの ID。 |
| message | - | String | エラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。 |
関連情報
ウェアハウスのスケーリングには数分かかる場合があります。前述の API 呼び出しを行った後、ウェアハウス操作ステータスのクエリ に記載されている手順に従ってアクションのステータスをクエリできます。