查看監聽器詳情
更新時間 2025-05-23 22:35:48
最近更新時間: 2025-05-23 22:35:48
分享文章
接口功能介紹
查看監聽器詳情
接口約束
無
URI
GET /v4/elb/show-listener
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 區域ID | ||
| ID | 否 | String | 監聽器ID, 該字段后續廢棄 | ||
| listenerID | 是 | String | 監聽器ID, 推薦使用該字段, 當同時使用 ID 和 listenerID 時，優先使用 listenerID |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗） | 800 | |
| message | String | statusCode為900時的錯誤信息; statusCode為800時為success, 英文 | success | |
| description | String | statusCode為900時的錯誤信息; statusCode為800時為成功, 中文 | 成功 | |
| errorCode | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS | SUCCESS | |
| returnObj | Array of Objects | 接口業務數據 | returnObj | |
| error | String | statusCode為900時為業務細分錯誤碼，三段式：product.module.code; statusCode為800時為SUCCESS |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 區域ID | ||
| azName | String | 可用區名稱 | ||
| projectID | String | 項目ID | ||
| ID | String | 監聽器ID | ||
| name | String | 監聽器名稱 | ||
| description | String | 描述 | ||
| loadBalancerID | String | 負載均衡實例ID | ||
| protocol | String | 監聽協議: TCP / UDP / HTTP / HTTPS | ||
| protocolPort | Integer | 監聽端口 | 8080 | |
| certificateID | String | 證書ID | ||
| caEnabled | Boolean | 是否開啟雙向認證 | true | |
| clientCertificateID | String | 雙向認證的證書ID | ||
| defaultAction | Array of Objects | 默認規則動作 | defaultAction | |
| accessControlID | String | 訪問控制ID | ||
| accessControlType | String | 訪問控制類型: Close / White / Black | ||
| forwardedForEnabled | Boolean | 是否開啟x forward for功能 | true | |
| status | String | 監聽器狀態: DOWN / ACTIVE | ||
| createdTime | String | 創建時間，為UTC格式 | ||
| updatedTime | String | 更新時間，為UTC格式 |
表 defaultAction
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| type | String | 默認規則動作類型: forward / redirect | ||
| forwardConfig | Object | 轉發配置 | forwardConfig | |
| redirectListenerID | String | 重定向監聽器ID |
表 forwardConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服務組 | targetGroup |
枚舉參數
無
請求示例
請求url
GET /v4/elb/show-listener?regionID=81f7728662dd11ec810800155d307d5b&listenerID=xxxxx
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "listener-d8pg797eao",
"name": "yacos-test-update",
"description": "yacos-test-update",
"loadBalancerID": "lb-ai7x5ulq4t",
"protocol": "HTTP",
"protocolPort": 8080,
"certificateID": "",
"caEnabled": true,
"clientCertificateID": "",
"defaultAction": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 20
}
]
},
"redirectListenerID": null
},
"accessControlID": "ac-or6bz91ihq",
"accessControlType": "White",
"forwardedForEnabled": true,
"status": "ACTIVE",
"createdTime": "2022-10-01T07: 14: 59Z",
"updatedTime": "2022-10-01T07: 15: 46Z"
}
]
}
狀態碼
請參考
錯誤碼
請參考
