ListenerName

String

否

监听器的名字。

• 不能以http://或https://开头。
• 必须以字母或中文开头，可包含数字、点（.）、下划线（_）和短横线（-）。
• 长度限制在1-128字符之间。

test

Enabled

String

否

监听器开启/关闭，取值如下：

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

on

CertificateSource

String

否

监听器关联的默认证书的来源，每次修改默认证书时，务必指定该参数，否则默认值为 alb ，系统将按 alb 证书处理。支持的取值如下：

• alb（默认）：表示通过 ALB 上传的证书。

• cert_center：表示通过火山证书中心上传的证书。

cert_center

EnableHttp2

String

否

HTTP2.0 特性开关，该参数仅对 HTTPS 监听器有效，取值如下：

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

off

EnableQuic

String

否

QUIC 特性开关，该参数仅对 HTTPS 监听器有效，取值如下：

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

off

CustomizedCfgId

String

否

绑定个性化配置。

• 只能绑定 Active 状态的个性化配置。
• 要删除个性化配置时设置该字段为空字符串。不传该参数时不做修改。

ccfg-*****

AclStatus

String

否

• 是否开启访问控制功能。取值如下：
  • on：开启。
  • off ：不开启。
• 不填表示不修改访问控制相关信息。
• 配置本参数后会清空已配置的AclType和AclIds参数。
• 如果将本参数值从 on 修改为 off，将清空AclType和AclIds参数中的值。
• 如果将本参数值从 off 修改为 on，则必须同时设置AclType和AclIds参数的值。

off

AclType

String

否

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

• white：白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器不会转发任何请求。
• black：黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。如果所选策略组中没有添加任何IP，则监听器会转发全部请求。
  当AclStatus参数配置为 on 时，AclType和AclIds.N为必填。

black

AclIds.N

List of String

否

监听器绑定的访问控制策略组ID。

• - N：表示访问控制策略组的序号，数量上限为5个。
• 多个访问控制策略组ID间使用“&”分隔。
  当AclStatus参数配置为 on 时，AclType和AclIds.N为必填。

Description

String

否

监听器的描述信息。

• 不能以http://或https://开头。
• 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。） 。
• 长度限制为1 ～ 255个字符。

test

DomainExtensions.N.Domain

域名。 - N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个。 格式规范具体如下：

• 通常不能为空。但是如果实例支持自动选择扩展证书，即SniAutoMatch为on，则DomainExtensions.N.Domain需传入空字符串。
• 需至少包含一个‘.’，且不允许以‘.’开头或结尾。
• 仅允许包含小写字母、数字、‘.’、‘-‘、‘*’。
• 长度限制为1 ～ 128个字符。
• 泛域名：使用“*”代替1个或多个字符。
  • “*”必须在域名开头或结尾。
  • 同一条域名中“*”不能出现两次。
  • “*”前后不能有除了.以外的字符。
  • 合法示例：*.com、www.test.*。
  • 非法示例：*aaa.com、www.*.com
• 精确域名：符合域名规范的精确域名，例如：www.test.com。
• 同一HTTPS监听器下的域名不能重复。
• 匹配域名时，对域名的大小写不敏感。

DomainExtensions.1.Domain=abc.com&DomainExtensions.2.Domain=def.com

DomainExtensions.N.CertificateSource

String

否

• 域名使用的服务器证书来源，支持取值如下：

  • alb：表示通过 ALB 上传的证书。

  • cert_center：表示通过火山证书中心上传的证书。

• - N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。

• 每次修改默认证书时，务必指定该参数，否则默认值为 alb ，系统将按 alb 证书处理。

DomainExtensions.1.CertificateSource=cert_center&DomainExtensions.2.CertificateSource=alb

DomainExtensions.N.CertificateId

String

否

• 域名使用的服务器证书。当修改扩展证书且证书来源为 alb 时，需要指定该参数。

• - N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个。

DomainExtensions.1.CertificateId=cert-qwertyuqwert&DomainExtensions.2.CertificateId=cert-zxcvbgasdfn

DomainExtensions.N.CertCenterCertificateId

String

否

• 域名使用的服务器证书。 修改扩展证书且证书来源为 cert_center 时，需要指定该参数。

• - N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个，取值1～20。

DomainExtensions.1.CertCenterCertificateId=cert-qwertyuqwert&DomainExtensions.2.CertCenterCertificateId=cert-zxcvbgasdfn

DomainExtensions.N.Action

List of Struct

否

对指定扩展域名的操作，- N：表示域名的序号，一个HTTPS监听器能关联的扩展域名上限为20个。支持：

• create（新增）。
• modify（修改）。
• delete（删除）。

DomainExtensions.1.Action=add&DomainExtensions.2.Action=modify

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'CertCenterCertificateId'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: CertCenterCertificateId。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'DomainExtensions.CertificateId'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: DomainExtensions.CertificateId。

400

InvalidListenerName.Malformed

The specified ListenerName is malformed.

指定的 ListenerName 参数格式不合法。

400

InvalidServerGroup.InvalidStatus

The specified ServerGroup is not in the correct status for the request.

指定的服务器组所处状态无法响应该请求。

400

InvalidCertificateType.FunctionMismatch

The specified Certificate's type and Function do not match.

指定的证书的类型与预期功能不匹配。

400

OperationDenied.DualStackEnableQuicUnsupported

The request on the specified Listener is denied due to the dual stack load balancer listener not support to enable quic.

因双栈 ALB 实例暂时不支持监听器开启 Quic，对于该监听器的操作请求被拒绝。

400

InvalidDomainExtensions.Domain.Malformed

The specified DomainExtensions.Domain is malformed.

指定的 DomainExtensions.Domain 参数格式不合法。

400

InvalidDomainExtensions.Domain.Duplicated

The specified DomainExtensions.Domain is duplicated. Domain Extensions in one listener can not be same.

指定的 DomainExtensions.Domain 重复。一个监听器下关联的扩展域名不能重复。

400

InvalidDomainExtensions.DomainExtensionId.Duplicated

The specified DomainExtensions.DomainExtensionId is duplicated. Only one type domain extension action is supported on one domain extension in one request.

指定的 DomainExtensions.DomainExtensionId 重复。一次请求中指定的扩展域名仅支持一种操作。

400

OperationFailed.OperateGtmFailed

The request on the specified resource failed due to operating gtm failed.

因操作 GTM 实例失败，对于该资源的操作请求失败。

400

QuotaExceed.SniDomainPerListener

You've reached the limit on the number of sni domains per listener you can associate with, resource xxx, usage xx/xx.

已达到每个监听器可关联的 sni 域名的数量上限。资源是xxx，目前已使用xxx，配额为xxx。

400

QuotaExceed.AclPerListener

You've reached the limit on the number of ACLs per listener you can associate with, resource xxx, usage xx/xx.

已达到每个监听器可关联的 ACL 的数量上限。资源是xxx，目前已使用xxx，配额为xxx。

400

InvalidCertificateId.Duplicated

The specified CertificateId is duplicated. Certificates in one listener can not be same.

指定的 CertificateId 重复。一个监听器下的证书不能重复。

404

InvalidLoadBalancer.NotFound

The specified LoadBalancer does not exist.

指定的 ALB 实例不存在。

404

InvalidServerGroup.NotFound

The specified ServerGroup does not exist.

指定的服务器组不存在。

404

InvalidDomainExtensions.Certificate.NotFound

The specified DomainExtension Certificate does not exist.

指定的扩展域名证书不存在。

404

InvalidDomainExtension.NotFound

The specified Domain Extension does not exist.

指定的扩展域名不存在。