Help Center/ Data Warehouse Service/ API Reference/ API Description/ Cluster Management/ Querying Flavor Details of a Cluster
Updated on 2026-10-21 GMT+08:00
View PDF

Querying Flavor Details of a Cluster

Function

This API is used to query flavor details of a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/flavor

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

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

namespace

No

String

Definition

Namespace. Generally, the value can only be DWS.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

flavor

ClusterFlavorDetailInfo object

Definition

Cluster flavor details.

Range

N/A
Table 4 ClusterFlavorDetailInfo

Parameter

Type

Description

id

String

Definition

Flavor ID.

Range

N/A

spec_name

String

Definition

Flavor code.

Range

N/A

current_node

Integer

Definition

Number of existing nodes.

Range

N/A

min_node

Integer

Definition

Minimum number of nodes.

Range

N/A

max_node

Integer

Definition

Maximum number of nodes.

Range

N/A

classify

String

Definition

Flavor type.

Range

N/A

datastore_version

String

Definition

Data warehouse version.

Range

N/A

attribute

Array of FlavorAttributeInfo objects

Definition

Extended information.

Range

N/A

volume_node

FlavorVolumeNodeInfo object

Definition

Flavor used by the cluster.

Range

N/A
Table 5 FlavorAttributeInfo

Parameter

Type

Description

code

String

Definition

Attribute code.

Range

N/A

value

String

Definition

Attribute value.

Range

N/A
Table 6 FlavorVolumeNodeInfo

Parameter

Type

Description

volume_type

String

Definition:

Storage type used by a node.

Range:

  • SATA: common I/O.

  • SAS: high I/O.

  • SSD: ultra-high I/O.

  • ESSD: Extreme SSD.

  • GPSSD: general-purpose SSD.

volume_num

Integer

Definition

Number of disks used by a node.

Range

N/A

capacity

Integer

Definition

Available capacity of a node after copies are removed.

Range

N/A

volume_size

Integer

Definition

Capacity of a single disk on a node.

Range

N/A

Example Requests

Query the cluster flavor details.

GET https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/c4b7a057-b121-4a80-9855-8d850108f85f/flavor

Example Responses

Status code: 200

{
  "flavor" : {
    "id" : "d60ef487-7aa8-44b7-969a-d543ddc5b96f",
    "spec_name" : "dwsk2.xlarge",
    "current_node" : 3,
    "min_node" : 3,
    "max_node" : 256,
    "classify" : "dws",
    "attribute" : [ {
      "code" : "cpuNum",
      "value" : "4"
    }, {
      "code" : "diskType",
      "value" : "SSD"
    }, {
      "code" : "ioGbSec",
      "value" : ""
    }, {
      "code" : "localDisk",
      "value" : "N"
    }, {
      "code" : "maxQueue",
      "value" : ""
    }, {
      "code" : "memSize",
      "value" : "32"
    } ],
    "volume_node" : {
      "volume_type" : "SATA",
      "volume_num" : 2,
      "capacity" : 100,
      "volume_size" : 100
    },
    "datastore_version" : "8.3.0.201"
  }
}

Status Codes

Status Code

Description

200

Cluster flavors 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.
Parent Topic: Cluster Management