接口功能介绍
获取转发规则详情
接口约束
URI
GET /v4/elb/show-rule
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | string | 是 | 区域ID | |
| ID | String | 否 | 转发规则ID, 该字段后续废弃 | |
| policyID | String | 否 | 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| regionID | String | 区域ID | |
| azName | String | 可用区名称 | |
| projectID | String | 项目ID | |
| ID | String | 转发规则ID | |
| loadBalancerID | String | 负载均衡ID | |
| listenerID | String | 监听器ID | |
| priority | Integer | 优先级 | |
| description | String | 描述 | |
| conditions | Array of Object | 匹配规则数据 | |
| action | object | 规则目标 | |
| status | String | 状态: ACTIVE / DOWN | |
| createdTime | String | 创建时间，为UTC格式 | |
| updatedTime | String | 更新时间，为UTC格式 |
表 conditions
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| type | String | 类型。取值范围：server_name（服务名称）、url_path（匹配路径） | |
| serverNameConfig | Object | 服务名称 | |
| urlPathConfig | Object | 匹配路径 |
表 serverNameConfig
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| serverName | String | 服务名称 |
表 urlPathConfig
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| urlPaths | String | 匹配路径 | |
| matchType | String | 匹配类型。取值范围：ABSOLUTE，PREFIX，REG |
表 action
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| type | String | 默认规则动作类型: forward / redirect | |
| forwardConfig | object | 转发配置 | |
| redirectListenerID | String | 重定向监听器ID |
表 forwardConfig
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| targetGroups | Array of Object | 后端服务组 |
表 targetGroup
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| targetGroupID | String | 后端服务组ID | |
| weight | Integer | 权重 |
请求示例
GET /v4/elb/show-rule?regionID=xxxx&policyID=xxx
请求体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"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
