Help Center/ Cloud Search Service/ API Reference/ API V1/ Specifications Query/ Query available node specifications by engine.
Updated on 2025-11-28 GMT+08:00

Query available node specifications by engine.

Function

Query available node specifications by engine.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/datastore/{datastore_id}/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

datastore_id

Yes

String

Definition:

Engine type ID.

Constraints:

N/A

Value range:

Elasticsearch: cf7e2c8f-096c-4fcf-b174-1ebe060679fb.

Opensearch: 07ec9f86-ec2f-49e7-8913-373003aedf32.

Logstash: 575276bb-87e5-4e18-8e1e-e748d8ad3a06.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

datastore_version_id

No

String

Definition:

Engine type ID.

Constraints:

N/A

Value range:

Elasticsearch 7.10.2: 01f53413-0a58-4b0c-848a-f625846bae23.

Opensearch 2.19.0: 11a9df5c-711f-496c-866d-a4521c179671.

Logstash 7.10.0: f5609cf0-3514-49ef-87db-a3df2858a46f.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Definition:

Engine type ID.

Value range:

N/A

dbname

String

Definition:

Engine name.

Value range:

N/A

versions

Array of FlavorRespVersionBody objects

Definition:

Engine version.

Value range:

N/A

modelList

ModelList object

Definition:

Model list.

Value range:

N/A

Table 4 FlavorRespVersionBody

Parameter

Type

Description

id

String

Definition:

Version ID.

Value range:

N/A

name

String

Definition:

Version name.

Value range:

N/A

flavors

Array of Flavor objects

Definition:

Specification information.

Value range:

N/A

Table 5 Flavor

Parameter

Type

Description

cpu

Integer

Definition:

Number of vCPUs available with 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:

Regions where the node flavor is available.

Value range:

N/A

typename

String

Definition:

Name of a node type

Value range:

N/A

diskrange

String

Definition:

Instance disk capacity range, in GB.

Value range:

N/A

condOperationStatus

String

Definition:

This parameter takes effect region-wide. If an AZ is not configured in the condOperationAz parameter, the value of this parameter is used by default.

Value range:

  • normal: The flavor is in normal commercial use.

  • sellout: The flavor has been sold out.

condOperationAz

String

Definition:

This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the condOperationAz parameter is used by default. The value format of this parameter is az(xx). The value in parentheses is the flavor status of the AZ. If the parentheses are left blank, the configuration is invalid. The value range for this parameter is the same as that for condOperationStatus.

Value range:

N/A

localdisk

String

Definition:

Whether the node uses local disks.

Value range:

  • true: local disks

  • false: non-local disks

flavorTypeCn

String

Definition:

Flavor categories in Chinese.

Value range:

N/A

flavorTypeEn

String

Definition:

Flavor categories in English.

Value range:

N/A

edge

Boolean

Definition:

Whether this is a node flavor for edge deployments.

Value range:

  • true: This is a node flavor for edge deployments.

  • false: This is a general flavor.

str_id

String

Definition:

Flavor ID.

Value range:

N/A

isAllowHttps

Boolean

Definition:

Whether the node type supports HTTPS access.

Value range:

N/A

Table 6 ModelList

Parameter

Type

Description

totalSize

Integer

Definition:

Model quantity

Value range:

N/A

models

Array of Model objects

Definition:

Model list

Value range:

N/A

Table 7 Model

Parameter

Type

Description

id

String

Definition:

Model ID

Value range:

N/A

name

String

Definition:

Model name

Value range:

N/A

datastore_type

String

Definition:

Model type

Value range:

N/A

datastore_version

String

Definition:

Model version

Value range:

N/A

is_text_model

String

Definition:

Whether it is a text model

Value range:

N/A

model_version_id

String

Definition:

Model version ID

Value range:

N/A

desc

String

Definition:

Model description

Value range:

N/A

language

String

Definition:

Model language

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

The request is invalid.

Modify the request and then try again.

403

The request is rejected.

The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

Error Codes

See Error Codes.