查詢網絡型負載均衡實例的監聽詳情。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nlb:GetListenerAttribute | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ListenerId | string | 是 | 監聽 ID。 | lsn-bp1bpn0kn908w4nbw****@233 |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 否 | 網絡型負載均衡實例所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"RegionId": "cn-hangzhou",
"LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
"ListenerId": "lsn-bp1bpn0kn908w4nbw****@233",
"ListenerProtocol": "TCPSSL",
"ListenerPort": 233,
"StartPort": "233",
"EndPort": "455",
"ListenerDescription": "tcpssl_443",
"ServerGroupId": "sgp-ppdpc14gdm3x4o****",
"IdleTimeout": 900,
"SecurityPolicyId": "tls_cipher_policy_1_0",
"CertificateIds": [
"123157******"
],
"CaCertificateIds": [
"139a00******"
],
"CaEnabled": false,
"AlpnEnabled": false,
"AlpnPolicy": "HTTP1Only",
"ProxyProtocolEnabled": false,
"ProxyProtocolV2Config": {
"Ppv2VpcIdEnabled": false,
"Ppv2PrivateLinkEpIdEnabled": false,
"Ppv2PrivateLinkEpsIdEnabled": false
},
"SecSensorEnabled": false,
"ListenerStatus": "Running",
"Cps": 1000,
"Mss": 166,
"Tags": [
{
"TagKey": "ac-cus-tag-4",
"TagValue": "ON"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | SystemBusy | System is busy, please try again later. | 系統繁忙,請稍后重試 |
404 | ResourceNotFound.loadBalancer | The specified resource of loadbalancer is not found. | 找不到指定的負載均衡器資源,請檢查輸入參數。 |
404 | ResourceNotFound.listener | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-02-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-12 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-27 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-10-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-29 | OpenAPI 返回結構發生變更 | 查看變更詳情 |