接口功能介绍
获取转发规则列表
接口约束
无
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"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
