Updated on 2025-08-06 GMT+08:00

Querying Flavor Information

Function

This API is used to query flavors supported by GaussDB(DWS).

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/node-types

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

node_types

Array of NodeTypes objects

Definition

Available flavor list.

Range

Non-empty object list.

count

Integer

Definition

Total number of flavors.

Range

A positive integer greater than or equal to 0

Table 3 NodeTypes

Parameter

Type

Description

spec_name

String

Definition

Flavor name.

Range

Letters, digits, dots (.), underscores (_), and hyphens (-) are allowed.

detail

Array of Detail objects

Definition

Flavor details.

Range

N/A

id

String

Definition

Flavor ID.

Range

Generally, the value is a UUID.

datastore_type

String

Definition

Product type.

Range

  • dws: cloud data warehouse

  • hybrid: hybrid data warehouse

architecture

String

Definition

Architecture type.

Range

  • x86

  • arm

available_zones

Array of NodeTypeAvailableZones objects

Definition

Supported AZs and status information.

Range

N/A

ram

Integer

Definition

Memory size, in GB.

Range

A positive integer greater than 0

vcpus

Integer

Definition

Number of CPUs.

Range

A positive integer greater than 0

datastores

Array of NodeTypeDatastores objects

Definition

Kernel version information.

Range

N/A

volume

VolumeResp object

Definition

Storage of fixed storage specifications.

Range

For a fixed storage the value is the storage of its typical configuration. For an elastic storage, the value null.

elastic_volume_specs

Array of NodeTypeElasticVolumeSpecs objects

Definition

Information of elastic storage specifications.

Range

For elastic storage specifications, the value is the storage of its typical configuration (including the storage type, minimum capacity, maximum capacity, and step). For fixed storage specifications, the value is null.

Table 4 Detail

Parameter

Type

Description

type

String

Definition

Attribute type.

Range

N/A

value

String

Definition

Attribute value.

Range

N/A

unit

String

Definition

Attribute unit.

Range

N/A

Table 5 NodeTypeAvailableZones

Parameter

Type

Description

code

String

Definition

AZ ID.

Range

N/A

status

String

Definition

Favor status.

Range

  • normal: available

  • sellout: sold out

  • abandon: unavailable

Table 6 NodeTypeDatastores

Parameter

Type

Description

version

String

Definition

Kernel version.

Range

The version consists of digits and decimal points, for example, 9.1.0 and 9.1.1.100.

attachments

attachments object

Definition

Additional information about the kernel version.

Range

N/A

role

String

Definition

Version type.

Range

  • STABLE: stable version

  • PREVIEW: preview version

Table 7 attachments

Parameter

Type

Description

min_cn

Integer

Definition

Minimum CNs allowed by the kernel version.

Range

A positive integer greater than 0

max_cn

Integer

Definition

Maximum CNs allowed by the kernel version.

Range

A positive integer greater than 0

Table 8 VolumeResp

Parameter

Type

Description

type

String

Definition

Disk type. Only SSDs are supported.

Range

Only SSDs are supported.

size

Integer

Definition

Available disk capacity.

Range

Only SSDs are supported.

Table 9 NodeTypeElasticVolumeSpecs

Parameter

Type

Description

type

String

Definition

Cloud disk type.

Range

N/A

step

Integer

Definition

Cloud disk size increment.

Range

N/A

min_size

Integer

Definition

Minimum cloud disk size.

Range

N/A

max_size

Integer

Definition

Maximum cloud disk size.

Range

N/A

Example Requests

Query flavor information.

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types

Example Responses

Status code: 200

Flavor information queried.

{
  "node_types" : [ {
    "spec_name" : "dws.d2.xlarge",
    "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
    "datastore_type" : "dws",
    "architecture" : "x86",
    "available_zones" : [ {
      "code" : "az1",
      "status" : "normal"
    } ],
    "ram" : 32,
    "vcpus" : 4,
    "datastores" : [ {
      "version" : "8.1.3.200",
      "attachments" : {
        "min_cn" : 2,
        "max_cn" : 20
      },
      "role" : "STABLE"
    } ],
    "volume" : {
      "type" : "SSD",
      "size" : 160
    },
    "elastic_volume_specs" : [ {
      "type" : "SSD",
      "step" : 100,
      "min_size" : 100,
      "max_size" : 32000
    } ],
    "detail" : [ {
      "type" : "vCPU",
      "value" : "4"
    }, {
      "value" : "1675",
      "type" : "LOCAL_DISK",
      "unit" : "GB"
    }, {
      "type" : "mem",
      "value" : "32",
      "unit" : "GB"
    } ]
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Flavor information queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.