Querying Flavors

Updated on 2024-08-19 GMT+08:00

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. Minimum: 0 Maximum: 2000 Default: 2000
page_reverse	No	Boolean	Specifies whether to use reverse query. Values: 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	Specifies the flavor ID. Multiple IDs can be queried in the format of id=xxx&id=xxx.
name	No	Array	Specifies the flavor name. Multiple names can be queried in the format of name=xxx&name=xxx.
type	No	Array	Specifies the flavor type. The type can be: L4 indicates a Layer-4 flavor. L7 indicates a Layer-7 flavor. gateway indicates the flavor of a gateway load balancer. L4_elastic indicates the minimum Layer-4 flavor for elastic scaling. L7_elastic indicates the minimum Layer-7 flavor for elastic scaling. L4_elastic_max indicates the maximum Layer-4 flavor for elastic scaling. L7_elastic_max indicates the maximum Layer-7 flavor for elastic scaling. gateway_elastic_max indicates the maximum falvor for elastic scaling. Multiple types can be queried in the format of type=xxx&type=xxx.
loadbalancer_type	No	Array	Specifies the load balancer type.The type can be: gateway: indicates a gateway load balancer. null (default): indicates other types of load balancers.
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.

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. 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. L4_flavor.elb.s1.small L4_flavor.elb.s2.small L4_flavor.elb.s1.medium L4_flavor.elb.s2.medium L4_flavor.elb.s1.large L4_flavor.elb.s2.large L4_flavor.elb.pro.max L7_flavor.elb.s1.small L7_flavor.elb.s2.small L7_flavor.elb.s1.medium L7_flavor.elb.s2.medium L7_flavor.elb.s1.large L7_flavor.elb.s2.large L7_flavor.elb.s1.extra-large L7_flavor.elb.s2.extra-large L7_flavor.elb.pro.max
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. gateway indicates the flavor of a gateway load balancer. L4_elastic indicates the minimum Layer-4 flavor for elastic scaling. L7_elastic indicates the minimum Layer-7 flavor for elastic scaling. L4_elastic_max indicates the maximum Layer-4 flavor for elastic scaling. L7_elastic_max indicates the maximum Layer-7 flavor for elastic scaling. gateway_elastic_max indicates the maximum falvor for elastic scaling. Minimum: 1 Maximum: 32
flavor_sold_out	Boolean	Specifies the flavor is available. true indicates you can create a load balancer with this flavor. false indicates you cannot create a load balancer with this flavor.
public_border_group	String	Specifies the AZ group, for example, center.
category	Integer	Specifies the AZ 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.
lcu	Integer	Specifies the number of LCUs in the flavor. 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.
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
  }, {
    "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
  } ],
  "page_info" : {
    "next_marker" : "03925294-4ae2-4cdb-b912-cf171e782095",
    "previous_marker" : "037418d4-8c9e-40b8-9e54-70ff4848fd82",
    "current_count" : 2
  }
}