ウェアハウスの一時停止
ウェアハウスを一時停止します。
注意
- この操作には、Suspend & resume cluster 権限が必要です。
- デフォルトのウェアハウスは一時停止または再開できません。
リクエスト
基本情報 | |
---|---|
HTTP URL | https://cloud-api.celerdata.com/api/1.0/warehouses/:warehouse_id/suspend |
HTTP メソッド | PATCH |
頻度 | 600/分 |
パス変数
パラメータ | 例 | 必須 | タイプ | 説明 |
---|---|---|---|---|
warehouse_id | ff09d6ac-b821-447d-b4c1-59167d022c8b | はい | String | ウェアハウスのIDです。 |
ヘッダーパラメータ
パラメータ | 例 | 必須 | タイプ | 説明 |
---|---|---|---|---|
Authorization | Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY | はい | String | CelerData Cloud BYOC API にアクセスするためのアクセストークンです。形式: Bearer <access_token> 。 |
アクセストークンの取得 を参照してください。
レスポンス
サンプルレスポンス
{
"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 コールを行った後、ウェアハウスのクエリ の指示に従ってウェアハウスのステータスを確認できます。