获取负载均衡器信息
基本信息
Action
DescribeLoadBalancers
Path
/iaas
Method
GET
请求参数
此接口除公共参数外,还包含以下参数。关于公共参数的更多信息,请参见前文内容。
| 参数 | 参数类型 | 说明 | 是否必选 |
|---|---|---|---|
loadbalancers.n |
String |
负载均衡器 ID。 |
否 |
status.n |
String |
负载均衡器状态: pending,active,stopped,suspended,deleted,ceased。 |
否 |
search_word |
String |
搜索关键词,支持负载均衡器 ID,负载均衡器名称。 |
否 |
tags.n |
String |
按照标签 ID 过滤, 只返回已绑定某标签的资源。 |
否 |
verbose |
Integer |
是否返回冗长的信息,若为 1,则返回负载均衡器相关其他资源的详细数据。 |
否 |
返回数据
此接口除了返回公共响应参数外,还返回以下参数。关于公共响应参数的更多信息,请参见前文内容。
| 参数 | 参数类型 | 说明 |
|---|---|---|
loadbalancer_set |
Array |
JSON 格式的负载均衡器数据列表。 |
total_count |
Integer |
根据过滤条件得到的负载均衡器总数。 |
loadbalancer_set 参数说明如下。
| 参数 | 参数类型 | 说明 |
|---|---|---|
loadbalancer_id |
String |
负载均衡器 ID。 |
loadbalancer_name |
String |
负载均衡器名称。 |
description |
String |
负载均衡器描述。 |
listeners |
Array |
|
is_applied |
Integer |
是否已更新配置,1 为已更新,0 为还未更新。 |
status |
String |
负载均衡器状态, 有效值为pending、active、 stopped、suspended、deleted、ceased。 |
transition_status |
String |
负载均衡器状态, 有效值为 creatin、starting、stopping、updating、suspending、resuming、deleting。 |
eips |
Array |
与负载均衡器绑定的公网 IP 列表,其中每项数据格式为: |
create_time |
TimeStamp |
负载均衡器创建时间, 为UTC时间, 格式可参见 ISO8601。 |
status_time |
TimeStamp |
负载均衡器最近一次状态变更时间, 为UTC时间, 格式可参见 ISO8601。 |
security_group_id |
String |
负载均衡器所用的安全组 ID。 |
请求示例
https://api.<your_domain>/iaas/?action=DescribeLoadBalancers
&loadbalancers.1=lb-1234abcd
&status.1=active
&verbose=1
&COMMON_PARAMS
返回示例
{
"action":"DescribeLoadBalancersResponse",
"total_count":1,
"loadbalancer_set":[
{
"status":"active",
"is_applied":0,
"description":null,
"loadbalancer_name":"",
"transition_status":"",
"eips":[],
"listeners":[
{
"forwardfor":0,
"loadbalancer_listener_id":"lbl-1234abcd",
"balance_mode":"roundrobin",
"listener_protocol":"http",
"backend_protocol":"http",
"healthy_check_method":"tcp",
"session_sticky":"",
"loadbalancer_listener_name":null,
"controller":"self",
"create_time":"2013-09-25T00:38:46Z",
"healthy_check_option":"10|5|2|5",
"loadbalancer_id":"lb-1234abcd",
"listener_port":80
}
],
"create_time":"2013-09-24T15:41:49Z",
"status_time":"2013-09-24T15:41:49Z",
"security_group_id":"",
"loadbalancer_id":"lb-mgfypyqc"
}
],
"ret_code":0
}