Enabling or Disabling Load Balancers for a Cluster
Function
CSS can interconnect with ELB. This API is used to enable or disable load balancers for clusters.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
css:cluster:elbSwitch
Write
cluster *
-
- elb:loadbalancers:list
- iam:agencies:listAgencies
- iam:permissions:listRolesForAgency
- iam:permissions:listRolesForAgencyOnProject
- iam:agencies:pass
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch
| 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 to be modified. 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| enable | Yes | Boolean | Definition Enables or disables an Elasticsearch or OpenSearch load balancer. Constraints N/A Range Default Value N/A |
| agency | No | String | Definition: Specifies the name of the agency used for load balancing. Constraints: This parameter is mandatory when enable is set to true. Value range: N/A Default value: N/A |
| elb_id | No | String | Definition Load balancer ID. For details, see [Querying Load Balancers]https://support.huaweicloud.com/api-elb/ListLoadBalancers.html](tag:hws)[[Querying Load Balancers]https://support.huaweicloud.com/intl/en-us/api-elb/ListLoadBalancers.html. Constraints This parameter is mandatory when enable is set to true. Range N/A Default Value N/A |
| type | No | String | Definition Load balancer type. Constraints This parameter is not required for an observability cluster. Range searchTool: Enables or disables an Elasticsearch or OpenSearch load balancer. Default Value searchTool |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| elb_id | String | Definition: Load balancer ID. Value range: N/A. |
Example Requests
Enable the load balancer.
POST https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch
{
"enable" : true,
"elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
"agency" : "css_elb_agency"
} Example Responses
Status code: 200
Request succeeded.
{
"elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268"
} SDK Sample Code
The SDK sample code is as follows.
Java
Enable the load balancer.
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 | 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 EnableOrDisableElbSolution { 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(); EnableOrDisableElbRequest request = new EnableOrDisableElbRequest(); request.withClusterId("{cluster_id}"); UpdateEsElbRequestBody body = new UpdateEsElbRequestBody(); body.withElbId("5d45faad-6cb3-479b-96b8-3e2de0cc6268"); body.withAgency("css_elb_agency"); body.withEnable(true); request.withBody(body); try { EnableOrDisableElbResponse response = client.enableOrDisableElb(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
Enable the load balancer.
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 | # 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 = EnableOrDisableElbRequest() request.cluster_id = "{cluster_id}" request.body = UpdateEsElbRequestBody( elb_id="5d45faad-6cb3-479b-96b8-3e2de0cc6268", agency="css_elb_agency", enable=True ) response = client.enable_or_disable_elb(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
Enable the load balancer.
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.EnableOrDisableElbRequest{} request.ClusterId = "{cluster_id}" elbIdUpdateEsElbRequestBody:= "5d45faad-6cb3-479b-96b8-3e2de0cc6268" agencyUpdateEsElbRequestBody:= "css_elb_agency" request.Body = &model.UpdateEsElbRequestBody{ ElbId: &elbIdUpdateEsElbRequestBody, Agency: &agencyUpdateEsElbRequestBody, Enable: true, } response, err := client.EnableOrDisableElb(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