更新时间:2022-03-31 GMT+08:00
分享

查询监听器详情

功能介绍

根据指定ID查询监听器详情。

URI

GET /v2.0/lbaas/listeners/{listener_id}

表1 参数说明

参数

是否必选

参数类型

描述

listener_id

String

监听器ID。

请求消息

响应消息

表2 响应参数

参数

参数类型

描述

listener

Object

监听器对象列表。详见表3

表3 listeners字段说明

参数

参数类型

描述

id

String

监听器ID。

tenant_id

String

监听器所在的项目ID。

project_id

String

此参数和tenant_id参数含义一样,均指监听器所在的项目ID。

name

String

监听器名称。

description

String

监听器描述信息。

protocol

String

监听器的监听协议。

支持TCP、HTTP、UDP、TERMINATED_HTTPS。

protocol_port

Integer

监听器的监听端口。

取值范围:[1, 65535]。

loadbalancers

Array

监听器关联的负载均衡器 ID。详见表7

connection_limit

Integer

监听器的最大连接数。

取值范围:[-1, 2147483647]。默认为-1,无连接数限制。

该字段为预留字段,暂未启动。

admin_state_up

Boolean

监听器的管理状态。

该字段为预留字段,暂未启用。取值范围:true/false。

  • true表示开启。
  • false表示关闭。

http2_enable

Boolean

HTTP2功能的开启状态。

取值范围:true/false。true:开启。false:关闭。

仅针对监听器的协议为TERMINATED_HTTPS有意义。

default_pool_id

String

监听器的默认后端云服务器组ID。

当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。当该字段为null时,表示监听器无默认的后端云服务器组。

default_tls_container_ref

String

监听器使用的服务器证书ID。详细参见SSL证书管理

当protocol参数为TERMINATED_HTTPS时,为必选字段。

client_ca_tls_container_ref

String

监听器使用的CA证书ID。详细参见SSL证书管理

sni_container_refs

Array

监听器使用的SNI证书(带域名的服务器证书)ID的列表。

该字段不为空列表时,SNI特性开启。该字段为空列表时,SNI特性关闭。

tags

Array

监听器的标签。

created_at

String

监听器的创建时间。YYYY-MM-DDTHH:MM:SS

updated_at

String

监听器的更新时间。YYYY-MM-DDTHH:MM:SS

insert_headers

Object

HTTP扩展头部,内部字段全量同步,不选则为默认值。

可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中,随报文传递到后端云服务器上。

例如可通过X-Forwarded-ELB-IP开关,将负载均衡器的弹性公网IP传到后端云服务器。详细参见表8

仅当监听器的协议为HTTP、TERMINATED_HTTPS时,该字段有意义。

tls_ciphers_policy

String

监听器使用的安全策略,仅对TERMINATED_HTTPS协议类型的监听器有效,且默认值为tls-1-0。

取值包括:tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表4

表4 loadbalancers字段说明

参数

参数类型

描述

id

String

关联的负载均衡器id

表5 insert_headers字段说明

参数

参数类型

描述

X-Forwarded-ELB-IP

Boolean

负载均衡器弹性公网IP透传开关。打开时可以将负载均衡器的弹性公网IP从报文的HTTP头中带到后端云服务器。

取值范围:true/false。true:开启。false:关闭。

默认:关闭。

X-Forwarded-Host

Boolean

负载均衡器X-Forwarded-Host重写开关。打开时可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器

取值范围:true/false。true:开启。false:关闭。

默认:开启。

请求示例

  • 请求样例 查询监听器详情
    GET https://{Endpoint}/v2.0/lbaas/listeners/09e64049-2ab0-4763-a8c5-f4207875dc3e

响应示例

  • 响应样例
    {
        "listener": {
            "protocol_port": 8000,
            "protocol": "TCP",
            "description": "",
            "client_ca_tls_container_ref": null,
            "default_tls_container_ref": null,
            "admin_state_up": true,
            "http2_enable": false,
            "loadbalancers": [
                {
                    "id": "3d77894d-2ffe-4411-ac0a-0d57689779b8"
                }
            ],
            "tenant_id": "1867112d054b427e808cc6096d8193a1",
            "project_id": "1867112d054b427e808cc6096d8193a1",
            "sni_container_refs": [],
            "connection_limit": -1,
            "default_pool_id": "b7e53dbd-62ab-4505-a280-5c066078a5c9",
            "id": "09e64049-2ab0-4763-a8c5-f4207875dc3e",
            "tags": [],
            "name": "listener-2",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14",
            "insert_headers":{
                "X-Forwarded-ELB-IP":true
             }
        }
    }

返回码

请参见状态码

分享:

    相关文档

    相关产品

close