更新时间:2024-08-08 GMT+08:00
分享

查询规格列表

功能介绍

查询当前region下可用的负载均衡规格列表。

接口约束

  • 分页查询使用的参数为marker、limit、page_reverse。

  • marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/elb/flavors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

参数解释:上一页最后一条记录的ID。

使用说明:

  • 必须与limit一起使用。

  • 不指定时表示查询第一页。

  • 该字段不允许为空或无效的ID。

limit

Integer

参数解释:每页返回的个数。

取值范围:0-2000

默认取值:2000

page_reverse

Boolean

参数解释:是否反向查询。

约束限制:

  • 必须与limit一起使用。

  • 当page_reverse=true时,若要查询上一页,marker取值为当前页返回值的previous_marker。

取值范围:

  • true:查询上一页。

  • false:查询下一页,默认。

id

Array

参数解释:规格ID。

支持多值查询,查询条件格式:id=xxx&id=xxx

name

Array

参数解释:规格名称。

支持多值查询,查询条件格式:name=xxx&name=xxx

type

Array

参数解释:规格类别。

取值范围:

  • L4和L7 表示四层网络型和七层应用型flavor。

  • L4_elastic和L7_elastic 表示弹性扩缩容实例的下限规格。

  • L4_elastic_max、L7_elastic_max 表示弹性扩缩容实例的上限规格。

支持多值查询,查询条件格式:type=xxx&type=xxx

shared

Boolean

参数解释:是否查询公共规格。

取值范围:true表示公共规格,所有租户可见。false表示私有规格,为当前租户所有。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释: IAM鉴权Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

flavors

Array of Flavor objects

参数解释:规格列表。

page_info

PageInfo object

参数解释:规格分页信息。

request_id

String

参数解释:请求ID。

注:自动生成 。

表5 Flavor

参数

参数类型

描述

id

String

参数解释:规格ID。

info

FlavorInfo object

参数解释:规格相关的指标。

name

String

参数解释:规格名称。

取值范围:

网络型有如下规格:

  • L4_flavor.elb.s1.small: 小型 I

  • L4_flavor.elb.s2.small: 小型 II

  • L4_flavor.elb.s1.medium: 中型 I

  • L4_flavor.elb.s2.medium: 中型 II

  • L4_flavor.elb.s1.large: 大型 I

  • L4_flavor.elb.s2.large: 大型 II

  • L4_flavor.elb.pro.max: 四层弹性规格

应用型有如下规格:

  • L7_flavor.elb.s1.small: 小型 I

  • L7_flavor.elb.s2.small: 小型 II

  • L7_flavor.elb.s1.medium: 中型 I

  • L7_flavor.elb.s2.medium: 中型 II

  • L7_flavor.elb.s1.large: 大型 I

  • L7_flavor.elb.s2.large: 大型 II

  • L7_flavor.elb.s1.extra-large: 超大型 I

  • L7_flavor.elb.s2.extra-large: 超大型 II

  • L7_flavor.elb.pro.max: 七层弹性规格

shared

Boolean

参数解释:是否公共规格。

取值范围:

  • true表示公共规格,所有租户可见。

  • false表示私有规格,为当前租户所有。

project_id

String

参数解释:项目ID。

type

String

参数解释:规格类别。

取值范围:

  • L4和L7 表示四层网络型和七层应用型flavor。

  • L4_elastic和L7_elastic 表示弹性扩缩容实例的下限规格。已废弃,请勿使用。

  • L4_elastic_max、L7_elastic_max 表示弹性扩缩容实例的上限规格。

flavor_sold_out

Boolean

参数解释:

是否售罄。

取值范围:

  • true:已售罄,将无法购买该规格的LB。

  • false:未售罄,可购买该规格的LB。

public_border_group

String

参数解释:可用区组,如:center

category

Integer

参数解释:可用区组编码。

取值范围:0表示center,21表示homezone。

表6 FlavorInfo

参数

参数类型

描述

connection

Integer

参数解释:并发数。单位:个。

cps

Integer

参数解释:新建数。单位:个。

qps

Integer

参数解释:每秒查询数。单位:个。

约束限制:仅7层LB有该指标。

bandwidth

Integer

参数解释:带宽。单位:Kbit/s。

lcu

Integer

参数解释:当前flavor对应的lcu数量。单位:个。

说明:

LCU是用来衡量独享型ELB处理性能综合指标,LCU值越大,性能越好。

https_cps

Integer

参数解释:https新建连接数。单位:个。

约束限制:仅7层LB有该指标。

表7 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释:分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

参数解释:分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

参数解释:当前的记录数。

请求示例

查询支持的负载均衡规格列表

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

响应示例

状态码: 200

参数解释:操作正常返回。

{
  "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
  }
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class ListFlavorsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        ListFlavorsRequest request = new ListFlavorsRequest();
        try {
            ListFlavorsResponse response = client.listFlavors(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListFlavorsRequest()
        response = client.list_flavors(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListFlavorsRequest{}
	response, err := client.ListFlavors(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释:操作正常返回。

错误码

请参见错误码

相关文档