文档首页/ 弹性负载均衡 ELB/ API参考/ 历史API/ API（共享型OpenStack API）（废弃）/ 负载均衡器/ 查询负载均衡状态树
更新时间：2023-12-14 GMT+08:00
查看PDF
分享

查询负载均衡状态树

功能介绍

查询负载均衡器状态树。可通过该接口查询负载均衡器关联的监听器、后端云服务器组、后端云服务器、健康检查、转发策略、转发规则的主要信息，了解负载均衡器下资源的拓扑情况。

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}/statuses

表1 参数说明

参数

是否必选

参数类型

描述

loadbalancer_id

是

String

负载均衡器ID。

请求消息

无

响应消息

表2 响应参数

参数

参数类型

描述

statuses

Object

负载均衡器状态树。详见表3。
表3 statuses字段说明

参数

参数类型

描述

loadbalancer

Object

负载均衡器对象。详见表4。
表4 loadbalancer字段说明

参数

参数类型

描述

id

String

负载均衡器ID。

name

String

负载均衡器名称。

支持的最大字符长度：255

listeners

Array

负载均衡器关联的监听器列表。listeners对象参考表5。

pools

Array

负载均衡器关联的后端服务器组列表。pools对象参考表6。

operating_status

String

该字段为预留字段，目前暂未使用。

负载均衡器的操作状态。取值范围：

  • ONLINE：创建时的默认状态，表示负载均衡器正常。
  • DEGRADED：该负载均衡器下存在l7policy或l7rule的Provisioning_status为ERROR时返回此状态。注意该状态仅在当前接口中返回。
  • DISABLED：负载均衡器的admin_state_up属性值为false时会返回该状态。注意该状态仅在当前接口中返回。
  • FROZEN：负载均衡器被冻结。

provisioning_status

String

该字段为预留字段，暂未启用。

负载均衡器的配置状态。取值范围：可以为ACTIVE。
表5 listeners字段说明

参数

参数类型

描述

id

String

监听器ID。

name

String

监听器名称。

l7policies

Array

监听器关联的转发策略列表，l7policy对象参考表9。

pools

Array

监听器关联的后端云服务器组列表，pools对象参考表6。

operating_status

String

监听器的操作状态。取值范围：ONLINE 表示监听器正常。

provisioning_status

String

该字段为预留字段，暂未启用。

监听器的配置状态。取值范围：可以为ACTIVE。
表6 pools字段说明

参数

参数类型

描述

id

String

后端服务器组ID。

name

String

后端服务器组名称。

healthmonitor

Object

后端服务器组的健康检查详情，健康检查对象参考表7。

members

Array

后端服务器组中包含的后端服务器列表，后端服务器对象参考表8。

operating_status

String

后端服务器组的操作状态。取值范围：ONLINE 表示后端服务器组正常。

provisioning_status

String

该字段为预留字段，暂未启用。

后端服务器组的配置状态。取值范围：可以为ACTIVE。
表7 healthmonitor字段说明

参数

参数类型

描述

id

String

健康检查ID。

name

String

健康检查名称。

type

String
  • 健康检查类型。
  • 取值范围：UDP_CONNECT、TCP、HTTP。

provisioning_status

String

该字段为预留字段，暂未启用。

健康检查的配置状态。取值范围：可以为ACTIVE。
表8 members字段说明

参数

参数类型

描述

id

String

后端云服务器ID。

address

String

后端云服务器的IP地址。

例如："192.168.3.11"。

protocol_port

Integer
  • 后端服务器的端口号。
  • 取值范围：[0,65535]。

operating_status

String

后端云服务器的操作状态。取值范围：

  • ONLINE：后端服务器正常运行。
  • NO_MONITOR：后端服务器无健康检查。
  • DISABLED：后端服务器不可用。所属负载均衡器、后端服务器组或该后端服务器的admin_state_up=false时，会返回该状态。注意该状态仅在当前接口中返回。
  • OFFLINE：关联的ECS已下线。
说明：

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

provisioning_status

String

该字段为预留字段，暂未启用。

后端服务器的配置状态。取值范围：可以为ACTIVE。
表9 l7policies字段说明

参数

参数类型

描述

id

String

转发策略ID。

name

String

转发策略名称。

rules

Array

转发策略关联的转发规则列表，转发规则字段参考表10。

action

String
  • 转发策略的转发动作；
  • 取值范围：REDIRECT_TO_POOL：转发到后端服务器组，REDIRECT_TO_LISTENER：重定向到监听器。

provisioning_status

String

该字段为预留字段，暂未启用。

转发策略的配置状态。取值范围：

  • ACTIVE：默认值，表示正常。
  • ERROR：表示当前策略与同一监听器下的其他策略存在相同的规则配置。
表10 rules字段说明

参数

参数类型

描述

id

String

转发规则ID。

type

String
  • 转发规则的匹配内容。
  • 取值范围：PATH或者HOST_NAME。PATH：匹配请求中的路径，HOST_NAME：匹配请求中的域名。

provisioning_status

String

该字段为预留字段，暂未启用。

转发规则的配置状态。取值范围：

  • ACTIVE：默认值，表示正常。
  • ERROR：表示当前规则所属策略与同一监听器下的其他策略存在相同的规则配置。

请求示例

  • 请求样例 
    GET https://{Endpoint}/v2.0/lbaas/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses

响应示例

  • 响应样例 
    {
    "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"
        }
    }
}

返回码

请参见状态码。

父主题： 负载均衡器

相关文档