文档首页/ 数据仓库服务 DWS/ API参考/ API说明/ 连接管理/ 查询可用弹性负载均衡列表 - ListElbsInfo
更新时间:2026-09-18 GMT+08:00

查询可用弹性负载均衡列表 - ListElbsInfo

功能介绍

查询可用弹性负载均衡列表,该接口是对ELB提供的openapi的封装,针对DWS进行了部分筛选,且不含已经被其它dws集群绑定的弹性负载均衡器。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/elbs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

vpc_id

String

参数解释

虚拟私有云ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

subnet_id

String

参数解释

子网ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

limit

Integer

参数解释

分页单页大小。

约束限制

不涉及。

取值范围

大于0。

默认取值

10

offset

Integer

参数解释

分页偏移量,从0开始,页数减1。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

elbs

Array of ClusterElbInfo objects

参数解释

弹性负载均衡列表。

取值范围

不涉及。

count

Integer

参数解释

总条数。

取值范围

不涉及。

表4 ClusterElbInfo

参数

参数类型

描述

id

String

参数解释

弹性负载均衡ID。

取值范围

不涉及。

cluster_id

String

参数解释

集群ID。

取值范围

36位UUID。

name

String

参数解释

弹性负载均衡名称。

取值范围

不涉及。

description

String

参数解释

弹性负载均衡描述。

取值范围

不涉及。

vip_address

String

参数解释

弹性负载均衡地址。

取值范围

不涉及。

vip_subnet_id

String

参数解释

子网ID。

取值范围

不涉及。

tenant_id

String

参数解释

租户ID。

取值范围

不涉及。

type

String

参数解释

弹性负载均衡类型。

取值范围

Internal:独享型。

External:共享型。

admin_state_up

Boolean

参数解释

弹性负载均衡的管理状态。

取值范围

true:使用中

false:未使用

bandwidth

Integer

参数解释

带宽信息。

取值范围

大于等于0的非负整数。

vpc_id

String

参数解释

虚拟私有云ID。

取值范围

不涉及。

ip_target_enable

Boolean

参数解释

是否支持跨vpc绑定。

取值范围

不涉及。

请求示例

查询可用弹性负载均衡列表。

get https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/elbs?vpc_id=&subnet_id=&limit=10&offset=0

响应示例

状态码:200

{
  "elbs" : [ {
    "id" : "f49170e1-be96-426a-8a53-952f6b82972f",
    "name" : "elb-y30024403-128clu",
    "bandwidth" : 0,
    "vip_address" : "192.168.142.236",
    "admin_state_up" : true,
    "vpc_id" : "301f66cf-af45-4b1c-b465-c2f0cc43f057",
    "ip_target_enable" : false
  } ],
  "count" : 1
}

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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListElbsInfoSolution {

    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);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListElbsInfoRequest request = new ListElbsInfoRequest();
        try {
            ListElbsInfoResponse response = client.listElbsInfo(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 huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 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 = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListElbsInfoRequest()
        response = client.list_elbs_info(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
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dws.DwsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dws.NewDwsClient(hcClient)

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

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

状态码

状态码

描述

200

获取弹性负载均衡列表成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。