Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Querying Cluster Details

Updated on 2025-11-28 GMT+08:00

View PDF

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 overview 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 to be queried. 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: Public network access information for Kibana/Dashboards, including the IP address, whitelist, and bandwidth. Value range: N/A
elbWhiteList	elbWhiteListResp object	Definition: 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
snapshotPolicy	SnapshotPolicyResp object	Definition: Information about an automatic snapshot creation policy. 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	Definition: Cluster status. Value range: 100: An operation, such as creation, is in progress. 200: available 300: unavailable 303: creation failed
endpoint	String	Definition: IPv4 address and port number accessed from the cluster's private network. 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. BIND_FAILURE: failed to associate with an EIP. SHRINKING: scaling down or in. REPLACE_NODE: replacing nodes. AZ_MIGRATION: switching AZs. RESIZING_FLAVOR: changing node specifications. MODE_CHANGING: changing the security mode. SG_CHANGING: changing the security group. UPGRADING: upgrading. RESETTING_PASSWORD: The password is being reset. CONFIGURED: The configuration has been updated and cluster restart is pending.
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
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
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
desc	String	Definition: Cluster description. Value range: It can contain a maximum of 128 characters.

**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	Definition: Node status. Value range: 100: creating 200: available 300: unavailable 303: creation failed
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: IP address for accessing Kibana or Dashboards through the public network. Value range: N/A
bandwidthResourceId	String	Definition: Resource ID for Kibana/Dashboards public network access. Value range: N/A

**Table 7** kibanaElbWhiteListResp
Parameter	Type	Description
enableWhiteList	Boolean	Definition: Whether to enable the whitelist that controls public network access for Kibana or OpenSearch Dashboards. Value range: true: Enable the access control whitelist. false: Disable the access control whitelist.
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. 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: IP address.

**Table 9** SnapshotPolicyResp
Parameter	Type	Description
backupEnable	Boolean	Definition: Whether to enable automatic snapshots for the cluster. Value range: true: Yes false: No
bakPeriod	String	Definition: Snapshot creation time. Value range: N/A
bakFrequency	String	Definition: Snapshot creation interval. Value range: DAY: every day MON: every Monday TUR: every Tuesday WED: every Wednesday THU: every Thursday FRI: every Friday SAT: every Saturday SUN: every Sunday HOUR: every hour
bakKeepDay	Integer	Definition: Number of retained snapshots. Value range: N/A

**Table 10** ClusterDetailTags
Parameter	Type	Description
key	String	Definition: Tag key. Value range: N/A
value	String	Definition: Tag value. Value range: N/A

**Table 11** 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",
  "desc": "csscluster"
  "snapshotPolicy": {
    "backupEnable": false,
    "bakPeriod": "",
    "bakFrequency": "",
    "bakKeepDay": 1
  },
  "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.
}

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.

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.

Parent topic: Cluster Management

Previous topic: Querying the Cluster List

Next topic: Deleting a Cluster

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel