产品文档

负载均衡

2024-04-24 10:41:45

describeTargetHealth

描述

查询后端服务下的target的健康状态

请求方式

GET

请求地址

https://lb.jdcloud-api.com/v1/regions/{regionId}/backends/{backendId}/health

名称 类型 是否必需 默认值 描述
regionId String True Region ID
backendId String True Backend Id

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码, 默认为1,取值范围:[1,∞), 页码超过总页数时, 显示最后一页
pageSize Integer False 分页大小,默认返回全部,取值范围:[10,100]

返回参数

名称 类型 描述
result Result 返回结果
requestId String 请求ID

Result

名称 类型 描述
targetHealths TargetHealth[] 后端服务的信息
totalCount Integer 总数量

TargetHealth

名称 类型 描述
targetGroupId String Target所在的虚拟服务器组Id, 与agId不能并存
agId String Target所在的高可用组Id,与targetGroupId不能并存
instanceId String Target所属实例的Id(type为vm或container时显示)
type String Target所属的type,取值为vm、container或ip,默认为vm
port Integer 健康检查的port
weight Integer 该Target的权重,取值范围:0-100 ,默认为10。0表示不参与流量转发
status String 该Target的健康状态,取值为healthy、unhealthy
ipAddress String Target的IP地址。当Target type为vm或container时,表示vm或container的私网IP;当Target type为ip时,表示注册Target时指定的IP地址
unhealthReason UnhealthReason 健康异常结构

UnhealthReason

名称 类型 描述
reason String CONNECT_FAILED:LB与后端server建立连接失败(HTTP/TCP);CONNECT_TIMEOUT: LB与后端server建立连接超时(HTTP/TCP);CONNECT_INTERRUPT: LB与后端服务器连接中断(TCP/HTTP); RECEIVE_RESPONSE_FAILED: LB接受后端服务器响应失败(HTTP/TCP/ICMP);RECEIVE_RESPONSE_TIMEOUT: LB接受后端服务器响应超时(HTTP/TCP/ICMP);REQUEST_FAILED: LB向后端server发送请求失败(HTTP/TCP/ICMP);REQUEST_TIMEOUT: LB向后端server发送请求超时(HTTP/TCP/ICMP);HTTP_CODE_MISMATCH: LB从后端收到的响应码与预期正常的不一致(HTTP);RESPONSE_FORMAT_ERROR: LB从后端接收的响应格式错误(HTTP/TCP)
detail String 原因描述

返回码

HTTP状态码 错误码 描述
200 OK
文档反馈

开始与售前顾问沟通

可直接拨打电话 400-098-8505转1

我们的产品专家为您找到最合适的产品/解决⽅案

在线咨询 5*8⼩时

1v1线上咨询获取售前专业咨询

点击咨询
企微服务助手

专业产品顾问,随时随地沟通