Updated on 2025-08-15 GMT+08:00

Querying Cluster Details

Function

This API is used to query and display details about a single cluster, including the cluster's search type, node list, network information, cluster name, cluster ID, and cluster status, so that you can check whether the created cluster meets your expectation. You can also log in to the Huawei Cloud official website, access the CSS console, and obtain the cluster's private IP address, public IP address, version, and node information on the cluster information page.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

datastore

ClusterDetailDatastore object

Definition:

Cluster data search engine type.

Value range:

N/A

instances

Array of ClusterDetailInstances objects

Definition:

List of node objects.

Value range:

N/A

publicKibanaResp

publicKibanaRespBody object

Definition:

Kibana public network access information.

Value range:

N/A

elbWhiteList

elbWhiteListResp object

Definition:

Kibana public network access control information.

Value range:

N/A

updated

String

Definition:

Time when the cluster was last modified.

Value range:

The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

name

String

Definition:

Cluster name.

Value range:

N/A

publicIp

String

Definition:

Public IP address and port number.

Value range:

N/A

created

String

Definition:

Time when a cluster was created.

Value range:

The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

id

String

Definition:

Cluster ID.

Value range:

N/A

status

String

Parameter description:

Cluster status.

Options:

100: An operation, such as creation, is in progress.

  • 200: Available

  • 303: unavailable, for example, due to a creation failure.

endpoint

String

Definition:

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)

Value range:

N/A

vpcId

String

Definition:

VPC ID.

Value range:

N/A

subnetId

String

Definition:

Current subnet of a cluster. This subnet is used to add nodes, including scaling, adding dedicated master/client nodes, and enabling the VPC Endpoint service. IP addresses will be allocated to newly added nodes from the current subnet.

Value range:

N/A

securityGroupId

String

Definition:

Security group ID.

Value range:

N/A

vpcepIp

String

Definition:

VPC endpoint IP address.

Value range:

N/A

vpcepIpv6Address

String

Definition:

IPv6 address of the VPC endpoint.

Value range:

N/A

bandwidthSize

Integer

Definition:

Public network bandwidth, in Mbit/s.

Value range:

N/A

httpsEnable

Boolean

Parameter description:

Communication encryption status.

Options:

  • false: Communication encryption is not enabled.

  • true: Communication encryption is enabled.

diskEncrypted

Boolean

Parameter description:

Whether disks are encrypted.

Options:

  • true: Disks are encrypted.

  • false: Disk are not encrypted.

authorityEnable

Boolean

Definition:

Whether to enable security mode-based authentication for the cluster.

Value range:

  • true: Enable security mode-based authentication.

  • false: Disable security mode-based authentication.

backupAvailable

Boolean

Definition:

Whether snapshot is enabled.

Value range:

  • true: The snapshot function is enabled.

  • false: The snapshot function is disabled.

actionProgress

Object

Definition:

Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage.

Value range:

N/A

actions

Array of strings

Definition:

List of ongoing tasks in the cluster.

Value range:

  • REBOOTING

  • GROWING

  • RESTORING: The cluster is being restored.

  • SNAPSHOTTING: A snapshot is being created.

enterpriseProjectId

String

Definition:

ID of the enterprise project that a cluster belongs. If the user of the cluster has not enabled the enterprise project, the setting of this parameter is not returned.

Value range:

N/A

tags

Array of ClusterDetailTags objects

Definition:

Cluster tags.

Value range:

N/A

failedReason

ClusterDetailFailedReasons object

Definition:

Failure cause of a cluster change task. If the cluster status is available, this parameter is not returned.

Value range:

N/A

period

Boolean

Definition:

Whether a cluster is billed yearly/monthly.

Value range:

  • true: The cluster is billed on a yearly/monthly basis.

  • false: The cluster is billed pay-per-use.

bandwidthResourceId

String

Definition:

ID of the resource accessible from the public network.

Value range:

N/A

ipv6Endpoint

String

Definition:

IPv6 address and port number accessed from the cluster's private network.

Value range:

N/A

supportVpcep

Boolean

Definition:

Whether the VPCEP service can be enabled for the current cluster.

Value range:

  • true: supported.

  • false: not supported.

cmkId

String

Definition:

Encryption key ID used by the current cluster.

Value range:

N/A

orderId

String

Definition:

Order ID of a yearly/monthly cluster.

Value range:

N/A

currentSubnetIds

String

Definition:

Subnets used by all nodes in the cluster. If there are multiple subnets (two at most), separate them with a comma (,).

Value range:

N/A

Table 3 ClusterDetailDatastore

Parameter

Type

Description

type

String

Definition:

Engine type.

Value range:

  • elasticsearch: Provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.

  • logstash: provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch.

  • opensearch: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.

version

String

Definition:

Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

Value range:

N/A

subVersion

String

Definition:

Cluster image version.

Value range:

N/A

isEosCluster

Boolean

Definition:

Whether the cluster image version has reached EOS.

Value range:

  • true: yes.

  • false: no.

supportSecuritymode

Boolean

'Definition:

Whether the cluster supports the security mode.

Value range:

  • true: supported.

  • false: not supported.

Table 4 ClusterDetailInstances

Parameter

Type

Description

status

String

Parameter description:

Node status.

Options:

  • 100: creating

  • 200: Available

  • 303: unavailable, for example, due to a creation failure.

resourceId

String

Definition:

Instance resource ID.

Value range:

N/A

type

String

Definition:

Node type.

Value range:

  • ess: data node

  • ess-cold: cold data node

  • ess-client: client node

  • ess-master: master node

  • lgs: Logstash node

id

String

Definition:

Instance ID.

Value range:

N/A

name

String

Definition:

Instance name.

Value range:

N/A

specCode

String

Definition:

Node flavor name.

Value range:

N/A

azCode

String

Definition:

AZ of the node.

Value range:

N/A

ip

String

Definition:

Instance IP address.

Value range:

N/A

volume

ShowClusterVolumeRsp object

Definition:

Instance disk information.

Value range:

N/A

subnetId

String

Definition:

Subnet ID of the current node.

Value range:

N/A

Table 5 ShowClusterVolumeRsp

Parameter

Type

Description

type

String

Definition:

Instance disk type.

Value range:

N/A

size

Integer

Definition:

Instance disk size.

Value range:

N/A

resourceIds

Array of strings

Definition:

Instance disk resource ID.

Value range:

N/A

Table 6 publicKibanaRespBody

Parameter

Type

Description

eipSize

Integer

Definition:

The bandwidth size in Mbit/s.

Value range:

N/A

elbWhiteListResp

kibanaElbWhiteListResp object

Definition:

Kibana public network access control information.

Value range:

N/A

publicKibanaIp

String

Definition:

Specifies the IP address for accessing Kibana.

Value range:

N/A

bandwidthResourceId

String

Definition:

Resource ID corresponding to the Kibana public network.

Value range:

N/A

Table 7 kibanaElbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Definition:

Whether to enable Kibana access control.

Value range:

  • true: Access control is enabled.

  • false: Access control is disabled.

whiteList

String

Definition:

Whitelist for Kibana public network access.

Value range:

N/A

Table 8 elbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Definition:

Whether to enable public network access control via ELB. If a whitelist is set, only IP addresses on the whitelist can access the cluster. If no whitelist is set, all IP addresses can access the cluster.

Value range:

  • true: Public network access control is enabled.

  • false: Public network access control is disabled.

whiteList

String

Definition:

Whitelist for public network access.

Value range:

N/A

Table 9 ClusterDetailTags

Parameter

Type

Description

key

String

Definition:

Tag key.

Value range:

N/A

value

String

Definition:

Tag value.

Value range:

N/A

Table 10 ClusterDetailFailedReasons

Parameter

Type

Description

errorCode

String

Parameter description:

Error code.

Options:

  • CSS.6000: A cluster fails to be created.

  • CSS.6001: A cluster fails to be scaled out.

  • CSS.6002: A cluster fails to be restarted.

  • CSS.6004: A node fails to be created in a cluster.

  • CSS.6005: A service fails to be initialized.

errorMsg

String

Definition:

Error details.

Value range:

N/A

Example Requests

Whether the details of a cluster are obtained

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c2bab0d-ec5f-491f-9418-b8da38a26760

Example Responses

Status code: 200

Request succeeded.

{
  "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}",
	 "subnetId": "{SUBNET_ID}" //Subnet ID used by the node
    }
  ],
  "publicKibanaResp": {
    "eipSize": 10,
    "publicKibanaIp": "100.95.152.28",
    "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}", //VPC ID used by the cluster
"subnetId": "{SUBNET_ID}", //Subnet ID used by all nodes in the cluster. Typically, a cluster uses only one subnet.
  "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,
  "supportVpcep": true,
"currentSubnetIds":"{SUBNET_ID}" //Default subnet ID of the cluster, which is used to assign new IP addresses to newly added nodes during a cluster scale-out operation when a VPC endpoint is created.
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;


public class ShowClusterDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowClusterDetailRequest request = new ShowClusterDetailRequest();
        request.withClusterId("{cluster_id}");
        try {
            ShowClusterDetailResponse response = client.showClusterDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowClusterDetailRequest()
        request.cluster_id = "{cluster_id}"
        response = client.show_cluster_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowClusterDetailRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ShowClusterDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.