クラスターの一覧

CelerData Cloud BYOC アカウント内のすべてのクラスターを一覧表示します。

リクエスト

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

ヘッダーのパラメーター

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

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

レスポンス

サンプルレスポンス

{
    "code": 20000,
    "data": {
        "total": 2,
        "list": [
            {
                "cluster_id": "ec7faafa-e155-4ae0-bccc-57b3c5f3b0fa",
                "cluster_name": "test1",
                "cluster_version": "3.3.9-ee",
                "cluster_type": "classic",
                "deleted": false
            },
            {
                "cluster_id": "d517c508-a2ef-4318-9f97-484f66028177",
                "cluster_name": "test2",
                "cluster_version": "3.4.1",
                "cluster_type": "elastic",
                "deleted": false
            }
        ]
    }
}

レスポンス要素

パラメーター	例	タイプ	説明
code	20000	Integer	エラーコード。エラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。data オブジェクトは、total と list の要素で構成されています。
data.total	-	Integer	アカウント内のクラスターの総数。
data.list	-	Array	アカウント内のクラスターの詳細を含む 1 つ以上のオブジェクトの配列。
data.list[0]	-	Object	オブジェクトとして提示されるクラスターの詳細。各オブジェクトは、cluster_id と cluster_name の要素で構成されています。
data.list[0].cluster_id	-	String	クラスターの ID。
data.list[0].cluster_name	-	String	クラスターの名前。
data.list[0].cluster_version	-	String	クラスターのバージョン。
data.list[0].cluster_type	-	String	クラスターのタイプ。classic または elastic のいずれか
data.list[0].deleted	-	Boolean	クラスターの削除状態。