華為云計算 云知識 查詢監(jiān)聽器詳情ShowListener
查詢監(jiān)聽器詳情ShowListener

 

功能介紹

根據(jù)指定ID查詢監(jiān)聽器詳情。

調(diào)試

您可以在API Explorer中直接運行調(diào)試該接口。

URI

GET /v2/{project_id}/elb/listeners/{listener_id}

表1 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

操作用戶的項目ID。

獲取方法詳見獲取項目ID。

listener_id

String

監(jiān)聽器id。

請求消息

響應(yīng)消息

表2 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

listener

Listener object

監(jiān)聽器對象。詳見表3 listeners字段說明。

表3 listener字段說明

參數(shù)

參數(shù)類型

描述

id

String

監(jiān)聽器ID。

tenant_id

String

監(jiān)聽器所在的項目ID。

支持的最大字符長度:255

project_id

String

此參數(shù)和tenant_id參數(shù)含義一樣,均指監(jiān)聽器所在的項目ID。

name

String

監(jiān)聽器名稱。

注意:若名稱為空,則在控制臺的監(jiān)聽器列表無法選擇并查看監(jiān)聽器詳情。

支持的最大字符長度:255

description

String

監(jiān)聽器描述信息。

支持的最大字符長度:255

protocol

String

監(jiān)聽器的監(jiān)聽協(xié)議。

支持TCP、HTTP、UDP、TERMINATED_HTTPS。

protocol_port

Integer

監(jiān)聽器的監(jiān)聽端口。

取值范圍:[1, 65535]。

loadbalancers

Array of Loadbalancers objects

監(jiān)聽器關(guān)聯(lián)的 負載均衡 器 ID。詳細參見表8。

connection_limit

Integer

監(jiān)聽器的最大連接數(shù)。

取值范圍:[-1, 2147483647]。默認為-1,無連接數(shù)限制。

該字段為預(yù)留字段,暫未啟動。

admin_state_up

Boolean

監(jiān)聽器的管理狀態(tài)。

該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。

  • true表示開啟。
  • false表示關(guān)閉。

http2_enable

Boolean

HTTP2功能的開啟狀態(tài)。

取值范圍:true/false。true:開啟。false:關(guān)閉。

僅針對監(jiān)聽器的協(xié)議為TERMINATED_HTTPS有意義。

default_pool_id

String

監(jiān)聽器的默認后端 云服務(wù)器 組ID。

當(dāng)請求沒有匹配的轉(zhuǎn)發(fā)策略時,轉(zhuǎn)發(fā)到默認后端云服務(wù)器上處理。當(dāng)該字段為null時,表示監(jiān)聽器無默認的后端云服務(wù)器組。

default_tls_container_ref

String

監(jiān)聽器使用的服務(wù)器證書ID。詳細參見SSL證書管理。

當(dāng)protocol參數(shù)為TERMINATED_HTTPS時,為必選字段。

支持的最大字符長度:128

client_ca_tls_container_ref

String

監(jiān)聽器使用的CA證書ID。

支持的最大字符長度:128

詳細參見SSL證書管理。

sni_container_refs

Array

監(jiān)聽器使用的SNI證書(帶域名的服務(wù)器證書)ID的列表。

該字段不為空列表時,SNI特性開啟。該字段為空列表時,SNI特性關(guān)閉。

tags

Array

監(jiān)聽器的標簽。

created_at

String

監(jiān)聽器的創(chuàng)建時間。YYYY-MM-DDTHH:MM:SS

updated_at

String

監(jiān)聽器的更新時間。YYYY-MM-DDTHH:MM:SS

insert_headers

InsertHeaders object

HTTP擴展頭部,內(nèi)部字段全量同步,不選則為默認值。

可以將從負載均衡器到后端云服務(wù)器的路徑中需要被后端云服務(wù)器用到的信息寫入HTTP中,隨報文傳遞到后端云服務(wù)器上。

例如可通過X-Forwarded-ELB-IP開關(guān),將負載均衡器的 彈性公網(wǎng)IP 傳到后端云服務(wù)器。詳細參見表9。

tls_ciphers_policy

String

監(jiān)聽器使用的安全策略,僅對TERMINATED_HTTPS協(xié)議類型的監(jiān)聽器有效,且默認值為tls-1-0。

取值包括:tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多種安全策略。各安全策略使用的加密套件列表。詳細參見表10。

表4 loadbalancers字段說明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

關(guān)聯(lián)的負載均衡器id

表5 insert_headers字段說明

參數(shù)

是否必選

參數(shù)類型

描述

X-Forwarded-ELB-IP

Boolean

負載均衡器彈性 公網(wǎng)IP 透傳開關(guān)。打開時可以將負載均衡器的彈性公網(wǎng)IP從報文的HTTP頭中帶到后端云服務(wù)器。

取值范圍:true/false。true:開啟。false:關(guān)閉。

默認:關(guān)閉。

X-Forwarded-Host

Boolean

負載均衡器X-Forwarded-Host重寫開關(guān)。打開時可以將客戶請求頭的X-Forwarded-Host設(shè)置為請求頭的Host帶到后端云服務(wù)器

取值范圍:true/false。true:開啟。false:關(guān)閉。

默認:開啟。

表6 tls_ciphers_policy取值說明

安全策略

支持的TLS版本類型

使用的加密套件列表

tls-1-0-inherit

TLS 1.2 TLS 1.1 TLS 1.0

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA

tls-1-0

TLS 1.2 TLS 1.1 TLS 1.0

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA

tls-1-1

TLS 1.2 TLS 1.1

tls-1-2

TLS 1.2

tls-1-2-strict

TLS 1.2

ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

請求示例

  • 請求樣例
    GET https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/listeners/09e64049-2ab0-4763-a8c5-f4207875dc3e

響應(yīng)示例

  • 響應(yīng)樣例
    {
        "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",
            "insert_headers":{
                "X-Forwarded-ELB-IP":true,
                "X-Forwarded-Host":true
            },
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    }

返回碼

請參見狀態(tài)碼