華為云計(jì)算 云知識(shí) 查詢監(jiān)聽(tīng)器列表ListListeners
查詢監(jiān)聽(tīng)器列表ListListeners

 

功能介紹

查詢監(jiān)聽(tīng)器列表。支持過(guò)濾查詢和分頁(yè)查詢。如未特殊說(shuō)明,匹配規(guī)則為精確匹配。

可以通過(guò)監(jiān)聽(tīng)器ID、協(xié)議類型、監(jiān)聽(tīng)端口號(hào)、關(guān)聯(lián)的后端 云服務(wù)器 的IP等查詢監(jiān)聽(tīng)器。

調(diào)試

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

URI

GET /v2/{project_id}/elb/listeners

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

操作用戶的項(xiàng)目ID。

獲取方法詳見(jiàn)獲取項(xiàng)目ID。

表2 查詢參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

marker

String

分頁(yè)查詢的起始的資源ID,表示上一頁(yè)最后一條查詢記錄的監(jiān)聽(tīng)器的ID。

必須與limit一起使用。

limit

Integer

分頁(yè)查詢每頁(yè)的監(jiān)聽(tīng)器個(gè)數(shù)。如果不設(shè)置,則默認(rèn)不分頁(yè)查詢所有。

page_reverse

Boolean

分頁(yè)的順序,true表示從后往前分頁(yè),false表示從前往后分頁(yè),默認(rèn)為false。

必須與limit一起使用。

id

String

監(jiān)聽(tīng)器 ID。

name

String

監(jiān)聽(tīng)器名稱。

支持的最大字符長(zhǎng)度:255

description

String

監(jiān)聽(tīng)器的描述信息。

支持的最大字符長(zhǎng)度:255

loadbalancer_id

String

監(jiān)聽(tīng)器所在的 負(fù)載均衡 器ID。

connection_limit

Integer

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

admin_state_up

Boolean

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

該字段為預(yù)留字段,暫未啟用。默認(rèn)為true。

default_pool_id

String

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

當(dāng)請(qǐng)求沒(méi)有匹配的轉(zhuǎn)發(fā)策略時(shí),轉(zhuǎn)發(fā)到默認(rèn)后端云服務(wù)器上處理。

http2_enable

Boolean

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

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

default_tls_container_ref

String

監(jiān)聽(tīng)器使用的服務(wù)器證書(shū)ID。

client_ca_tls_container_ref

String

監(jiān)聽(tīng)器使用的CA證書(shū)ID。

protocol

String

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

取值范圍:TCP、HTTP、UDP、TERMINATED_HTTPS。

protocol_port

Integer

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

enterprise_project_id

String

企業(yè)項(xiàng)目ID,僅用于基于企業(yè)項(xiàng)目的細(xì)粒度鑒權(quán)使用。

  • 如果參數(shù)傳遞default_pool_id,則以pool對(duì)應(yīng)的企業(yè)項(xiàng)目ID鑒權(quán)。
  • 如果default_pool_id和enterprise_project_id都沒(méi)有傳遞 ,則進(jìn)行細(xì)粒度鑒權(quán) ,必須在用戶組下分配elb:*list權(quán)限才能通過(guò)鑒權(quán)。

tls_ciphers_policy

String

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

取值包括:tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多種安全策略。各安全策略使用的加密套件列表詳細(xì)參見(jiàn)表3。

表3 tls_ciphers_policy取值說(shuō)明

安全策略

支持的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

請(qǐng)求消息

無(wú)

響應(yīng)消息

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

參數(shù)

參數(shù)類型

描述

listeners

Array of Listeners objects

監(jiān)聽(tīng)器對(duì)象列表。詳見(jiàn)表5。

表5 listener字段說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

監(jiān)聽(tīng)器ID。

tenant_id

String

監(jiān)聽(tīng)器所在的項(xiàng)目ID。

支持的最大字符長(zhǎng)度:255

project_id

String

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

name

String

監(jiān)聽(tīng)器名稱。

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

支持的最大字符長(zhǎng)度:255

description

String

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

支持的最大字符長(zhǎng)度:255

protocol

String

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

支持TCP、HTTP、UDP、TERMINATED_HTTPS。

protocol_port

Integer

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

取值范圍:[1, 65535]。

loadbalancers

Array of Loadbalancers objects

監(jiān)聽(tīng)器關(guān)聯(lián)的負(fù)載均衡器 ID。詳細(xì)參見(jiàn)表8。

connection_limit

Integer

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

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

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

admin_state_up

Boolean

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

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

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

http2_enable

Boolean

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

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

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

default_pool_id

String

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

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

default_tls_container_ref

String

監(jiān)聽(tīng)器使用的服務(wù)器證書(shū)ID。詳細(xì)參見(jiàn)SSL證書(shū)管理

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

支持的最大字符長(zhǎng)度:128

client_ca_tls_container_ref

String

監(jiān)聽(tīng)器使用的CA證書(shū)ID。

支持的最大字符長(zhǎng)度:128

詳細(xì)參見(jiàn)SSL證書(shū)管理。

sni_container_refs

Array

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

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

tags

Array

監(jiān)聽(tīng)器的標(biāo)簽。

created_at

String

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

updated_at

String

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

insert_headers

InsertHeaders object

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

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

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

tls_ciphers_policy

String

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

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

表6 loadbalancers字段說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

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

表7 insert_headers字段說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

X-Forwarded-ELB-IP

Boolean

負(fù)載均衡器彈性 公網(wǎng)IP 透?jìng)鏖_(kāi)關(guān)。打開(kāi)時(shí)可以將負(fù)載均衡器的彈性公網(wǎng)IP從報(bào)文的HTTP頭中帶到后端云服務(wù)器。

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

默認(rèn):關(guān)閉。

X-Forwarded-Host

Boolean

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

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

默認(rèn):開(kāi)啟。

表8 tls_ciphers_policy取值說(shuō)明

安全策略

支持的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

請(qǐng)求示例

  • 請(qǐng)求樣例1 查詢?nèi)勘O(jiān)聽(tīng)器
    GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners
  • 請(qǐng)求樣例2 查詢協(xié)議類型為UDP的監(jiān)聽(tīng)器
    GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners?protocol=UDP

響應(yīng)示例

  • 響應(yīng)樣例1
    {
        "listeners": [
            {
                "client_ca_tls_container_ref": null,
                "protocol": "TCP",
                "description": "",
                "default_tls_container_ref": null,
                "admin_state_up": true,
                "http2_enable": false,
                "loadbalancers": [
                    {
                        "id": "bc7ba445-035a-4464-a1a3-a62cf4a14116"
                    }
                ],
                "tenant_id": "601240b9c5c94059b63d484c92cfe308",
                "project_id": "601240b9c5c94059b63d484c92cfe308",
                "sni_container_refs": [],       
     
                "connection_limit": -1,
                "protocol_port": 80,
                "default_pool_id": "ed75f16e-fcc6-403e-a3fb-4eae82005eab",
                "id": "75045172-70e9-480d-9443-b8b6459948f7",
                "tags": [],
                "name": "listener-cb2n",
                "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"
            },
            {
                "client_ca_tls_container_ref": null,
                "protocol": "TCP",
                "description": "",
                "default_tls_container_ref": null,
                "admin_state_up": true,
                "http2_enable": false,
                "loadbalancers": [
                    {
                        "id": "165b6a38-5278-4569-b747-b2ee65ea84a4"
                    }
                ],
                "tenant_id": "601240b9c5c94059b63d484c92cfe308",
                "sni_container_refs": [],           
     
                "connection_limit": -1,
                "protocol_port": 8080,
                "default_pool_id": null,
                "id": "dada0003-7b0e-4de8-a4e1-1e937be2ba14",
                "tags": [],
                "name": "lsnr_name_mod",
                "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"
            }
        ]
    }
  • 響應(yīng)樣例2
    {
        "listeners": [
            {
                "insert_headers": null,
                "protocol_port": 64809,
                "protocol": "UDP",
                "description": "",
                "default_tls_container_ref": null,
                "sni_container_refs": [],
                "loadbalancers": [
                    {
                        "id": "c1127125-64a9-4394-a08a-ef3be8f7ef9c"
                    }
                ],
                "tenant_id": "601240b9c5c94059b63d484c92cfe308",
                "project_id": "601240b9c5c94059b63d484c92cfe308",
                "created_at": "2018-11-29T13:56:21",
                "client_ca_tls_container_ref": null,
                "connection_limit": -1,
                "updated_at": "2018-11-29T13:56:22",
                "http2_enable": false,
                "insert_headers":{
                    "X-Forwarded-ELB-IP":true,
                    "X-Forwarded-Host":true
                },
     
                "admin_state_up": true,
                "default_pool_id": "2f6895be-019b-4c82-9b53-c4a2ac009e20",
                "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c",
                "tags": [],
                "name": "listener-tvp8"
            }
        ]
    }

返回碼

請(qǐng)參見(jiàn)狀態(tài)碼