You need to enable JavaScript to run this app.
导航

DescribeListenerAttributes

最近更新时间2024.02.29 14:48:17

首次发布时间2022.05.20 22:12:43

API说明

API 名称:DescribeListenerAttributes。
API 域名:open.volcengineapi.com 。
API 描述:查询指定监听器的详细信息。

使用限制

节流限制:每秒最多提交 200 个 API 请求。

快速调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称,如 DescribeListenerAttributes。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint900表示签名的有效时间,单位是秒,默认值是900。

请求正文

在使用该 API 提交请求时,请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例值
ListenerId
String
监听器 ID 。
lsn-*******

响应正文

参数类型参数说明示例值
RequestIdString请求 ID。
20210816110638****2514606306AF947C
ListenerIdString监听器 ID。lsn-*********
ListenerNameString监听器名字。test
CreateTimeString监听器的创建时间。2021-12-14T11:13:40+08:00
UpdateTimeString监听器最近一次的操作时间。2021-12-14T11:13:40+08:00
LoadBalancerId
String监听器所属的负载均衡实例 ID。alb-**********

Status

String

监听器的状态,取值如下:

  • Creating:创建中。
  • Active: 运行中。
  • Pending: 变配中。
  • Disabled:已停止。
  • Deleting:删除中。

Active

Enabled

String

是否启用监听器。

  • on:开启。
  • off:关闭。

off

ProtocolString监听器的协议,支持 HTTP 协议和 HTTPS 协议。HTTPS
PortInteger监听器的监听端口。80
ServerGroupIdString监听器的默认服务器组。rsp-*******
ServerGroupsArray关联监听器的所有服务器组,具体请参见下表 ServerGroups-
DescriptionString监听器的描述。test
CertificateIdStringHTTPS 监听器关联的证书 ID。cert-******
CACertificateIdStringHTTPS 监听器关联的 CA 证书 ID。cert-******

EnableHttp2

String

HTTP2.0 特性开关,取值如下:

  • on:开启。
  • off:关闭。

off

EnableQuic

String

QUIC 特性开关,取值如下:

  • on:开启。
  • off:关闭。

off

AclStatus

String

是否开启访问控制功能,取值如下:

  • on:开启。
  • off :不开启。

off

AclType

String

访问控制的方式,取值如下:

  • white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。
  • black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。

black

AclIdsList监听器绑定的访问控制策略组 ID,仅 AclStatus 参数为 on 时返回。["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"]
CustomizedCfgIdString个性化配置ID,未绑定时值为" "。ccfg-****
DomainExtensions
ArrayHTTPS监听器关联的扩展域名列表,具体请参见下表 DomainExtensions-
ProjectNameString监听器所属项目名称。default

ServerGroups

参数类型参数说明示例值
ServerGroupId
String
服务器组 ID 。
rsp-888888
ServerGroupNameString服务器组名称。pool

DomainExtensions

参数类型参数说明示例值
DomainExtensionId
String
扩展域名 ID。
dc-*******
CertificateIdString域名使用的服务器证书 ID。cert-*****
DomainString域名。abc.com
ListenerIdString扩展域名所属的监听器 ID。lsn-****

示例

请求示例

GET /?Action=DescribeListenerAttributes&ListenerId=lsn-12345678****A7&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DescribeListenerAttributes",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },  
    "Result": {
        "RequestId": "20210814160835****2514606300FFE0F3",
        "ListenerId": "lsn-12345678****A7",
        "ListenerName": "test",
        "CreateTime": "2021-12-14T11:13:40+08:00",
        "UpdateTime": "2021-12-14T11:13:41+08:00",
        "LoadBalancerId": "alb-**********",
        "Status": "Active",
        "Enabled": "on",
        "Protocol": "HTTP",
        "Port": 80,
        "ServerGroupId": "rsp-2ff2u228****w5oxruwe33hdz",
        "ServerGroups": [
            {
                "ServerGroupId": "rsp-2134****1234",
                "ServerGroupName": "pool-1",
            },
            {
                "ServerGroupId": "rsp-2134****1234",
                "ServerGroupName": "pool-2",
            }
        ],
        "Description": "test",
        "CertificateId": "cert-123****989",
        "CACertificateId": "cert-123****999",
        "AclStatus":"on",
        "AclType":"black",
        "AclIds":["acl-2fecyh9olyp6o5oxruw586umy"]
    }
}

错误码

如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码

HTTP Code

错误码

错误信息

错误描述

404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。