文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 负载均衡/ 获取集群的负载均衡器信息
更新时间:2025-08-15 GMT+08:00

获取集群的负载均衡器信息

功能介绍

云搜索服务集成了共享型负载均衡器的能力,支持绑定公网访问和开启终端节点服务。相比共享型负载均衡器,独享型负载均衡器功能更丰富、性能更强。

该接口用于获取集群的负载均衡器信息,包括服务器证书名称、服务器证书ID、弹性负载均衡开关信息、负载均衡器对象信息、监听对象信息、健康检查结果等。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待查询的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释

搜索类型。

约束限制

不涉及

取值范围

  • searchTool:表示查询Elasticsearch/Opensearch负载均衡器详情。

默认取值

searchTool

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

serverCertName

String

参数解释

服务器证书名称。

取值范围

不涉及

serverCertId

String

参数解释

服务器证书ID。

取值范围

不涉及

cacertName

String

参数解释

CA证书名称。

取值范围

不涉及

cacertId

String

参数解释

CA证书ID。

取值范围

不涉及

elb_enable

Boolean

参数解释

弹性负载均衡开关信息。

取值范围

  • true:打开弹性负载均衡开关。

  • false:关闭弹性负载均衡负载开关。

authentication_type

String

参数解释

认证方式。

取值范围

  • single:单边认证类型。

  • double:双边认证类型。

loadBalancer

LoadBalancer object

参数解释

负载均衡器对象信息。

取值范围

不涉及

listener

Elbv3Listener object

参数解释

监听器对象信息。

取值范围

不涉及

healthmonitors

Array of Member objects

参数解释

健康检查结果集合。

取值范围

不涉及

表4 LoadBalancer

参数

参数类型

描述

id

String

参数解释

负载均衡器ID。

取值范围

不涉及

name

String

参数解释

负载均衡器名称。

取值范围

不涉及

guaranteed

String

参数解释

是否独享型负载均衡器。

取值范围

  • false:共享型。

  • true:独享型。

billing_info

String

参数解释

资源账单信息。

取值范围

  • 空:按需计费。

  • 非空:包周期计费。

description

String

参数解释

描述信息。

取值范围

不涉及

vpc_id

String

参数解释

负载均衡器所属VPC ID,即虚拟私有云ID。

取值范围

不涉及

provisioning_status

String

参数解释

负载均衡器的配置状态。

取值范围

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

listeners

Array of IdListWrapper objects

参数解释

关联的listener列表。

取值范围

不涉及

vip_address

String

参数解释

负载均衡器的IPv4虚拟IP地址。

取值范围

不涉及

vip_port_id

String

参数解释

负载均衡器的IPv4对应的port ID。

取值范围

不涉及

ipv6_vip_address

String

参数解释

负载均衡器的IPv6地址。

取值范围

不涉及

publicips

Array of PublicIpInfo objects

参数解释

负载均衡器绑定的公网IP。

取值范围

不涉及

表5 IdListWrapper

参数

参数类型

描述

id

String

参数解释

监听器ID。

取值范围

不涉及

表6 PublicIpInfo

参数

参数类型

描述

publicip_id

String

参数解释

弹性公网IP配置ID。

取值范围

不涉及

publicip_address

String

参数解释

弹性公网IP地址。

取值范围

不涉及

ip_version

Integer

参数解释

IP版本信息。

取值范围

  • 4:IPv4。

  • 6:IPv6。

表7 Elbv3Listener

参数

参数类型

描述

id

String

参数解释

监听器ID。

取值范围

不涉及

name

String

参数解释

监听器的名称。

取值范围

不涉及

protocol

String

参数解释

监听器的监听协议。

取值范围

不涉及

protocol_port

Integer

参数解释

监听器的前端监听端口。

取值范围

不涉及

ipgroup

ListenerIpGroup object

参数解释

listener对象中的ipgroup信息。

取值范围

不涉及

表8 ListenerIpGroup

参数

参数类型

描述

ipgroup_id

String

参数解释

监听器关联的访问控制组的ID。创建时必选,更新时非必选。

取值范围

不涉及

enable_ipgroup

Boolean

参数解释

访问控制组的状态。

取值范围

  • True:开启访问控制.

  • False:关闭访问控制。

表9 Member

参数

参数类型

描述

name

String

参数解释

后端服务器名称。

取值范围

不涉及

address

String

参数解释

后端服务器对应的IP地址。

取值范围

不涉及

protocol_port

Integer

参数解释

后端服务器业务端口号。

取值范围

不涉及

operating_status

String

参数解释

后端云服务器的健康状态。

取值范围

  • ONLINE:后端云服务器正常。

  • NO_MONITOR:后端云服务器所在的服务器组没有健康检查器。

  • OFFLINE:后端云服务器关联的ECS服务器不存在或已关机。

instance_id

String

参数解释

member关联的实例ID。

取值范围

空表示member关联的实例为非真实设备。

请求示例

获取集群的负载均衡信息。

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners

响应示例

状态码:200

请求已成功。

{
  "loadBalancer" : {
    "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
    "name" : "elb-css",
    "guaranteed" : "true",
    "description" : "",
    "listeners" : [ {
      "id" : "011d14fa-908b-4cd9-b0d6-0768ddc6cb71"
    }, {
      "id" : "04b86029-c281-4490-a3bd-5ea1266658ba"
    } ],
    "publicips" : [ {
      "publicip_id" : "f678e23c-96a5-49e8-8ea2-bd8b47d41e78",
      "publicip_address" : "100.1.1.1",
      "ip_version" : 4
    } ],
    "vpc_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
    "provisioning_status" : "ACTIVE",
    "vip_address" : "10.0.0.1",
    "ipv6_vip_address" : "2409:27ff:2003:3e:1fd::f3"
  },
  "listener" : {
    "id" : "41ff041d-c7b9-4142-9167-fa93d54f97da",
    "name" : "css-searchServer",
    "protocol" : "HTTPS",
    "protocol_port" : 9265
  },
  "healthmonitors" : [ {
    "instance_id" : "bac86342-2222-43e6-817f-57f040a174a6",
    "name" : "",
    "address" : "10.0.0.87",
    "protocol_port" : 9200,
    "operating_status" : "ONLINE"
  }, {
    "instance_id" : "d935b82c-f94b-4ae0-9997-ddc90885d8c6",
    "name" : "",
    "address" : "10.0.0.61",
    "protocol_port" : 9200,
    "operating_status" : "ONLINE"
  } ],
  "serverCertName" : "server1",
  "serverCertId" : "82375af01c0d40f6a44c15962c570625",
  "elb_enable" : true,
  "authentication_type" : "single"
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;


public class ShowElbDetailSolution {

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

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowElbDetailRequest request = new ShowElbDetailRequest();
        request.withClusterId("{cluster_id}");
        try {
            ShowElbDetailResponse response = client.showElbDetail(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 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 = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowElbDetailRequest()
        request.cluster_id = "{cluster_id}"
        response = client.show_elb_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/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 := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

更多

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码