查詢網絡型負載均衡監聽列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nlb:ListListeners | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerIds | array | 否 | 監聽實例 ID。最多支持 20 個監聽 ID。 | |
ListenerId | string | 否 | 監聽實例 ID。最多支持 20 個監聽 ID。 | lsn-bp1bpn0kn908w4nbw****@443 |
LoadBalancerIds | array | 否 | 網絡型負載均衡實例 ID。最多支持 20 個實例 ID。 | |
LoadBalancerId | string | 否 | 網絡型負載均衡實例 ID。最多支持 20 個實例 ID。 | nlb-83ckzc8d4xlp8o**** |
ListenerProtocol | string | 否 | 監聽協議。取值:TCP、UDP 或 TCPSSL。 | TCPSSL |
Tag | array<object> | 否 | 標簽列表。 | |
object | 否 | 標簽。 | ||
Key | string | 否 | 實例的標簽鍵。最多支持輸入 20 個標簽鍵。一旦輸入該值,則不允許為空字符串。 最多支持 64 個字符,不能以 | env |
Value | string | 否 | 實例的標簽值。最多支持輸入 20 個標簽值。一旦輸入該值,可以為空字符串。 最多支持 128 個字符,不能以 | product |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查詢時每次顯示的條目數。取值范圍:1~100,默認值為 20。 | 20 |
RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
SecSensorEnabled | string | 否 | 是否開啟秒級監控功能。取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"Listeners": [
{
"Tags": [
{
"Key": "Created",
"Value": "TF"
}
],
"LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
"ListenerId": "lsn-ga6sjjcll6ou34l1et****",
"ListenerProtocol": "TCPSSL",
"ListenerPort": 443,
"StartPort": "233",
"EndPort": "455",
"ListenerDescription": "tcpssl_443",
"ServerGroupId": "sgp-ppdpc14gdm3x4o****",
"IdleTimeout": 900,
"SecurityPolicyId": "tls_cipher_policy_1_1",
"CertificateIds": [
"123157******"
],
"CaCertificateIds": [
"139a00******"
],
"CaEnabled": false,
"ListenerStatus": "Running",
"RegionId": "cn-hangzhou",
"AlpnEnabled": false,
"AlpnPolicy": "HTTP1Only",
"SecSensorEnabled": false,
"ProxyProtocolEnabled": false,
"ProxyProtocolV2Config": {
"Ppv2VpcIdEnabled": false,
"Ppv2PrivateLinkEpIdEnabled": false,
"Ppv2PrivateLinkEpsIdEnabled": false
},
"Cps": 1000,
"Mss": 200
}
],
"TotalCount": 4,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | SystemBusy | System is busy, please try again later. | 系統繁忙,請稍后重試 |
400 | IllegalParam | The param of %s is illegal. | 輸入的參數有值非法,請檢查輸入。 |
403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因為賬號沒有權限,所以鑒權失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-02-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-12 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-27 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-09-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-29 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |