查询指定地域的监听。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alb:ListListeners | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I4FmYAXGKPd**** |
| MaxResults | integer | 否 | 本次读取的最大数据记录数量，此参数为可选参数。取值范围：1~100。入参为空时，默认值为 20。 | 50 |
| ListenerIds | array | 否 | 监听实例 ID 列表。最多支持 20 个监听 ID。 | |
| string | 否 | 监听实例 ID。 | lsn-o4u54y73wq7b****** | |
| LoadBalancerIds | array | 否 | 应用型负载均衡实例 ID。最多支持 20 个实例 ID。 | |
| string | 否 | 应用型负载均衡实例 ID。 | alb-bd6oylbckp6k9x**** | |
| ListenerProtocol | string | 否 | 需要过滤的监听协议。取值：
| HTTP |
| Tag | array<object> | 否 | 标签。 | |
| object | 否 | 标签结构。 | ||
| Key | string | 否 | 标签键。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。 | env |
| Value | string | 否 | 标签值。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。 | product |
返回参数
示例
正常返回示例
JSON格式
{
"Listeners": [
{
"DefaultActions": [
{
"ForwardGroupConfig": {
"ServerGroupTuples": [
{
"ServerGroupId": "sgp-i5qt20******"
}
]
},
"Type": "ForwardGroup"
}
],
"GzipEnabled": false,
"Http2Enabled": false,
"IdleTimeout": 3,
"ListenerDescription": "HTTP_80",
"ListenerId": "lsn-o4u34y73wq7b******",
"ListenerPort": 80,
"ListenerProtocol": "HTTP",
"ListenerStatus": "Running",
"LoadBalancerId": "alb-bd6oylbckp6k9x****",
"LogConfig": {
"AccessLogRecordCustomizedHeadersEnabled": true,
"AccessLogTracingConfig": {
"TracingEnabled": true,
"TracingSample": 100,
"TracingType": "Zipkin"
}
},
"QuicConfig": {
"QuicListenerId": "lsn-o4u54y73wq7b******",
"QuicUpgradeEnabled": true
},
"RequestTimeout": 34,
"SecurityPolicyId": "tls_cipher_policy_1_1",
"XForwardedForConfig": {
"XForwardedForClientCertClientVerifyAlias": "test_client-verify-alias_123456",
"XForwardedForClientCertClientVerifyEnabled": true,
"XForwardedForClientCertFingerprintAlias": "test_finger-print-alias_123456",
"XForwardedForClientCertFingerprintEnabled": true,
"XForwardedForClientCertIssuerDNAlias": "test_issue-dn-alias_123456",
"XForwardedForClientCertIssuerDNEnabled": true,
"XForwardedForClientCertSubjectDNAlias": "test_subject-dn-alias_123456",
"XForwardedForClientCertSubjectDNEnabled": true,
"XForwardedForClientSrcPortEnabled": true,
"XForwardedForEnabled": true,
"XForwardedForProtoEnabled": true,
"XForwardedForSLBIdEnabled": true,
"XForwardedForSLBPortEnabled": true,
"XForwardedForClientSourceIpsEnabled": false,
"XForwardedForClientSourceIpsTrusted": "10.1.1.0/24"
},
"Tags": [
{
"Key": "env",
"Value": "product"
}
]
}
],
"MaxResults": 50,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
"TotalCount": 1000
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 负载均衡操作鉴权失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-29 | OpenAPI 错误码发生变更 | 查看变更详情 |