文档

DescribeHealthStatus - 查询后端服务器的健康状态

更新时间:
一键部署

查询后端服务器的健康状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
slb:DescribeHealthStatusRead
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

负载均衡实例ID。

lb-bp1qjwo61pqz3ah****
ListenerPortinteger

负载均衡实例前端使用的端口。

取值:1~65535

说明 不设置该参数表示获取所有端口的健康检查状态。
80
ListenerProtocolstring

负载均衡实例前端使用的协议。

https
RegionIdstring

负载均衡实例的地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
BackendServersobject []

后端服务器列表。

ServerHealthStatusstring

后端服务器的健康状况。

  • normal:后端服务器健康。

  • abnormal:后端服务器不健康。

  • unavailable:未完成健康检查。

abnormal
Protocolstring

负载均衡实例前端使用的协议。

https
ListenerPortinteger

负载均衡实例前端使用的端口。

80
ServerIpstring

ECS实例的IP。

192.XX.XX.11
Portinteger

负载均衡实例后端使用的端口。

70
ServerIdstring

ECS实例ID或ENI实例ID。

i-bp1h5u3fv54ytf***

示例

正常返回示例

JSON格式

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "BackendServers": {
    "BackendServer": [
      {
        "ServerHealthStatus": "abnormal",
        "Protocol": "https",
        "ListenerPort": 80,
        "ServerIp": "192.XX.XX.11",
        "Port": 70,
        "ServerId": "i-bp1h5u3fv54ytf***"
      }
    ]
  }
}

JSON格式

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "BackendServers": {
    "BackendServer": [
      {
        "ServerHealthStatus": "abnormal",
        "Protocol": "https",
        "ListenerPort": 80,
        "ServerIp": "192.XX.XX.11",
        "Port": 70,
        "ServerId": "i-bp1h5u3fv54ytf***"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400TooManyListenersMore than 1 listener is found, please be more specified.检索到的监听数量大于1,请提供更具体的查询条件。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈