查看轉發規則列表
更新時間 2025-05-23 22:35:06
最近更新時間: 2025-05-23 22:35:06
分享文章
接口功能介紹
獲取轉發規則列表
接口約束
無
URI
GET /v4/elb/list-rule
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 區域ID | ||
| IDs | 否 | String | 轉發規則ID列表，以,分隔 | rule-75ex90k9v0,rule-r4cfhgrsss | |
| loadBalancerID | 否 | 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 | ||
| loadBalancerID | String | 負載均衡ID | ||
| listenerID | String | 監聽器ID | ||
| priority | Integer | 優先級 | 100 | |
| description | String | 描述 | ||
| conditions | Array of Objects | 匹配規則數據 | conditions | |
| action | Object | 規則目標 | action | |
| status | String | 狀態: ACTIVE / DOWN | ||
| createdTime | String | 創建時間，為UTC格式 | ||
| updatedTime | String | 更新時間，為UTC格式 |
表 conditions
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| type | String | 類型。取值范圍：server_name（服務名稱）、url_path（匹配路徑） | ||
| serverNameConfig | Object | 服務名稱 | serverNameConfig | |
| urlPathConfig | Object | 匹配路徑 | urlPathConfig |
表 serverNameConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| serverName | String | 服務名稱 |
表 urlPathConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| urlPaths | String | 匹配路徑 | ||
| matchType | String | 匹配類型。取值范圍：ABSOLUTE，PREFIX，REG |
表 action
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| type | String | 默認規則動作類型 | ||
| forwardConfig | Object | 轉發配置 | forwardConfig | |
| redirectListenerID | String | 重定向監聽器ID |
表 forwardConfig
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服務組 | targetGroup |
表 targetGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服務組ID | ||
| weight | Integer | 權重 | 100 |
枚舉參數
無
請求示例
請求url
GET /v4/elb/list-rule?regionID=xxxx
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [
{
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"azName": null,
"projectID": "0",
"ID": "rule-ao56mpc7uj",
"loadBalancerID": "lb-ai7x5ulq4t",
"listenerID": "listener-3ba2dlfbec",
"priority": 100,
"description": "yacos_test",
"conditions": [
{
"type": "server_name",
"serverNameConfig": {
"serverName": "yacos-test.com"
},
"urlPathConfig": {
"urlPaths": "",
"matchType": "ABSOLUTE"
}
}
],
"action": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 10
}
]
},
"redirectListenerID": null
},
"status": "ACTIVE",
"createdTime": "2022-10-01T06: 30: 21Z",
"updatedTime": "2022-10-01T06: 30: 21Z"
}
]
}
狀態碼
請參考
錯誤碼
請參考
