查看ip_listener列表
更新时间 2025-10-29 14:21:11
最近更新时间: 2025-10-29 14:21:11
接口功能介绍
查看ip_listener列表
接口约束
无
URI
GET /v4/iplistener/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| ipListenerID | 否 | String | 监听器 ID | listener-xxx | |
| pageNumber | 否 | Integer | 列表的页码，默认值为 1。 | 1 | |
| pageSize | 否 | Integer | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 10 |
请求参数
请求头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 |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 接口业务数据 | results | |
| totalCount | Integer | 列表条目数 | 1 | |
| currentCount | Integer | 分页查询时每页的行数。 | 1 | |
| totalPage | Integer | 总页数 | 1 | |
| 表 results |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| gwElbID | String | 网关负载均衡 ID | gwlb-xxx | |
| name | String | 名字 | tset | |
| description | String | 描述 | desc | |
| ipListenerID | String | 监听器 id | listener-xxxx | |
| action | Object | 转发配置 | action | |
| 表 action |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 默认规则动作类型: forward / redirect | forward | |
| forwardConfig | Array of Objects | 转发配置 | forwardConfig | |
| 表 forwardConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服务组ID | tg-xxx | |
| weight | String | 权重 | 100 |
枚举参数
无
请求示例
请求url
GET /openapi/v4/iplistener/list?regionID=xxxx
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"descritption": "成功",
"returnObj":{
"results": [{
"gwElbID": "xxx",
"name": "xx",
"description": "xx",
"ipListenerID": "listener-xx",
"action": {
"type": "forward",
"targetGroups": [{
"targetGroupID": "tg-xxx",
"weight": 100
}]
}
}],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
