調用DescribeListener接口查詢指定監聽的配置信息。
接口說明
本接口用于查詢指定監聽的配置信息,包括監聽的路由類型、狀態、創建的時間戳、端口信息等。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:DescribeListener | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實例所在的地域 ID,僅取值cn-hangzhou。 | cn-hangzhou |
ListenerId | string | 是 | 要查詢的監聽的 ID。 | lsr-bp1bpn0kn908w4nbw**** |
返回參數
示例
正常返回示例
JSON
格式
{
"Description": "Listener",
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
"State": "active",
"CreateTime": "1577786252000",
"PortRanges": [
{
"FromPort": 20,
"ToPort": 20
}
],
"BackendPorts": [
{
"FromPort": "80",
"ToPort": "80"
}
],
"Certificates": [
{
"Type": "Server",
"Id": "449****-cn-hangzhou"
}
],
"Protocol": "tcp",
"ListenerId": "lsr-bp1bpn0kn908w4nbw****",
"ClientAffinity": "SOURCE_IP",
"Name": "Listener",
"RelatedAcls": [
{
"AclId": "123",
"Status": "off"
}
],
"AclType": "white",
"AcceleratorId": "ga-bp1odcab8tmno0hdq****",
"ProxyProtocol": false,
"XForwardedForConfig": {
"XForwardedForGaIdEnabled": false,
"XForwardedForGaApEnabled": false,
"XForwardedForProtoEnabled": false,
"XForwardedForPortEnabled": false,
"XRealIpEnabled": false
},
"SecurityPolicyId": "tls_cipher_policy_1_0",
"Type": "Standard",
"ServiceId": "ALB",
"ServiceManaged": true,
"ServiceManagedInfos": [
{
"Action": "Update",
"ChildType": "Listener",
"IsManaged": false
}
],
"IdleTimeout": 900,
"RequestTimeout": 60,
"HttpVersion": "http2"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NotExist.Listener | listener %s is not exist | 監聽%s不存在。 |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 處理請求時出現錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-27 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-08-15 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-04-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2021-04-27 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |