Querying the Cluster List¶
Function¶
This API is used to query and display the cluster list and cluster status.
URI¶
GET /v1.0/{project_id}/clusters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Parameter description: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: Letters and digits Default value: N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
start | No | Integer | Parameter description: The start value of the query. The default value is 1, indicating that the query starts from the first cluster. Constraints: N/A Options: 1-1000 Default value: 1 |
limit | No | Integer | Parameter description: Number of clusters to be queried. The default value is 10, indicating that the information about 10 clusters is queried at a time. Constraints: N/A Options: 1-1000 Default value: 10 |
datastoreType | No | String | Parameter description: Cluster engine type. Constraints: N/A Options: elasticsearch, logstash, or opensearch. Default value: elasticsearch. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
totalSize | Integer | Number of clusters |
clusters | Array of ClusterList objects | List of cluster objects. |
Parameter | Type | Description |
|---|---|---|
datastore | ClusterListDatastore object | Search engine. |
instances | Array of ClusterListInstances objects | List of node objects. |
publicKibanaResp | publicKibanaRespBody object | Kibana public network access information. |
elbWhiteList | elbWhiteListResp object | EIP whitelist. |
updated | String | Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss. |
name | String | Cluster name |
publicIp | String | Public IP address information. |
created | String | Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss. The returned cluster list is sorted by creation time in descending order. The latest cluster is displayed at the top. |
id | String | Cluster ID. |
status | String | Cluster status.
|
endpoint | String | IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white) |
vpcId | String | ID of a VPC. |
subnetId | String | Subnet ID. |
securityGroupId | String | Security group ID. |
bandwidthSize | Integer | Public network bandwidth. Unit: Mbit/s |
httpsEnable | Boolean | Communication encryption status.
|
authorityEnable | Boolean | Whether to enable authentication.
|
diskEncrypted | Boolean | Whether disks are encrypted.
|
backupAvailable | Boolean | Whether the snapshot function is enabled.
|
actionProgress | Object | Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage. CREATING indicates the progress of creation. |
actions | Array of strings | Current behavior of a cluster. REBOOTING indicates that the cluster is being restarted. GROWING indicates that the cluster is being scaled. RESTORING indicates that the cluster is being restored. SNAPSHOTTING indicates that a snapshot is being created. |
enterpriseProjectId | String | ID of the enterprise project that a cluster belongs to. If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned. |
tags | Array of ClusterListTags objects | Cluster tag. |
failedReason | ClusterListFailedReasons object | Failure cause. If the cluster is in the available status, this parameter is not returned. |
bandwidthResourceId | String | ID of the resource accessed from the ES public network |
ipv6Endpoint | String | IPv6 address and port number accessible from the cluster's private network. |
Parameter | Type | Description |
|---|---|---|
type | String | Engine type. Its value can be elasticsearch or logstash. |
version | String | Version of the CSS cluster engine. For details, see the supported versions in Before You Start. |
supportSecuritymode | Boolean | Whether the security mode is supported. |
subVersion | String | Cluster image version. |
isEosCluster | Boolean | Whether the cluster image version has reached EOS. The value can be true or false. |
Parameter | Type | Description |
|---|---|---|
status | String | Node status.
|
type | String | Type of the current node. |
id | String | Instance ID. |
name | String | Instance name. |
specCode | String | Node specifications. |
azCode | String | AZ of a node. |
ip | String | Instance IP address. |
volume | ClusterVolumeRsp object | definitions.ClusterVolumeRsp.description |
resourceId | String | ID of the instance resource |
Parameter | Type | Description |
|---|---|---|
type | String | Type of the disk used by the instance. |
size | Integer | Instance disk information |
resourceIds | Array of strings | Instance disk resource ID |
Parameter | Type | Description |
|---|---|---|
eipSize | Integer | Bandwidth range. Unit: Mbit/s |
elbWhiteListResp | kibanaElbWhiteListResp object | Kibana public network access information. |
publicKibanaIp | String | Specifies the IP address for accessing Kibana. |
bandwidthResourceId | String | Resource ID corresponding to the Kibana public network |
Parameter | Type | Description |
|---|---|---|
enableWhiteList | Boolean | Whether the Kibana access control is enabled.
|
whiteList | String | Whitelist of public network for accessing Kibana. |
Parameter | Type | Description |
|---|---|---|
enableWhiteList | Boolean | Whether the public network access control is enabled.
|
whiteList | String | Whitelist for public network access. |
Parameter | Type | Description |
|---|---|---|
key | String | Tag key. |
value | String | Tag value. |
Parameter | Type | Description |
|---|---|---|
errorCode | String | Error code.
|
errorMsg | String | Error details. |
Example Requests¶
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
Query the first ten clusters.
- Method 1: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10 - Method 2: GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=10
Example Responses¶
Status code: 200
Request succeeded.
{
"totalSize" : 1,
"clusters" : [ {
"datastore" : {
"type" : "elasticsearch",
"version" : "7.10.2",
"subVersion" : "7.10.2_24.3.0_0827",
"isEosCluster" : false,
"supportSecuritymode" : false
},
"instances" : [ {
"status" : "200",
"type" : "ess",
"id" : "{INSTANCE_ID}",
"name" : "css-8bc5-ess-esn-1-1",
"specCode" : "ess.spec-4u8g",
"azCode" : "{AZ_CODE}",
"volume" : {
"type" : "ULTRAHIGH",
"size" : 40,
"resourceIds" : [ "{RESOURCE_ID}" ]
},
"ip" : "192.168.0.122",
"resourceId" : "{RESOURCE_ID}"
} ],
"publicKibanaResp" : {
"eipSize" : 10,
"publicKibanaIp" : "100.95.152.28:9200",
"elbWhiteListResp" : null,
"bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
},
"elbWhiteList" : {
"whiteList" : "",
"enableWhiteList" : false
},
"updated" : "2023-10-09T02:07:13",
"name" : "css-8bc5",
"publicIp" : "100.85.222.202",
"created" : "2023-10-09T02:07:13",
"id" : "{CLUSTER_ID}",
"status" : "200",
"endpoint" : "192.168.0.122:9200",
"vpcId" : "{VPC_ID}",
"subnetId" : "{SUBNET_ID}",
"securityGroupId" : "{SECURITY_GROUP_ID}",
"bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
"bandwidthSize" : 3,
"httpsEnable" : true,
"authorityEnable" : true,
"diskEncrypted" : false,
"backupAvailable" : false,
"actionProgress" : { },
"actions" : [ ],
"enterpriseProjectId" : "0",
"tags" : [ ],
"period" : true
} ]
}
Status Codes¶
Status Code | Description |
|---|---|
200 | Request succeeded. |
400 | Invalid request. Modify the request before retry. |
404 | The requested resource could not be found. Modify the request before retry. |
Error Codes¶
See Error Codes.