Obtaining the Instance Specifications List¶

Function¶

This API is used to query and display the IDs of supported instance specifications.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 2** Response body parameters¶
Parameter	Type	Description
versions	Array of EsflavorsVersionsResp objects	Engine version list.

**Table 3** EsflavorsVersionsResp¶
Parameter	Type	Description
version	String	Elasticsearch engine version. For details, see the supported versions in Before You Start.
flavors	Array of EsflavorsVersionsFlavorsResp objects	instance flavor list.
type	String	Instance type. The options are ess, ess-cold, ess-master, and ess-client.

**Table 4** EsflavorsVersionsFlavorsResp¶
Parameter	Type	Description
cpu	Integer	Number of CPU cores of an instance.
ram	Integer	Memory size of an instance. Unit: GB
name	String	Flavor name
region	String	Available region
diskrange	String	Disk capacity range of an instance
availableAZ	String	AZ
flavor_id	String	Flavor ID

Example Requests¶

None

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.

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.

last updated: 2024-11-27 11:29 UTC - commit: b6cfaea6ecb36562dcaab59e2cab1c4b61be822b