最近更新时间：2024.04.16 15:18:49
首次发布时间：2022.05.20 22:12:37
API 名称：DescribeListeners。
API 域名：open.volcengineapi.com 。
API 描述：查询监听器列表。
节流限制：每秒最多提交 200 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。
| 名称 | 类型 | 是否必选 | 格式 | 说明 |
|---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称，如 DescribeListeners。 |
| Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
| X-Expires | int | 否 | 900 | 表示签名的有效时间，单位是秒，默认值是900。 |
在使用该 API 提交请求时，请求正文中可以包含的参数如下。
| 参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
|---|---|---|---|---|
LoadBalancerId | String | 否 | 负载均衡实例ID。 | alb-********* |
| ListenerIds.N | List of String | 否 | 监听器的ID，N代表监听器的序号，一次查询数量上限为20个。 | ListenerIds.1=lsn-abc*****&ListenerIds.2=lsn-def******* |
| ListenerName | String | 否 | 监听器的名字。 | test |
Protocol | String | 否 | 监听器的协议。仅支持：
| HTTPS |
| PageSize | Integer | 否 | 分页查询时每页的记录数，取值1-100，默认为10。 | 20 |
| PageNumber | Integer | 否 | 列表的页码，默认值为1。 | 1 |
| ProjectName | String | 否 | 监听器所属项目名称。 | default |
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
RequestId | String | 请求ID。 | 20210816110638****2514606306AF947C |
| PageSize | Integer | 当前分页的记录数。 | 20 |
| PageNumber | Integer | 当前页码。 | 1 |
| TotalCount | Integer | 符合条件的监听器总数。 | 26 |
| Listeners | Array | 符合条件的监听器的详细信息，具体请参见下表 Listeners 。 | - |
Listeners
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
ListenerId | String | 监听器ID。 | lsn-******* |
| ListenerName | String | 监听器名字。 | test |
| CreateTime | String | 监听器的创建时间。 | 2021-12-29T16:37:37Z |
| UpdateTime | String | 监听器最近一次的操作时间。 | 2021-12-29T16:37:37Z |
Status | String | 监听器的状态，取值如下：
| Active |
Enabled | String | 是否启用监听器。
| on |
| Protocol | String | 监听器的协议，支持 HTTP 协议和 HTTPS 协议。 | HTTP |
| Port | Integer | 监听器的监听端口。 | 80 |
| ServerGroupId | String | 监听器的默认服务器组。 | rsp-******* |
| ServerGroups | Array | 关联监听器的所有服务器组，具体请参见下表 ServerGroups 。 | - |
| LoadBalancerId | String | 监听器所属的 ALB 实例 ID 。 | alb-********** |
| Description | String | 监听器的描述信息。 | test |
CertificateSource | String | HTTPS监听器关联的默认证书的来源，取值如下：
| cert_center |
| CertificateId | String | HTTPS监听器关联的证书 ID。当证书来源为 alb 时生效。 | cert-****** |
| CertCenterCertificateId | String | HTTPS监听器关联的证书 ID。当证书来源为 cert_center 时生效。 | cert-****** |
| CACertificateId | String | HTTPS 监听器关联的 CA 证书 ID。 | cert-****** |
EnableHttp2 | String | HTTP2.0 特性开关，取值如下：
| off |
EnableQuic | String | QUIC 特性开关，取值如下：
| off |
AclStatus | String | 是否开启访问控制功能，取值如下：
| off |
AclType | String | 访问控制的方式，取值如下：
| black |
| AclIds | List | 监听器绑定的访问控制策略组 ID，仅AclStatus参数为on时返回。 | ["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"] |
| CustomizedCfgId | String | 个性化配置ID，未绑定时值为" "。 | ccfg-**** |
| DomainExtensions | Array | HTTPS监听器关联的扩展域名列表，具体请参见下表 DomainExtensions 。 | - |
| ProjectName | String | 监听器所属项目名称。 | default |
ServerGroups
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
ServerGroupId | String | 服务器组 ID 。 | rsp-888888 |
| ServerGroupName | String | 服务器组名称。 | pool |
DomainExtensions
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
DomainExtensionId | String | 扩展域名 ID 。 | dc-******* |
CertificateSource | String | HTTPS监听器关联的默认证书的来源，取值如下：
| cert_center |
| CertificateId | String | 域名使用的服务器证书 ID 。当证书来源为 alb 时生效。 | cert-***** |
| CertCenterCertificateId | String | HTTPS监听器关联的证书 ID。当证书来源为 cert_center 时生效。 | cert-****** |
| Domain | String | 域名。 | abc.com |
| ListenerId | String | 扩展域名所属的监听器 ID 。 | lsn-**** |
GET /?Action=DescribeListeners&Version=2020-04-01&LoadBalancerId=alb-1g1f1c6aevm****buxws5k0k3&PageSize=20&PageNumber=1&ListenerIds.1=lsn-1g0swrgw****88ibuxwmboj9h&ListenerIds.2=lsn-1g0swrgw****88ibuxwmboj9h HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{ "ResponseMetadata": { "RequestId": "20210816110638****2514606306AF947C", "Action": "DescribeListeners", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210814160835****2514606300FFE0F3", "PageNumber": 1, "PageSize": 20, "TotalCount": 1, "Listeners": [ { "CreateTime": "2021-12-14T11:13:40+08:00", "UpdateTime": "2021-12-14T11:13:41+08:00", "ListenerId": "lsn-1g0swr****gu88ibuxwmboj9h", "ListenerName": "test", "Enabled": "on", "Protocol": "HTTP", "Port": 80, "Status": "Active", "ServerGroupId": "rsp-2ff2u228****w5oxruwe33hdz", "ServerGroups": [ { "ServerGroupId": "rsp-2134****1234", "ServerGroupName": "pool-1", }, { "ServerGroupId": "rsp-2134****1234", "ServerGroupName": "pool-2", } ] }, { "CreateTime": "2021-12-14T11:13:40+08:00", "UpdateTime": "2021-12-14T11:13:41+08:00", "ListenerId": "lsn-1g0swr****gu88ibuxwmboj9h", "ListenerName": "test", "Enabled": "on", "Protocol": "HTTP", "Port": 81, "Status": "Active", "ServerGroupId": "rsp-2ff2u228****w5oxruwe33hdz", "ServerGroups": [ { "ServerGroupId": "rsp-2134****1234", "ServerGroupName": "pool-1", }, { "ServerGroupId": "rsp-2134****1234", "ServerGroupName": "pool-2", } ] }, { "CreateTime":"2022-02-28T07:43:01Z", "UpdateTime":"2022-03-01T08:22:22Z", "ListenerId":"lsn-2feosm67lyghs5oxruw0b6b2z", "ListenerName":"yxl-listener", "Description":"", "AclStatus":"on", "AclType":"black", "AclIds":[ "acl-2fecyh9olyp6o5oxruw586umy" ], "Enabled":"on", "Protocol":"HTTP", "Port":82, "Status":"Active", "ServerGroupId":"rsp-2fe90sy6j32805oxruw5eyjq7", "CertificateId":"", "ServerGroups":[ { "ServerGroupId":"rsp-2fe90sy6j32805oxruw5eyjq7", "ServerGroupName":"default" } ] } ] } }
如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。
HTTP Code | 错误码 | 错误信息 | 错误描述 |
|---|---|---|---|
| 400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
400 | InvalidListenerName.Malformed | The specified ListenerName is malformed. | 指定的 ListenerName 参数格式不合法。 |
400 | LimitExceed.Listener | You've reached the limit on the number of listeners that you can operate at a time. | 已达到单次可操作的监听器的数量上限。 |
| 400 | InvalidProtocol.Malformed | The specified Protocol is malformed. | 指定的 Protocol 参数格式不合法。 |