Querying Flavors
Function
This API is used to query all available load balancer flavors in a specific region. You can specify these Layer 4 or Layer 7 flavors when creating a dedicated load balancer.
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
marker |
No |
String |
Definition: Specifies the ID of the last record on the previous page. Constraints:
Range: N/A Default value: N/A |
limit |
No |
Integer |
Definition: Specifies the number of records returned on each page. Constraints: N/A Range: 0 to 2000 Default value: 2000 |
page_reverse |
No |
Boolean |
Definition: Specifies whether to use reverse query. Constraints:
Range:
Default value: false |
id |
No |
Array of strings |
Definition: Specifies the flavor ID. Multiple IDs can be used for query in the format of id=xxx&id=xxx. Constraints: N/A Range: N/A Default value: N/A |
name |
No |
Array of strings |
Definition: Specifies the flavor name. Multiple names can be used for query in the format of name=xxx&name=xxx. Constraints: N/A Range: N/A Default value: N/A |
type |
No |
Array of strings |
Definition: Specifies the flavor type. Multiple types can be used for query in the format of type=xxx&type=xxx. Constraints: N/A Range:
Default value: N/A |
loadbalancer_type |
No |
Array of strings |
Definition: Specifies the load balancer type. Constraints: N/A Range:
Default value: N/A |
shared |
No |
Boolean |
Definition: Specifies whether to query the flavors available to all uses. Constraints: N/A Range:
Default value: N/A |
public_border_group |
No |
Array of strings |
Definition: Specifies the public border group. Multiple public border groups can be queried in the format of public_border_group=xxx&public_border_group=xxx. Constraints: N/A Range:
Default value: N/A |
category |
No |
Array of integers |
Definition: Specifies the AZ category code. This parameter is used to identify the type of an edge AZ. Multiple categories can be used for query in the format of category=xxx&category=xxx. Constraints: N/A Range: 0 (central AZs), 21 (HomeZones AZs), and 41 (edge AZs) Default value: N/A |
list_all |
No |
Boolean |
Definition: Whether to query all the maximum elastic flavors of a specific user. Constraints: N/A Range:
Default value: N/A |
flavor_sold_out |
No |
Boolean |
Specifies whether load balancers of this flavor are unavailable.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
flavors |
Array of Flavor objects |
Definition: Specifies the flavor list. |
page_info |
PageInfo object |
Definition: Specifies the pagination information. |
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the flavor ID. Range: N/A |
info |
FlavorInfo object |
Definition: Specifies the flavor metrics. Range: N/A |
name |
String |
Definition: Specifies the flavor name. Range: Network load balancers have the following flavors:
Application load balancers have the following flavors:
|
shared |
Boolean |
Definition: Specifies whether the flavor is available to all users. Range:
|
project_id |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. |
type |
String |
Definition: Specifies the flavor type. Range:
|
flavor_sold_out |
Boolean |
Definition: Specifies whether load balancers of this flavor cannot be purchased. Range:
|
public_border_group |
String |
Definition: Specifies the public border group. Range:
|
category |
Integer |
Definition: Specifies the AZ category code. This parameter is used to identify the type of an edge AZ. Range: 0 (central AZs), 21 (HomeZones AZs), and 41 (edge AZs) |
Parameter |
Type |
Description |
---|---|---|
connection |
Integer |
Definition: Specifies the maximum number of concurrent connections per second. Unit: count Range: N/A |
cps |
Integer |
Definition: Specifies the number of new connections per second. Unit: count Range: N/A |
qps |
Integer |
Definition: Specifies the number of queries per second (QPS). Unit: count This parameter is available only for load balancers at Layer 7. Range: N/A |
bandwidth |
Integer |
Definition: Specifies the bandwidth, in kbit/s. Range: N/A |
lcu |
Integer |
Definition: Specifies the number of LCUs supported by the flavor. Unit: count Range: N/A
NOTE:
An LCU measures the dimensions on which a dedicated load balancer routes the traffic. A higher value indicates better performance.
|
https_cps |
Integer |
Definition: Specifies the number of new HTTPS connections. This parameter is available only for load balancers at Layer 7. Unit: count Range: N/A |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A |
next_marker |
String |
Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A |
current_count |
Integer |
Definition: Specifies the number of records returned on the current page. Range: N/A |
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 } }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.