更新时间:2022-03-31 GMT+08:00
分享

查询负载均衡器状态树

功能介绍

查询负载均衡器状态树,包括负载均衡器及其关联的子资源的状态信息。

注意:该接口中的operating_status不一定与对应资源的operating_status相同。如:当Member的admin_state_up=false且operating_status=OFFLINE时,该接口返回member的operating_status=DISABLE。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

loadbalancer_id

String

负载均衡器ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

IAM鉴权Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

statuses

LoadBalancerStatusResult object

负载均衡器状态树信息。

request_id

String

请求ID。

注:自动生成 。

表4 LoadBalancerStatusResult

参数

参数类型

描述

loadbalancer

LoadBalancerStatus object

负载均衡器的详细信息。

表5 LoadBalancerStatus

参数

参数类型

描述

name

String

负载均衡器名称。

最小长度:1

最大长度:255

provisioning_status

String

负载均衡器的配置状态。取值:

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

listeners

Array of LoadBalancerStatusListener objects

负载均衡器关联的监听器列表。

pools

Array of LoadBalancerStatusPool objects

负载均衡器关联的后端云服务器组列表。

id

String

负载均衡器ID。

operating_status

String

负载均衡器的操作状态。取值:

  • ONLINE:创建时默认状态,表示负载均衡器正常运行。

  • FROZEN:已冻结。

  • DEGRADED:负载均衡器下存在member的operating_status为OFFLINE时返回这个状态。

  • DISABLED:负载均衡器的admin_state_up属性值为false。

说明:DEGRADED和DISABLED状态仅在当前接口中返回,LB详情等其他接口不返回这两个状态值。

表6 LoadBalancerStatusListener

参数

参数类型

描述

name

String

监听器的名称。

最小长度:1

最大长度:255

provisioning_status

String

监听器的配置状态。取值:

  • ACTIVE:使用中。

pools

Array of LoadBalancerStatusPool objects

监听器下的后端主机组操作状态。

l7policies

Array of LoadBalancerStatusPolicy objects

监听器下的7层转发策略操作状态。

id

String

监听器ID。

operating_status

String

监听器的操作状态。取值:

  • ONLINE:创建时默认状态,表示监听器正常运行。

  • DEGRADED: -该监听器下存在l7policy或l7rule的Provisioning_status=ERROR时返回这个状态。 -状态树该监听器下存在member的operating_status=OFFLINE。

  • DISABLED:负载均衡器或监听器的admin_state_up=false。 使用说明:

  • DEGRADED和DISABLED状态仅在当前接口返回,查询监听器详情等其他接口返回字段operating_status不存在这两个状态值。

表7 LoadBalancerStatusPolicy

参数

参数类型

描述

action

String

匹配后动作。取值:

  • REDIRECT_TO_POOL:转发到后端服务器组。

  • REDIRECT_TO_LISTENER:转发到监听器。

id

String

转发策略ID。

provisioning_status

String

转发策略的配置状态。取值:

  • ACTIVE:使用中,默认值。

  • ERROR:表示当前策略与同一监听器下的其他策略存在相同的规则配置。

name

String

转发策略名称。

最小长度:1

最大长度:255

rules

Array of LoadBalancerStatusL7Rule objects

转发规则状态信息。

表8 LoadBalancerStatusL7Rule

参数

参数类型

描述

id

String

L7转发规则ID。

type

String

匹配内容类型,取值:

  • HOST_NAME:域名匹配。

  • PATH:URL路径匹配。

使用说明:

  • 同一个l7policy下创建的所有的l7rule的HOST_NAME不能重复。

provisioning_status

String

转发规则的配置状态。 取值:

  • ACTIVE:使用中,默认值。

  • ERROR:当前规则所属策略与同一监听器下的其他策略存在相同的规则配置。

表9 LoadBalancerStatusPool

参数

参数类型

描述

provisioning_status

String

后端服务器组的配置状态。取值:

  • ACTIVE:使用中。

name

String

后端服务器组名。

最小长度:1

最大长度:255

healthmonitor

LoadBalancerStatusHealthMonitor object

LB状态树的后端服务器组健康检查器状态信息。

members

Array of LoadBalancerStatusMember objects

后端服务器状态信息。

id

String

后端服务器组ID。

operating_status

String

后端服务器组的操作状态。取值:

  • ONLINE:创建时默认状态,表后端服务器组正常。

  • DEGRADED:该后端服务器组下存在member为的operating_status=OFFLINE。

  • DISABLED:负载均衡器或后端服务器组的admin_state_up=false。 使用说明:

  • DEGRADED和DISABLED仅在当前接口返回,查询后端服务器组详情等其他接口返回的operating_status字段不存在这两个状态值。

表10 LoadBalancerStatusHealthMonitor

参数

参数类型

描述

type

String

协议类型。取值:TCP、UDP_CONNECT、HTTP、HTTPS。

id

String

健康检查器ID。

name

String

健康检查器名称。

最小长度:1

最大长度:255

provisioning_status

String

健康检查器的配置状态。取值:ACTIVE表示使用中。

表11 LoadBalancerStatusMember

参数

参数类型

描述

provisioning_status

String

后端服务器配置状态。取值:ACTIVE表示使用中。

address

String

后端服务器的IP地址。

protocol_port

Integer

后端服务器的端口号。取值范围[1, 65535]。

id

String

后端服务器ID。

operating_status

String

后端服务器的操作状态。取值:

  • ONLINE:后端服务器正常运行。

  • NO_MONITOR:后端服务器健康检查未开启。

  • DISABLED:后端服务器不可用。所属负载均衡器或后端服务器组或该后端服务器的admin_state_up=false时,会出现该状态。注意该状态仅在当前接口中返回。

  • OFFLINE:关联ECS已下线。

请求示例

查询负载均衡器的状态树

GET https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses

响应示例

状态码: 200

操作成功正常返回。

{
  "statuses" : {
    "loadbalancer" : {
      "name" : "lb-jy",
      "provisioning_status" : "ACTIVE",
      "listeners" : [ {
        "name" : "listener-jy-1",
        "provisioning_status" : "ACTIVE",
        "pools" : [ {
          "name" : "pool-jy-1",
          "provisioning_status" : "ACTIVE",
          "healthmonitor" : {
            "type" : "TCP",
            "id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
            "name" : "",
            "provisioning_status" : "ACTIVE"
          },
          "members" : [ {
            "protocol_port" : 80,
            "address" : "192.168.44.11",
            "id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
            "operating_status" : "ONLINE",
            "provisioning_status" : "ACTIVE"
          } ],
          "id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
          "operating_status" : "ONLINE"
        } ],
        "l7policies" : [ ],
        "id" : "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b",
        "operating_status" : "ONLINE"
      } ],
      "pools" : [ {
        "name" : "pool-jy-1",
        "provisioning_status" : "ACTIVE",
        "healthmonitor" : {
          "type" : "TCP",
          "id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
          "name" : "",
          "provisioning_status" : "ACTIVE"
        },
        "members" : [ {
          "protocol_port" : 80,
          "address" : "192.168.44.11",
          "id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
          "operating_status" : "ONLINE",
          "provisioning_status" : "ACTIVE"
        } ],
        "id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
        "operating_status" : "ONLINE"
      } ],
      "id" : "38278031-cfca-44be-81be-a412f618773b",
      "operating_status" : "ONLINE"
    }
  }
}

状态码

状态码

描述

200

操作成功正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close