ウェアハウスのクエリ

特定のウェアハウスをクエリします。

注意

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

リクエスト

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

パス変数

パラメーター	例	必須	タイプ	説明
warehouse_id	ff09d6ac-b821-447d-b4c1-59167d022c8b	はい	String	ウェアハウスのIDです。

ヘッダーパラメーター

パラメーター	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	CelerData Cloud BYOC API にアクセスするためのアクセストークンです。フォーマット: Bearer <access_token>。

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

レスポンス

サンプルレスポンス

{
    "code": 20000,
    "data": {
        "warehouse_id": "ff09d6ac-b821-447d-b4c1-59167d022c8b",
        "warehouse_name": "test",
        "node_count": 2,
        "state": "SUSPENDED",
        "is_default": false
    }
}

レスポンス要素

パラメーター	例	タイプ	説明
code	20000	Integer	エラーコードです。エラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API コールの結果です。データオブジェクトは、いくつかの API アクションでは返されない場合があります。ウェアハウス情報のオブジェクトを返します。
data.warehouse_id	-	String	ウェアハウスのIDです。
data.warehouse_name	-	String	ウェアハウスの名前です。
data.node_count	-	Integer	ウェアハウス内のコンピュートノードの数です。
data.state	-	String	ウェアハウスのステータスです。有効な値: CREATING RUNNING SUSPENDED STOP ERROR
data.is_default	true	Boolean	ウェアハウスがデフォルトのウェアハウスかどうかです。
message	-	String	エラーメッセージです。この要素は、返された code が 20000 でない場合にのみ返されます。 注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。