接口约束
4.6 负载均衡器
4.6.6 查询负载均衡器状态树
功能介绍
注意:该接口中的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
表4-92 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
loadbalancer_
id 是 String 负载均衡器ID。
请求参数
表4-93 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String IAM鉴权Token。
响应参数
状态码: 200
表4-94 响应 Body 参数
参数 参数类型 描述
statuses LoadBalancer StatusResult object
负载均衡器状态树信息。
request_id String 请求ID。
注:自动生成 。
表4-95 LoadBalancerStatusResult
参数 参数类型 描述
loadbalancer LoadBalancer
Status object 负载均衡器的详细信息。
表4-96 LoadBalancerStatus
参数 参数类型 描述
name String 负载均衡器名称。
最小长度:1 最大长度:255 provisioning_s
tatus String 负载均衡器的配置状态。取值:
● ACTIVE:使用中。
● PENDING_DELETE:删除中。
listeners Array of LoadBalancer StatusListene r objects
负载均衡器关联的监听器列表。
pools Array of LoadBalancer StatusPool objects
负载均衡器关联的后端云服务器组列表。
id String 负载均衡器ID。
operating_stat
us String 负载均衡器的操作状态。取值:
● ONLINE:创建时默认状态,表示负载均衡器 正常运行。
● FROZEN:已冻结。
● DEGRADED:负载均衡器下存在member的 operating_status为OFFLINE时返回这个状 态。
● DISABLED:负载均衡器的admin_state_up属 性值为false。
说明:DEGRADED和DISABLED状态仅在当前接 口中返回,LB详情等其他接口不返回这两个状态 值。
表4-97 LoadBalancerStatusListener
参数 参数类型 描述
name String 监听器的名称。
最小长度:1 最大长度:255 provisioning_s
tatus String 监听器的配置状态。取值:
● ACTIVE:使用中。
pools Array of LoadBalancer StatusPool objects
监听器下的后端主机组操作状态。
l7policies Array of LoadBalancer StatusPolicy objects
监听器下的7层转发策略操作状态。
id String 监听器ID。
operating_stat
us String 监听器的操作状态。取值:
● ONLINE:创建时默认状态,表示监听器正常 运行。
● DEGRADED: -该监听器下存在l7policy或 l7rule的Provisioning_status=ERROR时返回这 个状态。 -状态树该监听器下存在member的 operating_status=OFFLINE。
● DISABLED:负载均衡器或监听器的 admin_state_up=false。 使用说明:
● DEGRADED和DISABLED状态仅在当前接口返 回,查询监听器详情等其他接口返回字段 operating_status不存在这两个状态值。
表4-98 LoadBalancerStatusPolicy
参数 参数类型 描述
action String 匹配后动作。取值:
● REDIRECT_TO_POOL:转发到后端服务器 组。
● REDIRECT_TO_LISTENER:转发到监听器。
id String 转发策略ID。
参数 参数类型 描述 provisioning_s
tatus String 转发策略的配置状态。取值:
● ACTIVE:使用中,默认值。
● ERROR:表示当前策略与同一监听器下的其他 策略存在相同的规则配置。
name String 转发策略名称。
最小长度:1 最大长度:255 rules Array of
LoadBalancer StatusL7Rule objects
转发规则状态信息。
表4-99 LoadBalancerStatusL7Rule
参数 参数类型 描述
id String L7转发规则ID。
type String 匹配内容类型,取值:
● HOST_NAME:域名匹配。
● PATH:URL路径匹配。
使用说明:
● 同一个l7policy下创建的所有的l7rule的 HOST_NAME不能重复。
provisioning_s
tatus String 转发规则的配置状态。 取值:
● ACTIVE:使用中,默认值。
● ERROR:当前规则所属策略与同一监听器下的 其他策略存在相同的规则配置。
表4-100 LoadBalancerStatusPool
参数 参数类型 描述
provisioning_s
tatus String 后端服务器组的配置状态。取值:
● ACTIVE:使用中。
name String 后端服务器组名。
最小长度:1 最大长度:255
参数 参数类型 描述 healthmonitor LoadBalancer
StatusHealth Monitor object
LB状态树的后端服务器组健康检查器状态信息。
members Array of LoadBalancer StatusMemb er objects
后端服务器状态信息。
id String 后端服务器组ID。
operating_stat
us String 后端服务器组的操作状态。取值:
● ONLINE:创建时默认状态,表后端服务器组 正常。
● DEGRADED:该后端服务器组下存在member 为的operating_status=OFFLINE。
● DISABLED:负载均衡器或后端服务器组的 admin_state_up=false。 使用说明:
● DEGRADED和DISABLED仅在当前接口返回,
查询后端服务器组详情等其他接口返回的 operating_status字段不存在这两个状态值。
表4-101 LoadBalancerStatusHealthMonitor
参数 参数类型 描述
type String 协议类型。取值:TCP、UDP_CONNECT、
HTTP、HTTPS。
id String 健康检查器ID。
name String 健康检查器名称。
最小长度:1 最大长度:255 provisioning_s
tatus String 健康检查器的配置状态。取值:ACTIVE表示使用 中。
表4-102 LoadBalancerStatusMember
参数 参数类型 描述
provisioning_s
tatus String 后端服务器配置状态。取值:ACTIVE表示使用 中。
address String 后端服务器的IP地址。
参数 参数类型 描述
protocol_port Integer 后端服务器的端口号。取值范围[1, 65535]。
id String 后端服务器ID。
operating_stat
us 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
"provisioning_status" : "ACTIVE", "listeners" : [ {
"name" : "listener-jy-1", "provisioning_status" : "ACTIVE", "pools" : [ {
"id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18", "operating_status" : "ONLINE"
} ],
"l7policies" : [ ],
} ], "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 操作成功正常返回。
错误码
请参见错误码。