List clusters

Lists all clusters in a CelerData Cloud BYOC account.

Request

Basic information
HTTP URL	https://cloud-api.celerdata.com/api/1.0/clusters
HTTP method	GET
Frequency	600/minute

Header parameters

Parameter	Example value	Required	Type	Description
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	Yes	String	The access token used to access the CelerData Cloud BYOC API. Format: Bearer <access_token>.

See Obtain access token.

Response

Sample response

{
    "code": 20000,
    "data": {
        "total": 2,
        "list": [
            {
                "cluster_id": "ec7faafa-e155-4ae0-bccc-57b3c5f3b0fa",
                "cluster_name": "test1"
            },
            {
                "cluster_id": "d517c508-a2ef-4318-9f97-484f66028177",
                "cluster_name": "test2"
            }
        ]
    }
}

Response elements

Parameter	Example value	Type	Description
code	20000	Integer	The error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data	-	Object	The result of the API call. The data object may not be returned for some API actions. It consists of the following elements: total and list.
data.total	-	Integer	The total number of clusters in the account.
data.list	-	Array	An array of one or more objects, each of which consists of the details of the clusters in the account.
data.list[0]	-	Object	The details of a cluster presented as an object. Each object consists of the following elements: cluster_id and cluster_name.
data.list[0].cluster_id	-	String	The ID of the cluster.
data.list[0].cluster_name	-	String	The name of the cluster.