edit-icon download-icon

View a cluster

Last Updated: Apr 09, 2018


View the cluster details according to the cluster ID.

Request information

Request line (RequestLine)

  1. GET /clusters/{cluster_id} HTTP/1.1

Request line parameter (URI Param)

Name Type Required Description
cluster_id string Yes The cluster ID.

Special request header (RequestHead)

None. See Public request headers.

Request body (RequestBody)


Response information

Response line (ResponseLine)

  1. HTTP/1.1 200 OK

Special response header (ResponseHead)

None. See Public response headers.

Response body (ResponseBody)

  1. {
  2. "agent_version": "string",
  3. "cluster_id": "string",
  4. "created": "datetime",
  5. "external_loadbalancer_id": "string",
  6. "master_url": "string",
  7. "name": "string",
  8. "network_mode": "string",
  9. "region_id": "string",
  10. "security_group_id": "string",
  11. "size": "numbers",
  12. "state": "string",
  13. "updated": "datetime",
  14. "vpc_id": "string",
  15. "vswitch_id": "string"
  16. }

Response body explanation

Cluster format

Name Type Description
agent_version string The Agent version.
cluster_id string The cluster ID, which is the unique identifier of the cluster.
created string The created time of the cluster.
external_loadbalancer_id string The Server Load Balancer instance ID of the cluster.
master_url string The master address of the cluster, which is used to connect to the cluster to perform operations. For more information, see Connect to a cluster by using Docker tools.
name string The cluster name, which is specified when you create the cluster and is unique for each account.
network_mode string The network mode of the cluster (Classic or Virtual Private Cloud (VPC)).
region_id string The ID of the region in which the cluster resides. For more information, see Regions.
security_group_id string The security group ID.
size string The number of nodes.
state string The cluster status. For more information, see Cluster lifecycle.
updated string Last updated time.
vpc_id string VPC ID.
vswitch_id string VSwitch ID.


Request example

  1. GET /clusters/C5b5e80b0b64a4bf6939d2d8fbbc5ded7 HTTP/1.1
  2. <Public request headers>

Return example

  1. HTTP/1.1 200 Ok
  2. <Public response header>
  3. {
  4. "agent_version": "0.5-e56dab3",
  5. "cluster_id": "c978ca3eaacd3409a9437db07598f1f69",
  6. "created": "2015-12-11T03:52:40Z",
  7. "external_loadbalancer_id": "1518f2b7e4c-cn-beijing-btc-a01",
  8. "master_url": "",
  9. "name": "my-python-cluster-039de960",
  10. "network_mode": "classic",
  11. "region_id": "cn-beijing",
  12. "security_group_id": "sg-25yqjuxhz",
  13. "size": 5,
  14. "state": "running",
  15. "updated": "2015-12-15T15:01:58Z",
  16. "vpc_id": "",
  17. "vswitch_id": ""
  18. }
Thank you! We've received your feedback.