查看監聽器列表
更新時間 2025-05-23 22:35:47
最近更新時間: 2025-05-23 22:35:47
分享文章
接口功能介紹
查看監聽器列表
接口約束
無
URI
GET /v4/elb/list-listener
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客戶端存根，用于保證訂單冪等性。要求單個云平臺賬戶內唯一, 公共參數不支持修改, 長度 1 - 64 | ||
| regionID | 是 | String | 區域ID | ||
| projectID | 否 | String | 企業項目ID，默認為'0' | ||
| IDs | 否 | String | 監聽器ID列表，以','分隔 | 'listener-75ex90k9v0,listener-cert-r4cfhgrsss' | |
| name | 否 | String | 監聽器名稱 | ||
| loadBalancerID | 否 | String | 負載均衡實例ID | ||
| accessControlID | 否 | String | 訪問控制ID |
請求參數
請求頭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 | 是否開啟雙向認證 | false | |
| clientCertificateID | String | 雙向認證的證書ID | ||
| defaultAction | Array of Objects | 默認規則動作 | defaultAction | |
| accessControlID | String | 訪問控制ID | ||
| accessControlType | String | 訪問控制類型: Close / White / Black | ||
| forwardedForEnabled | Boolean | 是否開啟x forward for功能 | false | |
| status | String | 監聽器狀態: DOWN / ACTIVE | ||
| createdTime | String | 創建時間，為UTC格式 | ||
| updatedTime | String | 更新時間，為UTC格式 |
表 defaultAction
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| type | String | 默認規則動作類型: forward / redirect | ||
| forwardConfig | Array of Objects | 轉發配置 | forwardConfig | |
| redirectListenerID | String | 重定向監聽器ID |
表 forwardConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服務組 | targetGroup |
表 targetGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服務組ID | ||
| weight | Integer | 權重 | 20 |
枚舉參數
無
請求示例
請求url
GET /v4/elb/list-listener?regionID=xxxx
請求頭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"
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"azName":null,
"projectID":"0",
"ID":"listener-3ba2dlfbec",
"name":"yacos-test",
"description":"yacos-test",
"loadBalancerID":"lb-ai7x5ulq4t",
"protocol":"HTTP",
"protocolPort":80,
"certificateID":"",
"caEnabled":false,
"clientCertificateID":"",
"defaultAction":{
"type":"forward",
"forwardConfig":{
"targetGroups":[
{
"targetGroupID":"tg-td6uhtxhso",
"weight":20
}
]
},
"redirectListenerID":null
},
"accessControlID":"",
"accessControlType":"Close",
"forwardedForEnabled":false,
"status":"ACTIVE",
"createdTime":"2022-10-01T04:06:42Z",
"updatedTime":"2022-10-01T04:06:42Z"
}
]
}
狀態碼
請參考
錯誤碼
請參考
