文档首页/ 云搜索服务 CSS/ API参考/ 负载均衡/ 获取该esELB的信息，以及页面需要展示健康检查状态
更新时间：2024-10-17 GMT+08:00
查看PDF
分享

获取该esELB的信息，以及页面需要展示健康检查状态

功能介绍

该接口用于获取该ES集群的ELB信息，以及页面需要展示健康检查状态。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定待查询的集群ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

serverCertName

String

服务器证书名称。

serverCertId

String

服务器证书ID。

cacertName

String

ca证书名称。

cacertId

String

ca证书ID。

elb_enable

Boolean

elb开关信息。

authentication_type

String

认证方式。

loadBalancer

LoadBalancer object

负载均衡器对象信息。

listener

Elbv3Listener object

监听器对象信息

healthmonitors

Array of Member objects

健康检查结果集合。
表3 LoadBalancer

参数

参数类型

描述

id

String

负载均衡器ID。

name

String

负载均衡器名称。

guaranteed

String

是否独享型LB，false：共享型，true：独享型。

billing_info

String

资源账单信息。空：按需计费。非空：包周期计费。

description

String

描述信息。

vpc_id

String

负载均衡器所属VPC ID。

provisioning_status

String

负载均衡器的配置状态。

listeners

Array of IdListWrapper objects

关联的listener列表。

vip_address

String

负载均衡器的IPv4虚拟IP地址。

vip_port_id

String

负载均衡器的IPv4对应的port ID。

ipv6_vip_address

String

负载均衡器的IPv6地址。

publicips

Array of PublicIpInfo objects

负载均衡器绑定的公网IP。
表4 IdListWrapper

参数

参数类型

描述

id

String

listener id。
表5 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id。

publicip_address

String

弹性公网IP地址。

ip_version

Integer

IP版本信息。取值范围：4和6 4：IPv4。6：IPv6。
表6 Elbv3Listener

参数

参数类型

描述

id

String

监听器ID。

name

String

监听器的名称。

protocol

String

监听器的监听协议。

protocol_port

Integer

监听器的前端监听端口。

ipgroup

ListenerIpGroup object

listener对象中的ipgroup信息。
表7 ListenerIpGroup

参数

参数类型

描述

ipgroup_id

String

监听器关联的访问控制组的id。 创建时必选，更新时非必选。

enable_ipgroup

Boolean

访问控制组的状态。 True:开启访问控制； False：关闭访问控制。
表8 Member

参数

参数类型

描述

name

String

后端服务器名称。

address

String

后端服务器对应的IP地址。

protocol_port

Integer

后端服务器业务端口号。

operating_status

String

后端云服务器的健康状态。ONLINE：后端云服务器正常。NO_MONITOR：后端云服务器所在的服务器组没有健康检查器。OFFLINE：后端云服务器关联的ECS服务器不存在或已关机。

instance_id

String

member关联的实例ID。空表示member关联的实例为非真实设备。

请求示例

无

响应示例

状态码： 200

请求已成功。

{
  "loadBalancer" : {
    "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
    "name" : "elb-css",
    "guaranteed" : "true",
    "description" : "",
    "listeners" : [ {
      "id" : "011d14fa-908b-4cd9-b0d6-0768ddc6cb71"
    }, {
      "id" : "04b86029-c281-4490-a3bd-5ea1266658ba"
    } ],
    "publicips" : [ {
      "publicip_id" : "f678e23c-96a5-49e8-8ea2-bd8b47d41e78",
      "publicip_address" : "100.1.1.1",
      "ip_version" : 4
    } ],
    "billing_info" : null,
    "vpc_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
    "provisioning_status" : "ACTIVE",
    "vip_address" : "10.0.0.1",
    "ipv6_vip_address" : "2409:27ff:2003:3e:1fd::f3"
  },
  "listener" : {
    "id" : "41ff041d-c7b9-4142-9167-fa93d54f97da",
    "name" : "css-searchServer",
    "protocol" : "HTTPS",
    "ipgroup" : null,
    "protocol_port" : 9265
  },
  "healthmonitors" : [ {
    "instance_id" : "bac86342-2222-43e6-817f-57f040a174a6",
    "name" : "",
    "address" : "10.0.0.87",
    "protocol_port" : 9200,
    "operating_status" : "ONLINE"
  }, {
    "instance_id" : "d935b82c-f94b-4ae0-9997-ddc90885d8c6",
    "name" : "",
    "address" : "10.0.0.61",
    "protocol_port" : 9200,
    "operating_status" : "ONLINE"
  } ],
  "serverCertName" : "server1",
  "serverCertId" : "82375af01c0d40f6a44c15962c570625",
  "cacertName" : null,
  "cacertId" : null,
  "elb_enable" : true,
  "authentication_type" : "single"
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。

父主题： 负载均衡