Configuring Load Balancing Listeners for a Cluster
Function
This API is used to configure load balancing listeners for a cluster.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/es-listeners
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. |
cluster_id |
Yes |
String |
ID of the cluster that you want to rename. |
Request 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 |
CA certificate ID. 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
Parameter |
Type |
Description |
---|---|---|
elb_id |
String |
Load balancer ID |
Example Requests
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/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" }
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.