Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Data Source schema for Byteplus::ALB::Listener
Using getListener
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getListener(args: GetListenerArgs, opts?: InvokeOptions): Promise<GetListenerResult>
function getListenerOutput(args: GetListenerOutputArgs, opts?: InvokeOptions): Output<GetListenerResult>def get_listener(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetListenerResult
def get_listener_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetListenerResult]func LookupListener(ctx *Context, args *LookupListenerArgs, opts ...InvokeOption) (*LookupListenerResult, error)
func LookupListenerOutput(ctx *Context, args *LookupListenerOutputArgs, opts ...InvokeOption) LookupListenerResultOutput> Note: This function is named LookupListener in the Go SDK.
public static class GetListener
{
public static Task<GetListenerResult> InvokeAsync(GetListenerArgs args, InvokeOptions? opts = null)
public static Output<GetListenerResult> Invoke(GetListenerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
public static Output<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
fn::invoke:
function: bytepluscc:alb/getListener:getListener
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Uniquely identifies the resource.
- Id string
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
- id string
- Uniquely identifies the resource.
- id str
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
getListener Result
The following output properties are available:
- Access
Log stringRecord Customized Headers Enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- Acl
Ids List<string> - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- Acl
Type string - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- Ca
Certificate stringId - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- Ca
Certificate stringSource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- Cert
Center stringCertificate Id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- Certificate
Id string - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- Certificate
Source string - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- Created
Time string - 监听器的创建时间。
- Customized
Cfg stringId - 个性化配置ID,未绑定时值为空字符串。
- Description string
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- Domain
Extensions List<Byteplus.Get Listener Domain Extension> - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- Enable
Http2 string - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- Enable
Quic string - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- Enabled string
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- Id string
- Uniquely identifies the resource.
- Listener
Id string - 监听器 ID。
- Listener
Name string - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- Load
Balancer stringId - 监听器所属的负载均衡实例 ID。
- Pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- Pca
Root stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- Pca
Sub stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- Port int
- 监听器的监听端口,取值:1 - 65535 。
- Project
Name string - 监听器所属项目名称。
- Protocol string
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- Server
Group stringId - 监听器的默认服务器组。
- Server
Groups List<Byteplus.Get Listener Server Group> - 关联监听器的所有服务器组。
- Status string
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
-
List<Byteplus.
Get Listener Tag> - 监听器所属标签。
- Updated
Time string - 监听器最近一次的操作时间。
- Access
Log stringRecord Customized Headers Enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- Acl
Ids []string - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- Acl
Type string - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- Ca
Certificate stringId - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- Ca
Certificate stringSource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- Cert
Center stringCertificate Id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- Certificate
Id string - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- Certificate
Source string - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- Created
Time string - 监听器的创建时间。
- Customized
Cfg stringId - 个性化配置ID,未绑定时值为空字符串。
- Description string
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- Domain
Extensions []GetListener Domain Extension - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- Enable
Http2 string - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- Enable
Quic string - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- Enabled string
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- Id string
- Uniquely identifies the resource.
- Listener
Id string - 监听器 ID。
- Listener
Name string - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- Load
Balancer stringId - 监听器所属的负载均衡实例 ID。
- Pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- Pca
Root stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- Pca
Sub stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- Port int
- 监听器的监听端口,取值:1 - 65535 。
- Project
Name string - 监听器所属项目名称。
- Protocol string
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- Server
Group stringId - 监听器的默认服务器组。
- Server
Groups []GetListener Server Group - 关联监听器的所有服务器组。
- Status string
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
-
[]Get
Listener Tag - 监听器所属标签。
- Updated
Time string - 监听器最近一次的操作时间。
- access
Log StringRecord Customized Headers Enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- acl
Ids List<String> - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- acl
Type String - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- ca
Certificate StringId - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- ca
Certificate StringSource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- cert
Center StringCertificate Id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- certificate
Id String - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- certificate
Source String - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- created
Time String - 监听器的创建时间。
- customized
Cfg StringId - 个性化配置ID,未绑定时值为空字符串。
- description String
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- domain
Extensions List<GetListener Domain Extension> - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- enable
Http2 String - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- enable
Quic String - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- enabled String
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- id String
- Uniquely identifies the resource.
- listener
Id String - 监听器 ID。
- listener
Name String - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- load
Balancer StringId - 监听器所属的负载均衡实例 ID。
- pca
Leaf StringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- pca
Root StringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- pca
Sub StringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- port Integer
- 监听器的监听端口,取值:1 - 65535 。
- project
Name String - 监听器所属项目名称。
- protocol String
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- server
Group StringId - 监听器的默认服务器组。
- server
Groups List<GetListener Server Group> - 关联监听器的所有服务器组。
- status String
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
-
List<Get
Listener Tag> - 监听器所属标签。
- updated
Time String - 监听器最近一次的操作时间。
- access
Log stringRecord Customized Headers Enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- acl
Ids string[] - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- acl
Type string - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- ca
Certificate stringId - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- ca
Certificate stringSource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- cert
Center stringCertificate Id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- certificate
Id string - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- certificate
Source string - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- created
Time string - 监听器的创建时间。
- customized
Cfg stringId - 个性化配置ID,未绑定时值为空字符串。
- description string
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- domain
Extensions GetListener Domain Extension[] - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- enable
Http2 string - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- enable
Quic string - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- enabled string
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- id string
- Uniquely identifies the resource.
- listener
Id string - 监听器 ID。
- listener
Name string - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- load
Balancer stringId - 监听器所属的负载均衡实例 ID。
- pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- pca
Root stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- pca
Sub stringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- port number
- 监听器的监听端口,取值:1 - 65535 。
- project
Name string - 监听器所属项目名称。
- protocol string
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- server
Group stringId - 监听器的默认服务器组。
- server
Groups GetListener Server Group[] - 关联监听器的所有服务器组。
- status string
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
-
Get
Listener Tag[] - 监听器所属标签。
- updated
Time string - 监听器最近一次的操作时间。
- access_
log_ strrecord_ customized_ headers_ enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- acl_
ids Sequence[str] - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- acl_
status str - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- acl_
type str - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- ca_
certificate_ strid - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- ca_
certificate_ strsource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- cert_
center_ strcertificate_ id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- certificate_
id str - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- certificate_
source str - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- created_
time str - 监听器的创建时间。
- customized_
cfg_ strid - 个性化配置ID,未绑定时值为空字符串。
- description str
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- domain_
extensions Sequence[GetListener Domain Extension] - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- enable_
http2 str - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- enable_
quic str - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- enabled str
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- id str
- Uniquely identifies the resource.
- listener_
id str - 监听器 ID。
- listener_
name str - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- load_
balancer_ strid - 监听器所属的负载均衡实例 ID。
- pca_
leaf_ strcertificate_ id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- pca_
root_ strca_ certificate_ id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- pca_
sub_ strca_ certificate_ id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- port int
- 监听器的监听端口,取值:1 - 65535 。
- project_
name str - 监听器所属项目名称。
- protocol str
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- server_
group_ strid - 监听器的默认服务器组。
- server_
groups Sequence[GetListener Server Group] - 关联监听器的所有服务器组。
- status str
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
-
Sequence[Get
Listener Tag] - 监听器所属标签。
- updated_
time str - 监听器最近一次的操作时间。
- access
Log StringRecord Customized Headers Enabled - 监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
- acl
Ids List<String> - 监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
- acl
Type String - 访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
- ca
Certificate StringId - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
- ca
Certificate StringSource - HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
- cert
Center StringCertificate Id - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
- certificate
Id String - HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
- certificate
Source String - HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
- created
Time String - 监听器的创建时间。
- customized
Cfg StringId - 个性化配置ID,未绑定时值为空字符串。
- description String
- 监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
- domain
Extensions List<Property Map> - HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
- enable
Http2 String - HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
- enable
Quic String - QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
- enabled String
- 监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
- id String
- Uniquely identifies the resource.
- listener
Id String - 监听器 ID。
- listener
Name String - 监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
- load
Balancer StringId - 监听器所属的负载均衡实例 ID。
- pca
Leaf StringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- pca
Root StringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
- pca
Sub StringCa Certificate Id - HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
- port Number
- 监听器的监听端口,取值:1 - 65535 。
- project
Name String - 监听器所属项目名称。
- protocol String
- 监听器的协议,支持 HTTP 协议和 HTTPS 协议。
- server
Group StringId - 监听器的默认服务器组。
- server
Groups List<Property Map> - 关联监听器的所有服务器组。
- status String
- 监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
- List<Property Map>
- 监听器所属标签。
- updated
Time String - 监听器最近一次的操作时间。
Supporting Types
GetListenerDomainExtension
- Cert
Center stringCertificate Id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- Certificate
Id string - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- Certificate
Source string - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- Domain string
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- Domain
Extension stringId - 扩展域名 ID 。
- Listener
Id string - 扩展域名所属的监听器 ID。
- Pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- San string
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
- Cert
Center stringCertificate Id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- Certificate
Id string - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- Certificate
Source string - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- Domain string
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- Domain
Extension stringId - 扩展域名 ID 。
- Listener
Id string - 扩展域名所属的监听器 ID。
- Pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- San string
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
- cert
Center StringCertificate Id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- certificate
Id String - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- certificate
Source String - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- domain String
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- domain
Extension StringId - 扩展域名 ID 。
- listener
Id String - 扩展域名所属的监听器 ID。
- pca
Leaf StringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- san String
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
- cert
Center stringCertificate Id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- certificate
Id string - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- certificate
Source string - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- domain string
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- domain
Extension stringId - 扩展域名 ID 。
- listener
Id string - 扩展域名所属的监听器 ID。
- pca
Leaf stringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- san string
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
- cert_
center_ strcertificate_ id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- certificate_
id str - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- certificate_
source str - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- domain str
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- domain_
extension_ strid - 扩展域名 ID 。
- listener_
id str - 扩展域名所属的监听器 ID。
- pca_
leaf_ strcertificate_ id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- san str
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
- cert
Center StringCertificate Id - 域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
- certificate
Id String - 域名使用的服务器证书 ID。当证书来源为 alb 时生效。
- certificate
Source String - 域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
- domain String
- 域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
- domain
Extension StringId - 扩展域名 ID 。
- listener
Id String - 扩展域名所属的监听器 ID。
- pca
Leaf StringCertificate Id - HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
- san String
- 若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
GetListenerServerGroup
- Server
Group stringId - 服务器组 ID 。
- Server
Group stringName - 服务器组名称。
- Server
Group stringId - 服务器组 ID 。
- Server
Group stringName - 服务器组名称。
- server
Group StringId - 服务器组 ID 。
- server
Group StringName - 服务器组名称。
- server
Group stringId - 服务器组 ID 。
- server
Group stringName - 服务器组名称。
- server_
group_ strid - 服务器组 ID 。
- server_
group_ strname - 服务器组名称。
- server
Group StringId - 服务器组 ID 。
- server
Group StringName - 服务器组名称。
GetListenerTag
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
