负载均衡
负载均衡
应用型负载均衡ALB
请输入
- 文档首页
负载均衡API 参考监听器DescribeListenerAttributes - 查询指定监听器的详细信息
复制全文
下载 pdfDescribeListenerAttributes - 查询指定监听器的详细信息
文档反馈
问问助手调用 DescribeListenerAttributes 接口，查看指定监听器详情。
使用说明
每秒最多提交 200 个 API 请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeListenerAttributes
要执行的操作，取值：DescribeListenerAttributes。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
ListenerId string 必选 示例值：lsn-*******
监听器 ID 。
返回参数
XRealIpEnabled string 示例值：on
监听器开启/禁用X-real-ip Header。
- on：开启。
- off：关闭。
RequestId string 示例值：20210816110638****2514606306AF947C
请求 ID。
ListenerId string 示例值：lsn-*********
监听器 ID。
ListenerName string 示例值：test
监听器名字。
CreateTime string 示例值：2021-12-14T11:13:40+08:00
监听器的创建时间。
UpdateTime string 示例值：2021-12-14T11:13:40+08:00
监听器最近一次的操作时间。
LoadBalancerId string 示例值：alb-**********
监听器所属的负载均衡实例 ID。
Status string 示例值：Active
监听器的状态。
- Creating：创建中。
- Active： 运行中。
- Pending： 变配中。
- Disabled：已停止。
- Deleting：删除中。
Enabled string 示例值：off
是否启用监听器。
- on：开启。
- off：关闭。
Protocol string 示例值：HTTPS
监听器的协议。
- HTTP
- HTTPS
Port integer 示例值：80
监听器的监听端口。
ServerGroupId string 示例值：rsp-*******
监听器的默认服务器组。
ServerGroups object[] 示例值：-
关联监听器的所有服务器组。
ServerGroupId string 示例值：rsp-888888
服务器组 ID 。
ServerGroupName string 示例值：pool
服务器组名称。
Description string 示例值：test
监听器的描述。
CertificateSource string 示例值：cert_center
HTTPS监听器关联的默认证书的来源，取值：
- alb：表示通过 ALB 上传的证书。
- cert_center：表示通过火山引擎证书中心购买或上传的 SSL 证书。
CertificateId string 示例值：cert-******
HTTPS监听器关联的证书 ID。当证书来源为 alb 时生效。
CertCenterCertificateId string 示例值：cert-******
HTTPS监听器关联的证书 ID。当证书来源为 cert_center 时生效。
CACertificateSource string 示例值：pca_root
HTTPS 监听器关联的 CA 证书的来源。
- alb：表示通过 ALB 上传的证书。
- pca_root：表示通过火山引擎证书中心购买或上传的私有根 CA 证书。
- pca_sub：表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
CACertificateId string 示例值：cert-******
HTTPS 监听器关联的 CA 证书 ID。当证书来源是 alb 时生效。
PcaRootCACertificateId string 示例值：cert-******
HTTPS 监听器关联的 CA 证书 ID。当证书来源是 pca_root 时生效。
PcaSubCACertificateId string 示例值：cert-******
HTTPS 监听器关联的 CA 证书 ID。当证书来源是 pca_sub 时生效。
EnableHttp2 string 示例值：off
HTTP2.0 特性开关。
- on：开启。
- off：关闭。
EnableQuic string 示例值：off
QUIC 特性开关。
- on：开启。
- off：关闭。
AclStatus string 示例值：off
是否开启访问控制功能。
- on：开启。
- off ：不开启。
AclType string 示例值：black
访问控制的方式。
- white：白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP，则监听器不会转发任何请求。
- black：黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP，则监听器会转发全部请求。
AclIds string[] 示例值：["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"]
监听器绑定的访问控制策略组 ID，仅 AclStatus 参数为 on 时返回。
CustomizedCfgId string 示例值：ccfg-****
个性化配置ID，未绑定时值为" "。
DomainExtensions object[] 示例值：-
HTTPS监听器关联的扩展域名列表。
PcaLeafCertificateId string 示例值：cert-********
域名使用的服务器证书 ID 。当证书来源为 pca_leaf 时生效。
San string
证书的CommonName、扩展域名和IP， 用‘，’分隔。
DomainExtensionId string 示例值：dc-*******
扩展域名 ID。
CertificateSource string 示例值：cert_center
域名使用的服务器证书的来源。
- alb：表示通过 ALB 上传的证书。
- cert_center：表示通过火山证书中心上传的证书。
- pca_leaf：表示通过火山证书中心上传的私有证书。
CertificateId string 示例值：cert-*****
域名使用的服务器证书 ID。当证书来源为 alb 时生效。
CertCenterCertificateId string 示例值：cert-******
域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
Domain string 示例值：abc.com
域名。
当实例的SniAutoMatch="off"的时候，为用户输入的域名；否则为""
ListenerId string 示例值：lsn-****
扩展域名所属的监听器 ID。
ProjectName string 示例值：default
监听器所属项目名称。
Tags object[] 示例值：-
监听器所属标签。
Key string 示例值：key
用户标签的标签键。具体规则如下：
长度限制为1～128个字符。
大小写敏感。
不能以volc:的任意大小写组合开头。
不能以空格开头或结尾。
允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
同一资源的标签键不允许重复。
Value string 示例值：value
用户标签的标签键。具体规则如下：
长度限制为1～128个字符。
大小写敏感。
不能以volc:的任意大小写组合开头。
不能以空格开头或结尾。
允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
同一资源的标签键不允许重复。
AccessLogRecordCustomizedHeadersEnabled string 示例值：on
监听器是否已开启“在访问日志中记录自定义header”的功能。
- on：表示该功能已开启。
- off：表示该功能未开启。
PcaLeafCertificateId string 示例值：cert-*********
HTTPS监听器关联的证书 ID。当证书来源为 pca_leaf 时生效。
请求示例
GET /?Action=DescribeListenerAttributes&ListenerId=lsn-12345678****A7&Version=2020-04-01 HTTP/1.1
Host: alb.cn-beijing.volcengineapi.com
X-Date: 20251121T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"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"
]
}
}
错误码
最近更新时间：2026.02.27 11:57:36
这个页面对您有帮助吗？
有用
有用
无用
无用