メインコンテンツまでスキップ

ウェアハウスを一覧表示

弾力的なクラスター内のすべてのウェアハウスを一覧表示します。

注意

この操作には、クラスターの表示権限が必要です。

リクエスト​

基本情報
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/warehouses
HTTP メソッドGET
頻度600/分

パス変数​

パラメータ例必須タイプ説明
cluster_id9d71aae6-a35d-40d5-b213-27bb1f583be5はいStringクラスターの ID。

ヘッダーパラメータ​

パラメータ例必須タイプ説明
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYはいStringCelerData Cloud BYOC API にアクセスするために使用されるアクセストークン。形式: Bearer <access_token>。

アクセストークンを取得 を参照してください。

レスポンス​

サンプルレスポンス​

{
    "code": 20000,
    "data": {
        "total": 2,
        "list": [
            {
                "warehouse_id": "ecace730-9d53-4f56-ac9d-7d034c662082",
                "warehouse_name": "default_warehouse",
                "node_count": 2,
                "state": "SUSPENDED",
                "is_default": true
            },
            {
                "warehouse_id": "ff09d6ac-b821-447d-b4c1-59167d022c8b",
                "warehouse_name": "test",
                "node_count": 2,
                "state": "SUSPENDED",
                "is_default": false
            }
        ]
    }
}

レスポンス要素​

パラメータ例タイプ説明
code20000Integerエラーコード。エラーコードが 20000 の場合、リクエストは成功しました。それ以外のエラーコードが返された場合、リクエストは失敗しました。
data-ObjectAPI 呼び出しの結果。特定の API アクションでは data オブジェクトが返されない場合があります。ウェアハウス情報のオブジェクトを返します。
data.total-Integerクラスター内のウェアハウスの総数。
data.list-Array特定のウェアハウスの情報の配列。
data.list.warehouse_id-Stringウェアハウスの ID。
data.list.warehouse_name-Stringウェアハウスの名前。
data.list.node_count-Integerウェアハウス内のコンピュートノードの数。
data.list.state-Stringウェアハウスの状態。 有効な値:
  • CREATING
  • RUNNING
  • SUSPENDED
  • STOP
  • ERROR
data.list.is_defaulttrueBooleanウェアハウスがデフォルトのウェアハウスかどうか。
message-Stringエラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。
注意
リクエストが成功したか失敗したかを message の返り値で判断しないでください。