Obtaining Available Cluster Flavors

Function

This API is used to obtain the available cluster flavors.

The URL for cluster management is in the format of https://Endpoint/uri, where uri specifies the resource path for API access.

Calling Method

For details, see Calling APIs.

URI

GET /api/v2/flavor/specifications

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
clusterType	Yes	String	Definition Used to obtain available flavors by cluster architecture. Range VirtualMachine: CCE cluster ARM64: Kunpeng cluster

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) Default value: N/A
X-Auth-Token	Yes	String	Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
clusterFlavorSpecs	ClusterFlavorSpecification object	Definition Cluster flavors for sale

**Table 4** ClusterFlavorSpecification
Parameter	Type	Description
name	String	Definition Flavor name Range cce.s1.small: a small-scale CCE cluster with one control plane node and a maximum of 50 worker nodes cce.s1.medium: a medium-scale CCE cluster with one control plane node and a maximum of 200 worker nodes cce.s2.small: a small-scale CCE cluster with three control plane nodes and a maximum of 50 worker nodes cce.s2.medium: a medium-scale CCE cluster with three control plane nodes and a maximum of 200 worker nodes cce.s2.large: a large-scale CCE cluster with three control plane nodes and a maximum of 1,000 worker nodes cce.s2.xlarge: an ultra-large-scale CCE cluster with three control plane nodes and a maximum of 2,000 worker nodes Special cluster flavors in DeC are as follows: - cce.dec.s1.small: a small-scale DeC CCE cluster with one control plane node and a maximum of 50 worker nodes) - cce.dec.s1.medium: a medium-scale DeC CCE cluster with one control plane node and a maximum of 200 worker nodes) - cce.dec.s1.large: a large-scale DeC CCE cluster with one control plane node and a maximum of 1,000 worker nodes) - cce.dec.s1.xlarge: an ultra-large-scale DeC CCE cluster with one control plane node and a maximum of 2,000 worker nodes) - cce.dec.s2.small: a small-scale DeC CCE cluster with three control plane nodes and a maximum of 50 worker nodes) - cce.dec.s2.medium: a medium-scale DeC CCE cluster with three control plane nodes and a maximum of 200 worker nodes) - cce.dec.s2.large: a large-scale DeC CCE cluster with three control plane nodes and a maximum of 1,000 worker nodes) - cce.dec.s2.xlarge: an ultra-large-scale DeC CCE cluster with three control plane nodes and a maximum of 2,000 worker nodes)
nodeCapacity	Integer	Definition The number of nodes in a cluster Range 50: A maximum of 50 nodes is supported. 200: A maximum of 200 nodes is supported. 1000: A maximum of 1,000 nodes is supported. 2000: A maximum of 2,000 nodes is supported.
availableMasterFlavors	Array of MasterFlavorSpec objects	Definition Control plane node details
isSoldOut	Boolean	Definition Whether the cluster flavors are sold out Range N/A
isSupportMultiAZ	Boolean	Definition Whether the control plane nodes in a cluster can be deployed in different AZs Range N/A

**Table 5** MasterFlavorSpec
Parameter	Type	Description
name	String	Definition Control plane node flavors Range N/A
azs	Array of strings	Definition AZs supported by control plane nodes
azFaultDomains	Map<String,Array<String>>	Definition Fault domains supported by the AZs where control plane nodes reside

Example Requests

None

Example Responses

Status code: 200

The available cluster flavors have been obtained.

{
  "clusterFlavorSpecs" : [ {
    "name" : "cce.s2.large",
    "nodeCapacity" : 1000,
    "availableMasterFlavors" : [ {
      "name" : "ac6.4xlarge.2",
      "azs" : [ "az1", "az2" ],
      "azFaultDomains" : {
        "az1" : [ "FD1", "FD2" ]
      }
    } ]
  } ]
}