文档首页> 云搜索服务 CSS> API参考> 负载均衡> 更新ES监听器
更新时间：2024-04-22 GMT+08:00
查看PDF

更新ES监听器

功能介绍

该接口用于更新ES监听器。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定待操作的集群ID。

listener_id

是

String

指定待操作得监听器ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

listener

是

EsListenerRequest object

监听器对象。
表3 EsListenerRequest

参数

是否必选

参数类型

描述

default_tls_container_ref

是

String

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

client_ca_tls_container_ref

否

String

监听器使用的CA证书ID。如果更新双向认证，则该参数为必选。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

listener

EsListenerResponse object

监听器对象。
表5 EsListenerResponse

参数

参数类型

描述

protocol

String

监听器的监听协议。

id

String

监听器ID。

name

String

监听器的名称。

protocol_port

String

监听器的前端监听端口。

ipgroup

EsIpgroupResource object

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

参数

参数类型

描述

ipgroup_id

String

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

enable_ipgroup

Boolean

访问控制组的状态。

type

String

访问控制组的类型。

请求示例

PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/es-listeners/4425eb63-78ce-4c63-b60e-492befdac0e7

{
  "listener" : {
    "default_tls_container_ref" : "9c82320a8dd049eba49b28e70a2c0c3e"
  }
}

响应示例

状态码： 200

请求已成功。

{
  "listener" : {
    "id" : "9c82320a8dd049eba49b28e70a2c0c3e",
    "name" : "name",
    "protocol" : "tcp",
    "protocol_port" : 8080,
    "ipgroup" : {
      "ipgroup_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
      "enable_ipgroup" : true,
      "type" : "white"
    }
  }
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。

父主题： 负载均衡