查看转发规则详情
更新时间 2025-09-10 12:05:19
最近更新时间: 2025-09-10 12:05:19
接口功能介绍
获取转发规则详情
接口约束
无
URI
GET /v4/elb/show-rule
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| ID | 否 | String | 转发规则ID, 该字段后续废弃 | xxx | |
| policyID | 否 | String | 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID | xxxx |
请求参数
请求头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 | Object | 接口业务数据 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用区名称 | az1 | |
| projectID | String | 项目ID | 0 | |
| ID | String | 转发规则ID | xxx | |
| loadBalancerID | String | 负载均衡ID | lb-xxx | |
| listenerID | String | 监听器ID | listener-xxx | |
| priority | Integer | 优先级 | 100 | |
| description | String | 描述 | desc | |
| conditions | Array of Objects | 匹配规则数据 | conditions | |
| action | Object | 规则目标 | action | |
| status | String | 状态: ACTIVE / DOWN | DOWN | |
| createdTime | String | 创建时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| updatedTime | String | 更新时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| 表 conditions |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 类型。取值范围：server_name（服务名称）、url_path（匹配路径） | server_name | |
| serverNameConfig | Object | 服务名称 | serverNameConfig | |
| urlPathConfig | Object | 匹配路径 | urlPathConfig | |
| 表 serverNameConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| serverName | String | 服务名称 | xxx | |
| 表 urlPathConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| urlPaths | String | 匹配路径 | /// | |
| matchType | String | 匹配类型。取值范围：ABSOLUTE，PREFIX，REG | REG | |
| 表 action |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 默认规则动作类型: forward / redirect | forward | |
| forwardConfig | Object | 转发配置 | forwardConfig | |
| redirectListenerID | String | 重定向监听器ID | listener-xxx | |
| 表 forwardConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服务组 | targetGroups | |
| 表 targetGroups |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服务组ID | tg-xxx | |
| weight | Integer | 权重 | 100 |
枚举参数
无
请求示例
请求url
GET /v4/elb/show-rule?regionID=xxxx&policyID=xxx
请求头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"
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
