Help Center/ Web3 Node Engine Service/ API Reference/ API/ Node Management/ Obtaining Available Specifications for Node Scaling

Updated on 2023-08-08 GMT+08:00

View PDF

Obtaining Available Specifications for Node Scaling

Description

This API is used to obtain available specifications for node scaling.

URI

GET /v1/{project_id}/node-provider/nodes/{node_id}/flavor

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum length: 32 characters Maximum length: 32 characters
node_id	Yes	String	Node ID. Minimum length: 36 characters Maximum length: 45 characters

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Minimum length: 1 character Maximum length: 65,535 characters

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
flavors	Array of MachineFlavor objects	All specifications.
count	Integer	Number of records. Minimum value: 0 Maximum value: 1000

**Table 4** MachineFlavor
Parameter	Type	Description
cpu	Integer	Number of CPU cores. Minimum value: 1 Maximum value: 1024
ram	Integer	Memory. Minimum value: 1 Maximum value: 1,048,576
description	String	Description, which can be Test, Preferred, Stable, or Powerful. Minimum length: 1 character Maximum length: 50 characters

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

None

Example Response

Status code: 200

Request successful.

{
  "flavors" : [ {
    "cpu" : 4,
    "ram" : 16384,
    "description" : "Preferred"
  } ],
  "count" : 1
}

Status code: 400

Request failed.

{
  "code" : 400,
  "error_code" : "BCS.03400001",
  "error_msg" : "Invalid request.",
  "message" : "unmarshal request data error"
}

Status code: 401

Authentication failed.

{
  "code" : 401,
  "error_code" : "BCS.03401001",
  "error_msg" : "Authorization failed.",
  "message" : "request token is not valid"
}

Status code: 500

Internal service error.

{
  "code" : 500,
  "error_code" : "BCS.03500001",
  "error_msg" : "Internal error.",
  "message" : "project [xxx] node [xxx] get service bearer user token error"
}