Load Balancer
Load Balancer
Document
- Documentation
Load BalancerApplication Load Balancer (ALB)API ReferenceListenerDescribeListenerAttributes - Querying the details of specified listener
Copy page
Download PDFListener
DescribeListenerAttributes - Querying the details of specified listener
Copy pageDownload PDFDescribeListenerAttributes - Querying the details of specified listener
Call the DescribeListenerAttributes API to view details of the specified listener.
Instructions
Submit up to 200 API requests per second.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. More information can be found in Common parameters.
Action string required Example: DescribeListenerAttributes
Action to execute. Set the value to DescribeListenerAttributes.
Version string required Example: 2020-04-01
Current API version is 2020-04-01.
ListenerId string required Example: lsn-*******
Listener ID.
Response parameters
Only the response parameters specific to this API are listed below. More information, see Response structure.
XRealIpEnabled string Example: on
The listener enables/disables the X-real-ip header.
- on: Enable.
- off: Disable.
RequestId string Example: 20210816110638****2514606306AF947C
Request ID.
ListenerId string Example: lsn-*********
Listener ID.
ListenerName string Example: test
Listener name.
CreateTime string Example: 2021-12-14T11:13:40+08:00
Creation time of listener.
UpdateTime string Example: 2021-12-14T11:13:40+08:00
Last operation time of the listener.
LoadBalancerId string Example: alb-**********
The CLB instance ID to which the listener belongs.
Status string Example: Active
Listener status.
- Creating
- Active: Running.
- Pending: Modifying.
- Disabled: Stopped.
- Deleting
Enabled string Example: off
Enable the listener.
- on: Enable.
- off: Disable.
Protocol string Example: HTTPS
Listener protocol.
- HTTP
- HTTPS
Port integer Example: 80
The listening port of the listener.
ServerGroupId string Example: rsp-*******
Default server group of the listener.
ServerGroups object[] Example: -
All server groups associated with the listener.
ServerGroupId string Example: rsp-888888
Server group ID.
ServerGroupName string Example: pool
Name of the server group.
Description string Example: test
Description of the listener.
CertificateSource string Example: cert_center
The source of the default certificate associated with the HTTPS listener. Valid values:
- alb: Indicates the certificate uploaded via ALB.
- cert_center: Represents an SSL certificate purchased from or uploaded to the VolcanoEngine Certificate Center.
CertificateId string Example: cert-******
ID of the certificate bound to the HTTPS listener. Effective when the certificate source is alb.
CertCenterCertificateId string Example: cert-******
ID of the certificate bound to the HTTPS listener. Effective when the certificate source is cert_center.
CACertificateSource string Example: pca_root
Source of the CA certificate associated with the HTTPS listener.
- alb: Indicates the certificate uploaded via ALB.
- pca_root: Represents a private root CA certificate purchased from or uploaded to the VolcanoEngine Certificate Center.
- pca_sub: Represents a private sub CA certificate purchased from or uploaded to the VolcanoEngine Certificate Center.
CACertificateId string Example: cert-******
CA certificate ID associated with the HTTPS listener. Effective when the certificate source is alb.
PcaRootCACertificateId string Example: cert-******
CA certificate ID associated with the HTTPS listener. Effective when the certificate source is pca_root.
PcaSubCACertificateId string Example: cert-******
CA certificate ID associated with the HTTPS listener. Effective when the certificate source is pca_sub.
EnableHttp2 string Example: off
HTTP2.0 feature switch.
- on: Enable.
- off: Disable.
EnableQuic string Example: off
QUIC feature switch.
- on: Enable.
- off: Disable.
AclStatus string Example: off
Enable access control.
- on: Enable.
- off: Disable.
AclType string Example: black
Method of access control.
- white: Allowlist method. Indicates that the listener forwards requests only from the IP addresses or CIDR blocks set in the selected access control policy group. If no IPs are added to the selected policy group, the listener does not forward any requests.
- black: Denylist method. Indicates that the listener denies requests only from the IP addresses or CIDR blocks set in the selected access control policy group. If no IPs are added to the selected policy group, the listener forwards all requests.
AclIds string[] Example: ["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"]
The ID of the Access Control List (ACL) bound to the listener. Returned only when the AclStatus parameter is on.
CustomizedCfgId string Example: ccfg-****
Custom configuration ID.
DomainExtensions object[] Example: -
The list of additional domains associated with the HTTPS listener.
PcaLeafCertificateId string Example: cert-********
ID of the server certificate used by the domain. Effective when the certificate source is pca_leaf.
San string
The certificate's CommonName, additional domains, and IP addresses, separated by commas (,).
DomainExtensionId string Example: dc-*******
Additional domain ID.
CertificateSource string Example: cert_center
The server certificate source used by the domain name.
- alb: Indicates the certificate uploaded via ALB.
- cert_center: Indicates a certificate uploaded via VolcanoEngine Certificate Center.
- pca_leaf: Indicates a private certificate uploaded via VolcanoEngine Certificate Center.
CertificateId string Example: cert-*****
ID of the server certificate used by the domain. Effective when the certificate source is alb.
CertCenterCertificateId string Example: cert-******
ID of the server certificate used by the domain. Effective when the certificate source is cert_center.
Domain string Example: abc.com
The domain name.
When the instance's SniAutoMatch is "off", it is the domain name entered by the user.
ListenerId string Example: lsn-****
The ID of the listener to which the additional domain belongs.
ProjectName string Example: default
The project name that the listener belongs to.
Tags object[] Example: -
Tags associated with the listener.
Key string Example: key
The tag key of the custom tag. The specific rules are as follows:
Must be 1 to 128 characters.
Case-sensitive.
It cannot start with volc: or sys: in any case form.
Must not start or end with a space.
May include characters (any language), numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), minus signs (-) and at signs (@).
Duplicate tag keys are not allowed for the same resource.
Value string Example: value
The tag key of the custom tag. The specific rules are as follows:
Must be 1 to 128 characters.
Case-sensitive.
It cannot start with volc: or sys: in any case form.
Must not start or end with a space.
May include characters (any language), numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), minus signs (-) and at signs (@).
Duplicate tag keys are not allowed for the same resource.
AccessLogRecordCustomizedHeadersEnabled string Example: on
Whether the "record custom headers in access logs" feature is enabled for the listener.
- on: This feature is enabled.
- off: This feature is not enabled.
PcaLeafCertificateId string Example: cert-*********
ID of the certificate bound to the HTTPS listener. Effective when the certificate source is pca_leaf.
Request examples
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
Response examples
{
"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 codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Last updated: 2026.06.12 14:05:58
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
