Updating Load Balancing Listeners for a Cluster
Function
This API is used to update load balancing listeners for a cluster.
Calling Method
For details, see Calling APIs.
URI
PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}
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 target cluster. 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 |
listener_id |
Yes |
String |
ID of the target listener. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
listener |
Yes |
EsListenerRequest object |
Listener object |
type |
No |
String |
Type: searchTool indicates that the load balancer is modified for Elasticsearch/OpenSearch. viewTool indicates that the load balancer is modified for Kibana/OpenSearch Dashboards. The default value is searchTool. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
default_tls_container_ref |
Yes |
String |
ID of the server certificate used by the listener |
client_ca_tls_container_ref |
No |
String |
ID of the CA certificate used by the listener. This parameter is mandatory when bidirectional authentication is to be updated. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
listener |
EsListenerResponse object |
Listener object |
Parameter |
Type |
Description |
---|---|---|
protocol |
String |
Protocol used by the listener |
id |
String |
Listener ID |
name |
String |
Listener name |
protocol_port |
String |
Port used by the listener |
ipgroup |
EsIpgroupResource object |
Access control information of the listener object |
Parameter |
Type |
Description |
---|---|---|
ipgroup_id |
String |
Definition: ID of the access control group associated with the listener. Value range: N/A |
enable_ipgroup |
Boolean |
Definition: Status of an access control group. Value range:
|
type |
String |
Definition: Type of an access control group. Value range:
|
Example Requests
Update ELB listeners for a cluster.
PUT https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/es-listeners/4425eb63-78ce-4c63-b60e-492befdac0e7 { "listener" : { "default_tls_container_ref" : "9c82320a8dd049eba49b28e70a2c0c3e" } }
Example Responses
Status code: 200
Request succeeded.
{ "listener" : { "id" : "9c82320a8dd049eba49b28e70a2c0c3e", "name" : "name", "protocol" : "tcp", "protocol_port" : 8080, "ipgroup" : { "ipgroup_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3", "enable_ipgroup" : true, "type" : "white" } } }
SDK Sample Code
The SDK sample code is as follows.
Java
Update 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 UpdateEsListenerSolution { 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(); UpdateEsListenerRequest request = new UpdateEsListenerRequest(); request.withClusterId("{cluster_id}"); request.withListenerId("{listener_id}"); UpdateEsListenerRequestBody body = new UpdateEsListenerRequestBody(); EsListenerRequest listenerbody = new EsListenerRequest(); listenerbody.withDefaultTlsContainerRef("9c82320a8dd049eba49b28e70a2c0c3e"); body.withListener(listenerbody); request.withBody(body); try { UpdateEsListenerResponse response = client.updateEsListener(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
Update 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 |
# 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 = UpdateEsListenerRequest() request.cluster_id = "{cluster_id}" request.listener_id = "{listener_id}" listenerbody = EsListenerRequest( default_tls_container_ref="9c82320a8dd049eba49b28e70a2c0c3e" ) request.body = UpdateEsListenerRequestBody( listener=listenerbody ) response = client.update_es_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
Update 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 |
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.UpdateEsListenerRequest{} request.ClusterId = "{cluster_id}" request.ListenerId = "{listener_id}" listenerbody := &model.EsListenerRequest{ DefaultTlsContainerRef: "9c82320a8dd049eba49b28e70a2c0c3e", } request.Body = &model.UpdateEsListenerRequestBody{ Listener: listenerbody, } response, err := client.UpdateEsListener(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot