接口功能介绍
查看监听器列表
接口约束
无
URI
GET /v4/elb/list-listener
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一, 公共参数不支持修改, 长度 1 - 64 | ||
| regionID | 是 | String | 区域ID | ||
| projectID | 否 | String | 企业项目ID，默认为'0' | ||
| IDs | 否 | String | 监听器ID列表，以','分隔 | 'listener-75ex90k9v0,listener-cert-r4cfhgrsss' | |
| name | 否 | String | 监听器名称 | ||
| loadBalancerID | 否 | String | 负载均衡实例ID | ||
| accessControlID | 否 | 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 | ||
| name | String | 监听器名称 | ||
| description | String | 描述 | ||
| loadBalancerID | String | 负载均衡实例ID | ||
| protocol | String | 监听协议: TCP / UDP / HTTP / HTTPS | ||
| protocolPort | Integer | 监听端口 | 8080 | |
| certificateID | String | 证书ID | ||
| caEnabled | Boolean | 是否开启双向认证 | false | |
| clientCertificateID | String | 双向认证的证书ID | ||
| defaultAction | Array of Objects | 默认规则动作 | defaultAction | |
| accessControlID | String | 访问控制ID | ||
| accessControlType | String | 访问控制类型: Close / White / Black | ||
| forwardedForEnabled | Boolean | 是否开启x forward for功能 | false | |
| status | String | 监听器状态: DOWN / ACTIVE | ||
| createdTime | String | 创建时间，为UTC格式 | ||
| updatedTime | String | 更新时间，为UTC格式 |
表 defaultAction
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 默认规则动作类型: forward / redirect | ||
| forwardConfig | Array of Objects | 转发配置 | forwardConfig | |
| redirectListenerID | String | 重定向监听器ID |
表 forwardConfig
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 后端服务组 | targetGroup |
表 targetGroup
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetGroupID | String | 后端服务组ID | ||
| weight | Integer | 权重 | 20 |
枚举参数
无
请求示例
请求url
GET /v4/elb/list-listener?regionID=xxxx
请求头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"
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"azName":null,
"projectID":"0",
"ID":"listener-3ba2dlfbec",
"name":"yacos-test",
"description":"yacos-test",
"loadBalancerID":"lb-ai7x5ulq4t",
"protocol":"HTTP",
"protocolPort":80,
"certificateID":"",
"caEnabled":false,
"clientCertificateID":"",
"defaultAction":{
"type":"forward",
"forwardConfig":{
"targetGroups":[
{
"targetGroupID":"tg-td6uhtxhso",
"weight":20
}
]
},
"redirectListenerID":null
},
"accessControlID":"",
"accessControlType":"Close",
"forwardedForEnabled":false,
"status":"ACTIVE",
"createdTime":"2022-10-01T04:06:42Z",
"updatedTime":"2022-10-01T04:06:42Z"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
