查看监听器详情
更新时间 2025-10-29 14:20:52
最近更新时间: 2025-10-29 14:20:52
接口功能介绍
查看监听器详情
接口约束
无
URI
GET /v4/elb/show-listener
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| ID | 否 | String | 监听器ID, 该字段后续废弃 | xxx | |
| listenerID | 是 | String | 监听器ID, 推荐使用该字段, 当同时使用 ID 和 listenerID 时，优先使用 listenerID | xxx |
请求参数
请求头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 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用区名称 | az1 | |
| projectID | String | 项目ID | 0 | |
| ID | String | 监听器ID | xxx | |
| name | String | 监听器名称 | test | |
| description | String | 描述 | desc | |
| loadBalancerID | String | 负载均衡实例ID | lb-xxx | |
| protocol | String | 监听协议: TCP / UDP / HTTP / HTTPS | TCP | |
| protocolPort | Integer | 监听端口 | 8080 | |
| certificateID | String | 证书ID | cert-xxx | |
| caEnabled | Boolean | 是否开启双向认证 | true | |
| clientCertificateID | String | 双向认证的证书ID | xxx | |
| defaultAction | Object | 默认规则动作 | defaultAction | |
| accessControlID | String | 访问控制ID | xxx | |
| accessControlType | String | 访问控制类型: Close / White / Black | Close | |
| forwardedForEnabled | Boolean | 是否开启x forward for功能 | true | |
| status | String | 监听器状态: DOWN / ACTIVE | DOWN | |
| createdTime | String | 创建时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| updatedTime | String | 更新时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| allPortForward | Integer | 全端口转发功能开关 | 0 | |
| startPort | Integer | 全端口转发的起始port | 0 | |
| endPort | Integer | 全端口转发的最终port | 0 | |
| establishTimeout | Integer | 建立连接超时时间 | 10 | |
| idleTimeout | Integer | 连接空闲断开超时时间 | 1 | |
| responseTimeout | Integer | 响应超时，单位秒 | 1 | |
| cps | Integer | cps大小 | 1 | |
| qps | Integer | qps大小 | 1 | |
| nat64 | Integer | nat64功能开关 | 0 | |
| gzip | Integer | gzip压缩功能开关 | 0 | |
| 表 defaultAction |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 默认规则动作类型: forward / redirect | forward | |
| forwardConfig | Object | 转发配置 | forwardConfig | |
| redirectListenerID | String | 重定向监听器ID | xxx | |
| 表 forwardConfig |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服务组 | targetGroups | |
| 表 targetGroups |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服务组ID | tg-xxx | |
| weight | String | 权重 | 100 |
枚举参数
无
请求示例
请求url
GET /v4/elb/show-listener?regionID=81f7728662dd11ec810800155d307d5b&listenerID=xxxxx
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "listener-d8pg797eao",
"name": "yacos-test-update",
"description": "yacos-test-update",
"loadBalancerID": "lb-ai7x5ulq4t",
"protocol": "HTTP",
"protocolPort": 8080,
"certificateID": "",
"caEnabled": true,
"clientCertificateID": "",
"defaultAction": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 20
}
]
},
"redirectListenerID": null
},
"accessControlID": "ac-or6bz91ihq",
"accessControlType": "White",
"forwardedForEnabled": true,
"status": "ACTIVE",
"createdTime": "2022-10-01T07: 14: 59Z",
"updatedTime": "2022-10-01T07: 15: 46Z"
}
]
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
