更新时间:2026-09-02 GMT+08:00

更新集群负载均衡监听器

功能介绍

云搜索服务支持对接ELB负载均衡,该接口用于更新集群负载均衡监听器配置信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定操作的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

listener_id

String

参数解释

指定操作的监听器ID。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

listener

EsListenerRequest object

参数解释

监听器信息。

约束限制

不涉及。

type

String

参数解释

配置类型。

约束限制

不涉及。

取值范围

searchTool:表示修改Elasticsearch/OpenSearch监听器配置。

默认取值

searchTool

表3 EsListenerRequest

参数

是否必选

参数类型

描述

default_tls_container_ref

String

参数解释

监听器使用的服务器证书ID。

约束限制

如果为HTTPS认证,则该参数为必选。

取值范围

不涉及

默认取值

不涉及

client_ca_tls_container_ref

String

参数解释

监听器使用的CA证书ID。

约束限制

如果为HTTPS双向认证,则该参数为必选。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

listener

EsListenerResponse object

参数解释

监听器对象。

表5 EsListenerResponse

参数

参数类型

描述

protocol

String

参数解释

监听器的监听协议。

取值范围

不涉及。

id

String

参数解释

监听器ID。

取值范围

不涉及。

name

String

参数解释

监听器的名称。

取值范围

不涉及。

protocol_port

String

参数解释

监听器的前端监听端口。

取值范围

不涉及。

default_tls_container_ref

String

参数解释

监听器使用的服务器证书ID。

取值范围

不涉及。

client_ca_tls_container_ref

String

参数解释

监听器使用的CA证书ID。

取值范围

不涉及。

ipgroup

EsIpgroupResource object

参数解释

listener对象中的访问控制信息。

表6 EsIpgroupResource

参数

参数类型

描述

ipgroup_id

String

参数解释

监听器关联的访问控制组的ID。

取值范围

不涉及

enable_ipgroup

Boolean

参数解释

访问控制组的状态。

取值范围

  • true:开启访问控制的监听器,允许直接删除。

  • false:关闭访问控制的监听器。

type

String

参数解释

访问控制组的类型。

取值范围

  • white:白名单,只允许指定IP访问。

  • black:黑名单,不允许指定IP访问。

请求示例

更新集群负载均衡监听器。

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

响应示例

状态码:200

请求成功。

{
  "listener" : {
    "id" : "a21b50ec-9cd5-4495-9398-b24a7e9afe5b",
    "name" : "css-55b6-searchServer",
    "protocol" : "HTTPS",
    "ipgroup" : {
      "ipgroup_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
      "enable_ipgroup" : true,
      "type" : "white"
    },
    "protocol_port" : 9200,
    "default_tls_container_ref" : "b5c45f342bcd435abc18760a13976a1d",
    "client_ca_tls_container_ref" : "4a2053a825a0471ba85a60468afa80cf"
  }
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码