/ DOCS
Advanced
Тема интерфейса

Querying Cluster Details

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

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

Constraints:

N/A

Options:

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

Default value:

N/A

cluster_id

Yes

String

Parameter description:

Specifies the ID of the cluster to be queried. For details, see Obtaining the Cluster ID.

Constraints:

N/A

Options:

For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

datastore

Parameter description:

Search engine.

instances

Array of ClusterDetailInstances objects

Parameter description:

List of node objects.

publicKibanaResp

Parameter description:

Kibana public network access information.

elbWhiteList

Parameter description:

Public network access control information.

updated

String

Parameter description:

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

name

String

Parameter description:

Cluster name.

publicIp

String

Parameter description:

Public IP address and port number.

created

String

Parameter description:

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

id

String

Parameter description:

Cluster ID.

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

Parameter description:

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

Parameter description:

VPC ID.

subnetId

String

Parameter description:

Subnet ID.

securityGroupId

String

Parameter description:

Security group ID.

vpcepIp

String

Parameter description:

VPC endpoint IP address.

vpcepIpv6Address

String

Parameter description:

IPv6 address of the VPC endpoint.

bandwidthSize

Integer

Parameter description:

Public network bandwidth. Unit: Mbit/s

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

Parameter description:

Whether to enable authentication. Available values include true and false. Authentication is disabled by default.

Options:

  • true: Authentication is enabled for the cluster.

  • false: Authentication is disabled for the cluster.

backupAvailable

Boolean

Parameter description:

Whether the snapshot function is enabled.

Options:

  • true: The snapshot function is enabled.

  • false: The snapshot function is disabled.

actionProgress

Object

Parameter description:

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

actions

Array of strings

Parameter description:

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 the snapshot is being created.

enterpriseProjectId

String

Parameter description:

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.

tags

Array of ClusterDetailTags objects

Parameter description:

Cluster tags.

failedReason

Parameter description:

Failure cause. If the cluster is in the available status, this parameter is not returned.

bandwidthResourceId

String

Parameter description:

ID of the resource accessible from the public network.

ipv6Endpoint

String

Parameter description:

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

supportVpcep

Boolean

Parameter description:

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

cmkId

String

Parameter description:

Encryption key ID used by the current cluster.
Table 3 ClusterDetailDatastore

Parameter

Type

Description

type

String

Parameter description:

Engine type.

Options:

elasticsearch, logstash, or opensearch.

version

String

Parameter description:

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

subVersion

String

Parameter description:

Cluster image version.

isEosCluster

Boolean

Parameter description:

Whether the cluster image version has reached EOS.

Options:

true indicates that the image version has reached EOS; false indicates that the image version has not reached EOS.

supportSecuritymode

Boolean

Parameter description:

Whether the security mode is supported.

Options:

The value can be true (supported) or 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

Parameter description:

Instance resource ID.

type

String

Parameter description:

Type of the current node.

id

String

Parameter description:

Instance ID.

name

String

Parameter description:

Instance name.

specCode

String

Parameter description:

Node flavor name.

azCode

String

Parameter description:

AZ of a node.

privateIp

String

Parameter description:

Instance IP address.

volume

Parameter description:

Instance disk information.
Table 5 ShowClusterVolumeRsp

Parameter

Type

Description

type

String

Parameter description:

Instance disk type

size

Integer

Parameter description:

Instance disk size

resourceIds

Array of strings

Parameter description:

Instance disk resource ID
Table 6 publicKibanaRespBody

Parameter

Type

Description

eipSize

Integer

Bandwidth range. Unit: Mbit/s

elbWhiteListResp

Parameter description:

Kibana public network access control information.

publicKibanaIp

String

Parameter description:

Specifies the IP address for accessing Kibana.

bandwidthResourceId

String

Parameter description:

Resource ID corresponding to the Kibana public network
Table 7 kibanaElbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Whether to enable Kibana access control.

Options:

  • true: Access control is enabled.

  • false: Access control is disabled.

whiteList

String

Parameter description:

Whitelist for Kibana public network access.
Table 8 elbWhiteListResp

Parameter

Type

Description

enableWhiteList

Boolean

Parameter description:

Whether to enable public network access control.

Options:

  • true: Public network access control is enabled.

  • false: Public network access control is disabled.

whiteList

String

Parameter description:

Whitelist for public network access.
Table 9 ClusterDetailTags

Parameter

Type

Description

key

String

Parameter description:

Tag key.

value

String

Parameter description:

Tag value.
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

Parameter description:

Error details.

Example Requests

Whether the details of a cluster are obtained

GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/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}" ]
    },
    "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",
  "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,
  "supportVpcep" : 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

Parent topic: Cluster Management
Предыдущая статья
Querying the Cluster List
Следующая статья
Deleting a Cluster
Была ли эта статья полезна?
Поддержка Юридические документы
© 2025 Cloud.ru