专有云计算

  • 专有云计算 > API 文档 > 查询资源池列表

    查询资源池列表

    最近更新时间:2022-01-18 10:41:03

    请求路径

    GET /api/rio/v1/network/loadbalancer_pools

    请求参数

    名称 类型 位置 必须 描述
    x-rio-zone-id string header 地域 ID
    load_balancer_id string query 负载均衡 ID
    listener_id string query 监听器 ID
    pool_id string query 资源池 ID

    返回值

    名称 类型 描述
    request_id string 请求 ID
    data []SLBPoolInfo 负载均衡资源池信息

    SLBPoolInfo 负载均衡资源池信息

    名称 类型 描述
    slb_pool_id string 资源池 ID
    enabled boolean 启用状态:
    • true : 已启用
    • false : 已停用
    slb_pool_name string 名称
    description string 描述
    protocol string 协议类型:
    • tcp
    • udp
    • https :tcp 转发实现
    • http
    • sctp
    • terminated_https : https 协议
    status string 状态:
    • active : 正常的
    • creating : 创建中
    • updating :更新中
    • deleting : 删除中
    • error : 错误
    listener_id string 所属监听器 ID
    members []Member 后端服务器组
    type string 持久化类型:
    • APP_COOKIE : 依赖于 APP 定义的 COOKIE,通过在 APP 会话中创建不同的 COOKIE 来区分不同的客户端,后续具有相同 COOKIE 客户端的请求由同一个实服务主机进行处理。
    • HTTP_COOKIE : 客户端第一次连接时,在 HTTP 的应答报文中打上标记,后续具有相同标记的请求由同一个实服务主机进行处理。
    • SOURCE_IP : 以请求的源地址为依据,相同源地址的客户端请求分发至同一后端服务器。
    cookie_name string 用于会话持久化的 cookie 名称,仅在 PersistenceType = APP_COOKIE 时需要
    persistence_timeout integer 超时,单位:s
    persistence_granularity string 用于确定 SCTP 或 UDP 会话持久性的网络掩码
    health_monitor_id string 健康检查器 ID
    health_monitor_name string 健康检查器名称
    health_check_type string 健康检查协议类型:
    • http
    • https
    • ping
    • sctp
    • tcp
    • tls-hello
    • udp-connect
    health_http_method string 健康检查请求方法:
    • connect
    • delete
    • get
    • head
    • options
    • patch
    • post
    • put
    • trace
    health_check_domain string 用于健康检查的域名
    health_check_uri string 用于健康检查的URI
    health_check_connect_port integer 健康检查使用的端口。取值:1-65535。
    healthy_threshold integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由fail判定为success。取值:2-10。 默认值: 3
    unhealthy_threshold integer 健康检查连续失败多少次后,将后端服务器的健康检查状态由success判定为fail。取值:2-10。 默认值: 3
    health_check_interval integer 健康检查的时间间隔。取值:1-50(秒)。 默认值: 2
    health_check_timeout integer 健康检查连接超时时间,此值必须小于延迟值(health_check_interval)
    health_check_http_code string 健康检查正常的HTTP状态码:
    • http_2xx
    • http_3xx
    • http_4xx
    • http_5xx

    Member 后端服务器

    名称 类型 描述
    member_id string 后端服务器 ID
    enabled boolean 启用状态:
    • true : 已启用
    • false : 已停用
    status string 状态:
    • active : 正常
    • creating : 创建中
    • updating : 更新中
    • deleting : 删除中
    • unhealthy : 健康检查未通过
    • error : 错误
    server_id string 服务 ID,对应云主机 ID
    adress string IP 地址,当添加内部虚拟服务器时传值,IP 地址、专有网络 ID 必传,添加外部虚拟服务器的前提是负载均衡实例可通过网络访问
    subnet_id string 专有网络 ID
    port integer 端口
    weight integer 权重,值范围 0 ~ 100
    create_at integer 创建时间,毫秒时间戳

    返回值示例

    {
        "request_id":"HtPfEh8hWjSczckW",
        "data":[
            {
                "slb_pool_id":"2395e835-ed80-4916-a074-02a9e53ef5d6",
                "enabled":false,
                "slb_pool_name":"3121312312",
                "description":"",
                "protocol":"tcp",
                "status":"active",
                "server_member_type":null,
                "listener_id":"9491a0a0-28f4-476f-a7f0-eb2b8a648b64",
                "members":[
                    {
                        "member_id":"aa005b03-7838-4c76-9dc6-0c86fb281822",
                        "enabled":true,
                        "status":"active",
                        "server_id":"5faa8afb-4b3a-453e-a56d-17e26ae33480",
                        "back_up":false,
                        "adress":"192.168.11.7",
                        "subnet_id":"430ca45c-20d5-4c29-ada4-85379a2e6291",
                        "port":88,
                        "weight":1,
                        "create_at":1642069605000
                    }
                ],
                "session_persistence":{
                    "type":"",
                    "cookie_name":"",
                    "persistence_timeout":0,
                    "persistence_granularity":""
                },
                "health_monitor_id":"8eae2394-a817-4f23-9707-dd33dd90c33d",
                "health_monitor_name":"health-uwPEQ",
                "health_check_type":"ping",
                "health_http_method":null,
                "health_check_domain":"",
                "health_check_uri":"",
                "health_check_connect_port":null,
                "healthy_threshold":3,
                "unhealthy_threshold":3,
                "health_check_interval":5,
                "health_check_timeout":5,
                "health_check_http_code":null,
                "create_at":1642066986000
            }
        ]
    }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close