文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 负载均衡/ 为集群打开或关闭负载均衡器
更新时间:2025-08-14 GMT+08:00
分享

为集群打开或关闭负载均衡器

功能介绍

该接口为集群打开或关闭负载均衡器

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待更改的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enable

Boolean

参数解释

打开或关闭es负载均衡器。

约束限制

不涉及

取值范围

  • true:开启。

  • false:关闭。

默认取值

不涉及

agency

String

参数解释

用于配置负载均衡的委托名称,当enable为true时必选。

约束限制

不涉及

取值范围

不涉及

默认值

不涉及

elb_id

String

参数解释

负载均衡器ID,当enable为true时必选。

约束限制

不涉及

取值范围

不涉及

默认值

不涉及

type

String

参数解释

负载均衡器类型。当用于可观测集群时:不需要配置此参数。

约束限制

不涉及

取值范围

  • searchTool:打开或关闭Elasticsearch/Opensearch负载均衡器。

  • viewTool:打开或关闭Kibana/Opensearch Dashboard负载均衡器。

默认值

searchTool

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

elb_id

String

负载均衡器ID。

请求示例

开启负载均衡器。

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"
}

响应示例

状态码:200

请求已成功。

{
  "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268"
}

SDK代码示例

SDK代码示例如下。

开启负载均衡器。

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

开启负载均衡器。

 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)

开启负载均衡器。

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

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码

相关文档