Querying Flavors

Updated on 2025-02-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query all load balancer flavors that are available to a specific user in a specific region.

Constraints

This API has the following constraints:

Parameters marker, limit, and page_reverse are used for pagination query.
Parameters marker and page_reverse take effect only when they are used together with parameter limit.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/elb/flavors

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Specifies the ID of the last record on the previous page. Note: This parameter must be used together with limit. If this parameter is not specified, the first page will be queried. This parameter cannot be left blank or set to an invalid ID.
limit	No	Integer	Specifies the number of records on each page. Value range: 0–2000 Default value: 2000
page_reverse	No	Boolean	Specifies whether to use reverse query. Value options: true: Query the previous page. false (default): Query the next page. Note: This parameter must be used together with limit. If page_reverse is set to true and you want to query the previous page, set the value of marker to the value of previous_marker.
id	No	Array of strings	Specifies the flavor ID. Multiple IDs can be queried in the format of id=xxx&id=xxx.
name	No	Array of strings	Specifies the flavor name. Multiple names can be queried in the format of name=xxx&name=xxx.
type	No	Array of strings	Specifies the flavor type. Value options: L4 indicates a Layer 4 flavor. L7 indicates a Layer 7 flavor. L4_elastic indicates the minimum elastic flavor at Layer 4. L7_elastic indicates the minimum elastic flavor at Layer 7. L4_elastic_max indicates the maximum elastic flavor at Layer 4. L7_elastic_max indicates the maximum elastic flavor at Layer 7. Multiple types can be queried in the format of type=xxx&type=xxx.
shared	No	Boolean	Specifies whether the flavor is available to all users. true indicates that the flavor is available to all users. false indicates that the flavor is available only to a specific user.
public_border_group	No	Array of strings	Specifies the public border group. Multiple values can be queried in the format of public_border_group=xxx&public_border_group=xxx.
category	No	Array of integers	Specifies the category. Multiple values can be queried in the format of category=xxx&category=xxx.
list_all	No	Boolean	If list_all is set to true, all maximum elastic specifications defined by l4_elastic_max and l7_elastic_max are returned. If list_all is set to false, only the largest elastic specifications will be returned. For Layer 4 load balancers, the specification with highest cps value is returned. If the cps values are the same, the specification with highest bandwidth value is returned. For Layer 7 load balancers, the specification with highest https_cps value is returned. If the https_cps values are the same, the specification with highest qps value is returned.
flavor_sold_out	No	Boolean	Specifies whether the flavor is available. true indicates the flavor is unavailable. false indicates the flavor is available.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the token used for IAM authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
flavors	Array of Flavor objects	Lists the flavors.
page_info	PageInfo object	Shows pagination information about the load balancer flavors.
request_id	String	Specifies the request ID. Note: The value is automatically generated.

**Table 5** Flavor
Parameter	Type	Description
id	String	Specifies the flavor ID.
info	FlavorInfo object	Specifies the flavor metrics.
name	String	Specifies the flavor name. Network load balancers have the following flavors: L4_flavor.elb.s1.small: small I L4_flavor.elb.s2.small: small II L4_flavor.elb.s1.medium: medium I L4_flavor.elb.s2.medium: medium II L4_flavor.elb.s1.large: large I L4_flavor.elb.s2.large: large II L4_flavor.elb.pro.max: elastic flavor at Layer 4 Application load balancers have the following flavors: L7_flavor.elb.s1.small: small I L7_flavor.elb.s2.small: small II L7_flavor.elb.s1.medium: medium I L7_flavor.elb.s2.medium: medium II L7_flavor.elb.s1.large: large I L7_flavor.elb.s2.large: large II L7_flavor.elb.s1.extra-large: extra-large I L7_flavor.elb.s2.extra-large: extra-large II L7_flavor.elb.pro.max: elastic flavor at Layer 7
shared	Boolean	Specifies whether the flavor is available to all users. true indicates that the flavor is available to all users. false indicates that the flavor is available only to a specific user.
project_id	String	Specifies the project ID.
type	String	Specifies the flavor type. The type can be: L4 indicates a Layer 4 flavor. L7 indicates a Layer 7 flavor. L4_elastic indicates the minimum elastic flavor at Layer 4. This parameter has been discarded. Please do not use it. L7_elastic indicates the minimum elastic flavor at Layer 7. This parameter has been discarded. Please do not use it. L4_elastic_max indicates the maximum elastic flavor at Layer 4. L7_elastic_max indicates the maximum elastic flavor at Layer 7.
flavor_sold_out	Boolean	Specifies whether the flavor is available. true indicates the flavor is unavailable. false indicates the flavor is available.
public_border_group	String	Specifies the public border group, for example, center.
category	Integer	Specifies the public border group code. 0 indicates center. 21 indicates homezone.

**Table 6** FlavorInfo
Parameter	Type	Description
connection	Integer	Specifies the number of concurrent connections per second.
cps	Integer	Specifies the number of new connections per second.
qps	Integer	Specifies the number of requests per second. This parameter is available only for load balancers at Layer 7.
bandwidth	Integer	Specifies the bandwidth, in kbit/s
lcu	Integer	Specifies the number of LCUs in the flavor. NOTE: An LCU measures the dimensions on which a dedicated load balancer routes the traffic. The higher value indicates better performance.
https_cps	Integer	Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7.

**Table 7** PageInfo
Parameter	Type	Description
previous_marker	String	Specifies the ID of the first record in the pagination query result. When page_reverse is set to true, this parameter is used together to query resources on the previous page.
next_marker	String	Specifies the ID of the last record in the pagination query result.
current_count	Integer	Specifies the number of records.

Example Requests

Querying load balancer flavors

GET https://{ELB_Endpoint}/v3/057ef081eb00d2732fd1c01a9be75e6f/elb/flavors?limit=2&marker=179568ef-5ba4-4ca0-8c5e-5d581db779b1

Example Responses

Status code: 200

Successful request.

{
  "request_id" : "01e84c2750b7217e5903b3d3bc9a9fda",
  "flavors" : [ {
    "name" : "L7_flavor.basic.elb.s1.small",
    "shared" : true,
    "project_id" : "060576798a80d5762fafc01a9b5eedc7",
    "info" : {
      "bandwidth" : 50000,
      "connection" : 200000,
      "cps" : 2000,
      "https_cps" : 200,
      "lcu" : 10,
      "qps" : 4000
    },
    "id" : "037418d4-8c9e-40b8-9e54-70ff4848fd82",
    "type" : "L7_basic",
    "flavor_sold_out" : false,
    "public_border_group" : "center",
    "category" : 0
  }, {
    "name" : "L4_flavor.elb.s2.small",
    "shared" : true,
    "project_id" : "8d53f081ea24444aa95e2bfa942ef6ee",
    "info" : {
      "bandwidth" : 100000,
      "connection" : 1000000,
      "cps" : 20000,
      "lcu" : 20
    },
    "id" : "03925294-4ae2-4cdb-b912-cf171e782095",
    "type" : "L4",
    "flavor_sold_out" : false,
    "public_border_group" : "center",
    "category" : 0
  } ],
  "page_info" : {
    "next_marker" : "03925294-4ae2-4cdb-b912-cf171e782095",
    "previous_marker" : "037418d4-8c9e-40b8-9e54-70ff4848fd82",
    "current_count" : 2
  }
}