創建轉發規則
更新時間 2025-05-23 22:35:12
最近更新時間: 2025-05-23 22:35:12
分享文章
接口功能介紹
創建轉發規則
接口約束
無
URI
POST /v4/elb/create-rule
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客戶端存根，用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 區域ID | ||
| listenerID | 是 | String | 監聽器ID | ||
| priority | 否 | Integer | 優先級，數字越小優先級越高，取值范圍為：1-100(目前不支持配置此參數,只取默認值100) | 100 | |
| description | 否 | String | 支持拉丁字母、中文、數字, 特殊字符： |
《》？：“”【】、；‘'，。、，不能以 http: / https: 開頭，長度 0 - 128 | acl |
| conditions | 是 | Array of Objects | 匹配規則數據 | conditions | |
| action | 是 | Object | 規則目標 | action |
表 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 | 默認規則動作類型。取值范圍：forward、redirect、deny(目前暫不支持配置為deny) | ||
| forwardConfig | 否 | Object | 轉發配置 | forwardConfig | |
| redirectListenerID | 否 | String | 重定向監聽器ID，當type為redirect時，此字段必填 |
表 forwardConfig
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| targetGroups | 否 | Array of Objects | 后端服務組 | targetGroup |
表 targetGroup
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| targetGroupID | 是 | String | 后端服務組ID | ||
| weight | 否 | Integer | 權重，取值范圍：1-256。默認為100 | 100 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ID | String | 轉發規則 ID | xxxx |
枚舉參數
無
請求示例
請求url
POST /v4/elb/create-rule
請求頭header
無
請求體body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"listenerID": "listener-3ba2dlfbec",
"description": "yacos_test",
"conditions": [
{
"type": "server_name",
"serverNameConfig": {
"serverName": "yacos-test.com"
},
"urlPathConfig": {
"urlPaths": "abcd",
"matchType": "PREFIX"
}
}
],
"action": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 10
}
]
}
}
}
響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [
{
"ID": "Xxxx"
}
]
}
狀態碼
請參考
錯誤碼
請參考
