基本信息

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


负载均衡器的监听器列表,每项数据格式为:
{
"listener_port": "80",
"listener_protocol": "http",
"backend_protocol": "http",
"balance_mode": "roundrobin",
"forwardfor": "0",
"loadbalancer_id": "lb-1234abcd",
"loadbalancer_listener_id": "lbl-1234abcd",
"loadbalancer_listener_name": "test listener",
"create-time": "2014-02-14T00:58:43Z",
"healthy_check_method": "tcp",
"healthy_check_option": "10|5|2|5",
"session_sticky": ""
}
只有在请求参数 verbose=1 时才会返回此信息。

is_applied

Integer

是否已更新配置,1 为已更新,0 为还未更新。

status

String

负载均衡器状态, 有效值为pending、active、 stopped、suspended、deleted、ceased。
pending: 等待被创建
active: 运行中
stopped: 已关机
suspended: 由于欠费, 已被暂停使用
deleted: 已被删除, 但处于此状态的负载均衡器在2小时之内仍可以被恢复为 active 状态
ceased: 已被彻底删除, 处于此状态的负载均衡器无法恢复

transition_status

String

负载均衡器状态, 有效值为 creatin、starting、stopping、updating、suspending、resuming、deleting。
creating: 创建中, 由 pending 状态变成 active 状态
starting: 启动中, 由 stopped 状态变成 active 状态
stopping: 关闭中, 由 active 状态变成 stopped 状态
updating: 更新中
suspending: 欠费暂停中, 由 active/stopped 状态变成 suspended 状态
resuming: 恢复中, 由 suspended 状态变成 active 状态
deleting: 删除中, 由 active/stopped/suspended 状态变成 deleted 状态

eips

Array

与负载均衡器绑定的公网 IP 列表,其中每项数据格式为:
{
"eip_id": "eip-1234abcd",
"eip_name": "api test",
"eip_addr": "x.x.x.x"
}

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
}