文档首页 > > API参考> API(共享型)> 后端云服务器> 查询后端云服务器

查询后端云服务器

分享
更新时间: 2020/06/01 GMT+08:00

功能介绍

查询指定后端云服务器组的后端云服务器。支持过滤查询和分页查询。如未特殊说明, 匹配规则为精确匹配。

URI

GET /v2.0/lbaas/pools/{pool_id}/members

表1 参数说明

参数

是否必选

参数类型

描述

pool_id

String

后端云服务器组ID。

接口约束

分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

marker

String

分页查询的起始的资源ID,表示上一页最后一条查询记录的后端云服务器的ID。不指定时表示查询第一页。

必须与limit一起使用。

limit

Integer

分页查询每页的后端云服务器个数。

0~intmax。

page_reverse

Boolean

分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。

必须与limit一起使用。

id

String

后端云服务器的ID。

tenant_id

String

后端云服务器所属的项目ID。

支持的最大字符长度:255

获取方法详见获取项目ID

project_id

String

后端云服务器所属的项目ID。

获取方法详见获取项目ID

name

String

后端云服务器的名称。

支持的最大字符长度:255

address

String

后端云服务器对应的IP地址。

支持的最大字符长度:64

protocol_port

Integer

后端云服务器后端端口的协议号。

subnet_id

String

后端云服务器所在的子网ID。

admin_state_up

Boolean

后端云服务器的管理状态。

取值范围:true/false。

说明:

该字段虽然支持创建、更新,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。

weight

Integer

后端云服务器的权重。

响应消息

表3 响应参数

参数

参数类型

描述

members

Array

属于某个后端云服务器组的后端云服务器对象列表。对象详见表4

表4 members字段说明

参数

参数类型

描述

id

String

后端云服务器的 ID。

tenant_id

String

后端云服务器所在的项目ID。

支持的最大字符长度:255

project_id

String

后端云服务器所在的项目ID。

name

String

后端云服务器的名称。

支持的最大字符长度:255

address

String

后端云服务器对应的IP地址,该IP必须在subnet_id字段指定子网的网段中,例如192.168.3.11。

只能对应主网卡的IP。

支持的最大字符长度:64

protocol_port

Integer

后端端口和协议号,取值范围[1,65535]。

subnet_id

String

后端云服务器所在的子网ID。后端云服务器的IP地址在该子网的网段中。

不支持开启了ipv6的子网。

admin_state_up

Boolean

后端云服务器的管理状态:true/false。

只支持指定为true。

说明:

该字段虽然支持创建、更新,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。

weight

Integer

后端云服务器的权重,取值范围[0,100]。

权重为0的后端不再接受新的请求。默认为1。

operating_status

String

后端云服务器的健康状态,取值:

  • ONLINE:健康检查在线,后端服务正常。
  • OFFLINE:健康检查离线,后端服务异常,负载均衡器不再向异常的后端发送流量。
  • NO_MONITOR:无检查检查。未创建检查检查或健康检查的admin_state_up字段为false。
  • 支持的最大字符长度:16

members_links

Array

后端云服务器的分页查询中上下页的链接信息。

仅当分页查询时响应体中有该字段。详见表5

表5 members_links字段说明

参数

参数类型

描述

href

String

后端云服务器的分页查询中上下页的url。

rel

String

上下页的提示信息,取值:

  • next:表示href是下一页的URL
  • previous:表示href是上一页的url

示例

  • 请求样例1 全量查询后端云服务器
    GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members
  • 响应样例1
    {
        "members": [
            {
                "address": "10.0.0.8", 
                "admin_state_up": true, 
                "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", 
                "protocol_port": 80, 
                "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", 
                "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
                "project_id": "1a3e005cf9ce40308c900bcb08e5320c",
                "weight": 1, 
                "operating_status": "ONLINE", 
                "name": "member-name"
            }
        ]
    }
  • 请求样例2 过滤查询IP为10.0.0.8且端口为80的后端云服务器
    GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members?address=10.0.0.8&protocol_port=80
  • 响应样例2
    {
        "members": [
            {
                "address": "10.0.0.8", 
                "admin_state_up": true, 
                "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", 
                "protocol_port": 80, 
                "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", 
                "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
                "project_id": "1a3e005cf9ce40308c900bcb08e5320c",
                "weight": 1, 
                "operating_status": "ONLINE", 
                "name": "member-name"
            }
        ]
    }

返回码

请参见共享型负载均衡返回码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问