Help Center/ Cloud Search Service/ API Reference/ API V1/ Specifications Query/ Obtaining the Instance Specifications List
Updated on 2025-11-28 GMT+08:00
View PDF

Obtaining the Instance Specifications List

Function

This API is used to obtain the node specifications, including the node specifications version, cluster data search engine, number of vCPUs per node, and node memory size. You may use this API to check node specifications after a cluster is created.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/es-flavors

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

versions

Array of EsflavorsVersionsResp objects

Definition:

Flavor version list.

Value range:

N/A
Table 3 EsflavorsVersionsResp

Parameter

Type

Description

version

String

Definition:

Elasticsearch engine version. For details, see the supported versions in Before You Start.

Value range:

N/A

flavors

Array of EsflavorsVersionsFlavorsResp objects

Definition:

Flavor list.

Value range:

N/A

type

String

Definition:

Instance type.

Value range:

  • ess: data node

  • ess-cold: cold data node

  • ess-master: master node.

  • ess-client: client node

  • lgs: Logstash node
Table 4 EsflavorsVersionsFlavorsResp

Parameter

Type

Description

cpu

Integer

Definition:

Number of CPU cores of an instance.

Value range:

N/A

ram

Integer

Definition:

Memory size of an instance. Unit: GB.

Value range:

N/A

name

String

Definition:

Flavor name.

Value range:

N/A

region

String

Definition:

Available region.

Value range:

N/A

diskrange

String

Definition:

Disk capacity range of an instance.

Value range:

N/A

availableAZ

String

Definition:

AZ.

Value range:

N/A

flavor_id

String

Definition:

Flavor ID.

Value range:

N/A

Example Requests

Obtain the specifications of all nodes in the project space.

GET https://{Endpoint}/v1.0/{project_id}/es-flavors

Example Responses

Status code: 200

Request succeeded.

{
  "versions" : [ {
    "flavors" : [ {
      "cpu" : 4,
      "ram" : 32,
      "name" : "ess.spec-4u32g",
      "region" : "xx-xxx-xx",
      "diskrange" : "40,2560",
      "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
      "flavor_id" : "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
    }, {
      "cpu" : 8,
      "ram" : 64,
      "name" : "ess.spec-8u64g",
      "region" : "xx-xxx-xx",
      "diskrange" : "80,5120",
      "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
      "flavor_id" : "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
    }, {
      "cpu" : 16,
      "ram" : 128,
      "name" : "ess.spec-16u128g",
      "region" : "xx-xxx-xx",
      "diskrange" : "160,10240",
      "availableAZ" : "xx-xxx-xx,xx-xxx-xx",
      "flavor_id" : "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
    } ],
    "type" : "ess",
    "version" : "x.x.x"
  } ]
}

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.

Parent topic: Specifications Query