Help Center/ Cloud Search Service/ API Reference/ API V1/ Load Balancing/ Configuring Load Balancing Listeners for a Cluster
Updated on 2025-08-15 GMT+08:00

Configuring Load Balancing Listeners for a Cluster

Function

This API is used to configure load balancing listeners for a cluster.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster that you want to rename. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

protocol

Yes

String

Protocol type. HTTP and HTTPS are supported.

protocol_port

Yes

Integer

Port

server_cert_id

No

String

Server certificate ID. This parameter is mandatory when protocol is set to HTTPS.

ca_cert_id

No

String

ID of the CA certificate. This parameter is mandatory when protocol is set to HTTPS and bidirectional authentication is used.

type

No

String

Type: searchTool indicates that the listener is configured for Elasticsearch/OpenSearch. viewTool indicates that the listener is configured for Kibana/OpenSearch Dashboards. The default value is searchTool.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

elb_id

String

Load balancer ID.

Example Requests

Configure ELB listeners for a cluster.

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

{
  "protocol" : "HTTPS",
  "protocol_port" : 9200,
  "server_cert_id" : "1b74ae4afad741e6bc9497429d3d0838",
  "ca_cert_id" : "2a7b050f598e4ea8a61cffbe2bdb312f"
}

Example Responses

Status code: 200

Request succeeded.

{
  "elb_id" : "56a83547-a55a-407a-8245-7f9b3a0606c0"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Configure ELB listeners for a cluster.

 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
50
51
52
53
54
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 CreateElbListenerSolution {

    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();
        CreateElbListenerRequest request = new CreateElbListenerRequest();
        request.withClusterId("{cluster_id}");
        CreateEsListenerRequestBody body = new CreateEsListenerRequestBody();
        body.withCaCertId("2a7b050f598e4ea8a61cffbe2bdb312f");
        body.withServerCertId("1b74ae4afad741e6bc9497429d3d0838");
        body.withProtocolPort(9200);
        body.withProtocol("HTTPS");
        request.withBody(body);
        try {
            CreateElbListenerResponse response = client.createElbListener(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

Configure ELB listeners for a cluster.

 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
# 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 = CreateElbListenerRequest()
        request.cluster_id = "{cluster_id}"
        request.body = CreateEsListenerRequestBody(
            ca_cert_id="2a7b050f598e4ea8a61cffbe2bdb312f",
            server_cert_id="1b74ae4afad741e6bc9497429d3d0838",
            protocol_port=9200,
            protocol="HTTPS"
        )
        response = client.create_elb_listener(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

Configure ELB listeners for a cluster.

 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
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.CreateElbListenerRequest{}
	request.ClusterId = "{cluster_id}"
	caCertIdCreateEsListenerRequestBody:= "2a7b050f598e4ea8a61cffbe2bdb312f"
	serverCertIdCreateEsListenerRequestBody:= "1b74ae4afad741e6bc9497429d3d0838"
	request.Body = &model.CreateEsListenerRequestBody{
		CaCertId: &caCertIdCreateEsListenerRequestBody,
		ServerCertId: &serverCertIdCreateEsListenerRequestBody,
		ProtocolPort: int32(9200),
		Protocol: "HTTPS",
	}
	response, err := client.CreateElbListener(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.