Help Center> Cloud Search Service> API Reference> APIs Related to Cluster Management> Querying the List of Clusters
View PDF

Querying the List of Clusters

Function

This API is used to query and display the cluster list and cluster status.

URI

GET /v1.0/{project_id}/clusters
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining the Project ID and Account ID.

start

No

Integer

Start value of the query. The default value is 1, indicating that the query starts from the first cluster.

limit

No

Integer

Number of clusters to be queried. The default value is 10, indicating that 10 clusters are queried at a time.

Request

None

Response

Table 2 describes the response parameters.

Table 2 Parameter description

Parameter

Type

Description

clusters

Array of clusters objects

List of cluster objects.

updated

String

Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

name

String

Cluster name.

created

String

Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

NOTE:

The returned cluster list is sorted by creation time in descending order. Specifically, the cluster with the latest creation time is at the top.

id

String

Cluster ID.

status

String

Return value.

  • 100: The cluster is being created.
  • 200: The cluster is available.
  • 303: The cluster is unavailable.

endpoint

String

Indicates the IP address and port number of the user used to access the VPC.

actionProgress

Object

Cluster operation progress, which indicates the progress of cluster creation and expansion in percentage. CREATING specifies the progress of creation.

actions

Array of strings

Current behavior on a cluster. Value REBOOTING indicates that the cluster is being restarted, GROWING indicates that capacity expansion is being performed on the cluster, RESTORING indicates that the cluster is being restored, and SNAPSHOTTING indicates that the snapshot is being created.

failed_reasons

Object

Failure cause. If the cluster is in the Available state, this parameter is not returned. For details, see Table 6.

vpcId

String

VPC ID.

subnetId

String

Subnet ID.

securityGroupId

String

Security group ID.

enterprise_project_id

String

ID of the enterprise project to which a cluster belongs.

If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.

tags

Array of tag objects

Tags in a cluster.
Table 3 clusters field data structure description

Parameter

Type

Description

datastore

Object

Type of the data search engine. For details, see Table 4.

instances

Array of instance objects

List of node objects.
Table 4 datastore field data structure description

Parameter

Type

Description

type

String

Supported type: elasticsearch

version

String

Engine version number. The current engine version is 5.5.1, 6.2.3, 6.5.4, or 7.1.1.
Table 5 instances field data structure description

Parameter

Type

Description

type

String

Supported type: ess (indicating the Elasticsearch node)

id

String

Instance ID.

name

String

Instance name.

status

String

Instance state.

  • 100: The instance is being created.
  • 200: The instance is available.
  • 303: The instance is unavailable.
Table 6 failed_reasons field data structure description

Parameter

Type

Description

error_code

String

Error code.

  • CSS.6000: indicates that a cluster fails to be created.
  • CSS.6001: indicates that a cluster fails to be scaled out.
  • CSS.6002: indicates that a cluster fails to be restarted.
  • CSS.6004: indicates that a node fails to be created in a cluster.
  • CSS.6005: indicates that the service fails to be initialized.

error_msg

String

Detailed error information.
Table 7 tags field data structure description

Parameter

Type

Description

key

String

Tag key.

value

String

Tag value.

Examples

  • Example request
    • Example request of querying all clusters 
      GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters
    • Example request of querying clusters by page

      Example 1: Query the first two clusters.

      Method 1

      GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=2
      Method 2 
      GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2

      Example 2: Query the first 10 clusters.

      Method 1 
      GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10
      Method 2 
      GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1
  • Example response 
    {
  "clusters": [
    {
      "datastore": {
        "type": "elasticsearch",
        "version": "5.5.1"
      },
      "instances": [
        {
          "status": "200",
          "type": "ess",
          "id": "a8922be2-5e41-4cd1-8486-630c04c2d1e3",
          "name": "ES-new1-ess-esn-1-1"
        }
      ],
      "updated": "2017-11-27T10:36:18",
      "name": "ES-new1",
      "created": "2017-11-27T10:36:18",
      "id": "306e5597-d7a9-4cbe-866c-33428440d0e3",
      "status": "200",
      "endpoint": "192.168.0.219:9200",
      "actionProgress": {
      "CREATING": "5%"
      },
      "actions": [],
      "enterprise_project_id":"3e1c74a0-86a0-40e9-bdc9-c6b9e46cf81b"
      "tags": []
    },
    {
      "datastore": {
        "type": "elasticsearch",
        "version": "5.5.1"
      },
      "instances": [
        {
          "status": "200",
          "type": "ess",
          "id": "9635de45-895c-45e1-ba0b-d9f497c8ce52",
          "name": "Es-Test1-ess-esn-1-1"
        }
      ],
      "updated": "2017-11-14T12:32:00",
      "name": "Es-Test1",
      "created": "2017-11-14T12:32:00",
      "id": "c99b1514-647e-4418-8b6d-2748255f2f95",
      "status": "200",
      "endpoint": "192.168.0.127:9200",
      "actionProgress": {},
      "actions": [
        "REBOOTING"
      ],
      "enterprise_project_id":"0",
      "tags": [
               {
                "key": "k1",
                "value": "v1"
               },
               {
                "key": "k2",
                "value":"v2"
               }
              ]
    }
  ]
}

Status Code

Table 8 describes the status code.

Table 8 Status code

Status Code

Code

Status Code Description

400

BadRequest

Invalid request.

The client should not repeat the request without modifications.

404

NotFound

The requested resource cannot be found.

The client should not repeat the request without modifications.

200

OK

The request is processed successfully.