负载均衡
负载均衡
应用型负载均衡ALB
请输入
- 文档首页
负载均衡API 参考监听器CreateListener - 创建监听器
复制全文
下载 pdfCreateListener - 创建监听器
文档反馈
问问助手调用 CreateListener 接口，创建监听器。
使用说明
每秒最多提交 5 个 API 请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateListener
要执行的操作，取值：CreateListener。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
XRealIpEnabled string 可选 示例值：on
监听器开启/禁用X-real-ip Header。取值如下： * on（默认值）：开启。 * off：关闭。
ListenerName string 可选 示例值：test
监听器的名字。
- 不填默认以“协议-端口”格式命名。
- 不能以http://或https://开头。
- 必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。
- 长度限制在1-128字符之间。
Protocol string 必选 示例值：HTTP
监听器的协议。取值如下：
- HTTP
- HTTPS
Port integer 必选 示例值：80
监听器的监听端口，取值范围为：1 - 65535 。
Enabled string 可选 示例值：on
开启/关闭监听器，取值如下：
- on（默认值）：开启。
- off：关闭。
CertificateSource string 可选 示例值：cert_center
默认证书的来源。该参数仅对 HTTPS 监听器有效，取值如下：
- alb：表示通过 ALB 上传的证书。标准版ALB实例不支持此取值。
- cert_center：表示通过火山引擎证书中心购买或上传的 SSL 证书。
CACertificateId string 可选 示例值：cert-******
监听器关联的 CA 证书的 ID。该参数用于 HTTPS 监听器的双向认证。
CACertificateSource 的值为 alb 时，必须指定 CACertificateId 参数。
CertCenterCertificateId string 可选 示例值：cert-********
监听器关联的证书ID，创建 HTTPS 监听器且证书来源为 cert_center 时必传。
EnableHttp2 string 可选 示例值：off
HTTP2.0 特性开关，该参数仅对 HTTPS 监听器有效，取值如下：
- on：开启。
- off（默认值）：关闭。
Tags.N.Value string[] 可选 示例值：Tags.1.Value=v1&Tags.2.Value=v2
用户标签的标签值。
- 如果传入该参数，则必须先传入Tags.N.Key。
- 具体规则如下：
- 长度限制为0～256个字符。
- 大小写敏感。
- 不能以空格开头或结尾。
- 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
EnableQuic string 可选 示例值：off
QUIC 特性开关，该参数仅对 HTTPS 监听器有效，取值如下：
- on：开启。
- off（默认值）：关闭。
- 只有标准版 ALB 实例支持 QUIC。如需使用 QUIC 功能，请联系您的客户经理。
Tags.N.Key string[] 可选 示例值：Tags.1.Key=k1&Tags.2.Key=k2
用户标签的标签键。具体规则如下：
- 长度限制为1～128个字符。
- 大小写敏感。
- 不能以volc:的任意大小写组合开头。
- 不能以空格开头或结尾。
- 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
- 同一资源的标签键不允许重复。
AclStatus string 可选 示例值：off
是否开启访问控制功能。取值如下：
- on：开启。
- off（默认值） ：不开启。
PcaLeafCertificateId string 可选 示例值：cert-********
监听器关联的证书ID，创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
AclType string 可选 示例值：black
访问控制的方式。取值如下:
- white：白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器不会转发任何请求。
- black：黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器会转发全部请求。
- 当AclStatus参数配置为 on 时，AclType和AclIds.N为必填。
Description string 可选 示例值：test
监听器的描述信息。
- 不能以http://或https://开头。
- 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。） 。
- 长度限制为1 ～ 255个字符。
- 不填默认为空字符串。
CACertificateSource string 可选 示例值：pca_root
监听器关联的 CA 证书的来源。该参数仅对 HTTPS 监听器有效，用于双向认证。取值如下：
- alb（默认）：表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。
- pca_root：表示通过火山引擎证书中心购买或上传的私有根 CA 证书。
- pca_sub：表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
说明
如需为 HTTPS 监听器开启双向认证，您需要同时指定 CA 证书来源和 CA 证书 ID。
- CACertificateSource 的值为 alb 时，须指定 CACertificateId 参数。
- CACertificateSource 的值为 pca_root 时，须指定 PcaRootCACertificateId 参数。
- CACertificateSource 的值为 pca_sub 时，须指定 PcaSubCACertificateId 参数。
DomainExtensions.N.Domain string[] 可选 示例值：DomainExtensions.1.Domain=abc.com&DomainExtensions.2.Domain=def.com
域名。
- 参数- N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。
- 具体格式规范如下：
- 通常不能为空。但是如果实例支持自动选择扩展证书，即SniAutoMatch为on，则DomainExtensions.N.Domain需传入空字符串。
- 需至少包含一个‘.’，且不允许以‘.’开头或结尾。
- 仅允许包含小写字母、数字、‘.’、‘-‘、‘*’。
- 长度限制为1 ～ 128个字符。
- 泛域名：使用“*”代替1个或多个字符。
- “*”必须在域名开头或结尾。
- 同一条域名中“*”不能出现两次。
- “*”前后不能有除了.以外的字符。
- 合法示例：.com、www.test.。
- 非法示例：aaa.com、www..com 。
- 精确域名：符合域名规范的精确域名，例如：www.test.com。
- 同一HTTPS监听器下的域名不能重复。
- 匹配域名时，对域名的大小写不敏感。
DomainExtensions.N.CertificateSource string[] 可选 示例值：DomainExtensions.1.CertificateSource=cert_center&DomainExtensions.2.CertificateSource=alb
域名使用的服务器证书来源。
- 取值如下：
- alb：表示通过 ALB 上传的证书。标准版ALB实例不支持此取值。
- cert_center：表示通过火山引擎证书中心购买或上传的 SSL 证书。
- 参数 - N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。
PcaRootCACertificateId string 可选 示例值：cert-******
监听器关联的 CA 证书的 ID。该参数用于 HTTPS 监听器的双向认证。
CACertificateSource 的值为 pca_root 时，必须指定 PcaRootCACertificateId 参数。
DomainExtensions.N.CertCenterCertificateId string[] 可选 示例值：DomainExtensions.1.CertCenterCertificateId=cert-qwertyuqwert&DomainExtensions.2.CertCenterCertificateId=cert-zxcvbgasdfn
域名使用的服务器证书。
- 当证书来源为 cert_center 时有效。
- 参数- N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。
PcaSubCACertificateId string 可选 示例值：cert-******
监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。
CACertificateSource 的值为 pca_sub 时，必须指定 PcaSubCACertificateId 参数。
LoadBalancerId string 必选 示例值：alb-abcderf******
监听器所属的ALB实例ID。
CertificateId string 可选 示例值：cert-********
监听器关联的证书ID，创建 HTTPS 监听器且证书来源为 alb 时必传。
ServerGroupId string 必选 示例值：rsp-********
监听器关联的默认服务器组 ID。
AclIds.N string[] 可选 示例值：AclIds.1=acl-3cj44nv0jhhxc6c6rrtet****& AclIds.2=acl-2febxt4pu0zy85oxruw0t****
监听器绑定的访问控制策略组ID。
- 参数- N：表示访问控制策略组的序号，数量上限为5个。
- 多个访问控制策略组ID间使用&分隔。
- 当AclStatus参数配置为 on 时，AclType和AclIds.N为必填。
DomainExtensions.N.CertificateId string[] 可选 示例值：DomainExtensions.1.CertificateId=cert-qwertyuqwert&DomainExtensions.2.CertificateId=cert-zxcvbgasdfn
域名使用的服务器证书。
- 当证书来源为 alb 时有效。
- 参数- N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。
DomainExtensions.N.PcaLeafCertificateId string[] 可选 示例值：DomainExtensions.1.PcaLeafCertificateId=pca_leaf-qwertyuqwert&DomainExtensions.2.PcaLeafCertificateId=pca_leaf-zxcvbgasdfn
域名使用的服务器证书。
- 当证书来源为 pca_leaf 时有效。
- 参数-N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。
AccessLogRecordCustomizedHeadersEnabled string 可选 示例值：off
监听器开启/关闭访问日志记录Header。取值如下：
- on：开启。
- off（默认值）：关闭。
返回参数
RequestId string 示例值：20210811152539010225146063030****
请求 ID。
ListenerId string 示例值：lsn-2fek3rgsxhrsw5oxruwec****
监听器 ID。
请求示例
返回示例
错误码
最近更新时间：2026.07.06 20:39:17
这个页面对您有帮助吗？
有用
有用
无用
无用