Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Cluster Details

Function

This API is used to query and display details about a cluster.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

cluster_id

Yes

String

ID of the cluster to be queried.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

datastore

ClusterDetailDatastore object

Search engine type.

instances

Array of ClusterDetailInstances objects

List of node objects.

publicKibanaResp

publicKibanaRespBody object

Kibana public network access information.

elbWhiteList

elbWhiteListResp object

Public network access information.

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 and port number.

created

String

Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

id

String

Cluster ID.

status

String

Cluster status.

  • 100: The operation, such as instance creation, is in progress.
  • 200: The cluster is available.
  • 303: The cluster is unavailable, for example, due to a creation failure.

endpoint

String

IPv4 address and port number accessible from the cluster's private network.

vpcId

String

VPC ID.

subnetId

String

Subnet ID.

securityGroupId

String

Security group ID.

bandwidthSize

Integer

Public network bandwidth. Unit: Mbit/s.

httpsEnable

Boolean

Communication encryption status.

  • false: Communication encryption is disabled.
  • true: Communication encryption is enabled.

diskEncrypted

Boolean

Whether disks are encrypted.

  • true: Disks are encrypted.
  • false: Disks are not encrypted.

authorityEnable

Boolean

Whether to enable authentication. The value can be true or false. Authentication is disabled by default.

  • true: Authentication is enabled for the cluster.
  • false: Authentication is disabled for the cluster.

backupAvailable

Boolean

Whether the snapshot function is enabled.

  • true: The snapshot function is enabled.
  • false: The snapshot function is disabled.

actionProgress

Object

Cluster operation progress, which shows the progress of cluster creation or scale-out in percentage.

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.

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

tags

Array of ClusterDetailTags objects

Cluster tags.

failedReason

ClusterDetailFailedReasons object

Failure cause. If the cluster is in the Available state, this parameter is not returned.

bandwidthResourceId

String

ID of the resource accessible from the public network.

Table 3 ClusterDetailDatastore

Parameter

Type

Description

type

String

Engine type. The value can be **elasticsearch**.

version

String

Version of the CSS cluster engine. For details, see Supported Cluster Versions.

supportSecuritymode

Boolean

The security mode is supported.

Table 4 ClusterDetailInstances

Parameter

Type

Description

status

String

Node status.

  • 100: The operation, such as instance creation, is in progress.
  • 200: The cluster is available.
  • 303: The cluster is unavailable, for example, due to a creation failure.

resourceId

String

Instance resource ID.

type

String

Node type.

id

String

Instance ID.

name

String

Instance name.

specCode

String

Node specifications.

azCode

String

AZ of a node.

privateIp

String

Instance IP address.

volume

ShowClusterVolumeRsp object

Instance disk information.

Table 5 ShowClusterVolumeRsp

Parameter

Type

Description

type

String

Instance disk type.

size

Integer

Instance disk size.

resourceIds

Array of strings

Instance disk resource ID.

Table 6 publicKibanaRespBody

Parameter

Type

Description

eipSize

Integer

Bandwidth size. Unit: Mbit/s.

elbWhiteListResp

kibanaElbWhiteListResp object

Kibana public network access information.

publicKibanaIp

String

IP address for accessing Kibana.

bandwidthResourceId

String

Resource ID corresponding to the Kibana public network.

Table 7 kibanaElbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Whether Kibana access control is enabled.

  • true: Access control is enabled.
  • false: Access control is disabled.

whiteList

String

Whitelist for Kibana public network access.

Table 8 elbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Whether public network access control is enabled.

  • true: Public network access control is enabled.
  • false: Public network access control is disabled.

whiteList

String

Whitelist for public network access.

Table 9 ClusterDetailTags

Parameter

Type

Description

key

String

Tag key.

value

String

Tag value.

Table 10 ClusterDetailFailedReasons

Parameter

Type

Description

errorCode

String

Error code.

  • CSS.6000: A cluster failed to be created.
  • CSS.6001: A cluster failed to be scaled out.
  • CSS.6002: A cluster failed to be restarted.
  • CSS.6004: A node failed to be created in a cluster.
  • CSS.6005: A service failed to be initialized.

errorMsg

String

Error details.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "datastore" : {
    "type" : "elasticsearch",
    "version" : "7.10.2"
  },
  "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}" ]
    },
    "privateIp" : "192.168.0.122",
    "resourceId" : "{RESOURCE_ID}"
  } ],
  "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",
  "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" : [ ]
}

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback