1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. alb
  5. getListener
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcenginecc.alb.getListener

Get Started
volcenginecc logo
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

    Data Source schema for Volcengine::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: volcenginecc:alb/getListener:getListener
      arguments:
        # arguments dictionary

    The 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:

    AccessLogRecordCustomizedHeadersEnabled string
    监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
    AclIds List<string>
    监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
    AclStatus string
    是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
    AclType string
    访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
    CaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    CaCertificateSource string
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    CertCenterCertificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
    CertificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
    CertificateSource string
    HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
    CreatedTime string
    监听器的创建时间。
    CustomizedCfgId string
    个性化配置ID,未绑定时值为空字符串。
    Description string
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    DomainExtensions List<Volcengine.GetListenerDomainExtension>
    HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
    EnableHttp2 string
    HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
    EnableQuic string
    QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
    Enabled string
    监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
    Id string
    Uniquely identifies the resource.
    ListenerId string
    监听器 ID。
    ListenerName string
    监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
    LoadBalancerId string
    监听器所属的负载均衡实例 ID。
    PcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    PcaRootCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    PcaSubCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    Port int
    监听器的监听端口,取值:1 - 65535 。
    ProjectName string
    监听器所属项目名称。
    Protocol string
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    ServerGroupId string
    监听器的默认服务器组。
    ServerGroups List<Volcengine.GetListenerServerGroup>
    关联监听器的所有服务器组。
    Status string
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    Tags List<Volcengine.GetListenerTag>
    监听器所属标签。
    UpdatedTime string
    监听器最近一次的操作时间。
    AccessLogRecordCustomizedHeadersEnabled string
    监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
    AclIds []string
    监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
    AclStatus string
    是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
    AclType string
    访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
    CaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    CaCertificateSource string
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    CertCenterCertificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
    CertificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
    CertificateSource string
    HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
    CreatedTime string
    监听器的创建时间。
    CustomizedCfgId string
    个性化配置ID,未绑定时值为空字符串。
    Description string
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    DomainExtensions []GetListenerDomainExtension
    HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
    EnableHttp2 string
    HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
    EnableQuic string
    QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
    Enabled string
    监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
    Id string
    Uniquely identifies the resource.
    ListenerId string
    监听器 ID。
    ListenerName string
    监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
    LoadBalancerId string
    监听器所属的负载均衡实例 ID。
    PcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    PcaRootCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    PcaSubCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    Port int
    监听器的监听端口,取值:1 - 65535 。
    ProjectName string
    监听器所属项目名称。
    Protocol string
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    ServerGroupId string
    监听器的默认服务器组。
    ServerGroups []GetListenerServerGroup
    关联监听器的所有服务器组。
    Status string
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    Tags []GetListenerTag
    监听器所属标签。
    UpdatedTime string
    监听器最近一次的操作时间。
    accessLogRecordCustomizedHeadersEnabled String
    监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
    aclIds List<String>
    监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
    aclStatus String
    是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
    aclType String
    访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
    caCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    caCertificateSource String
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    certCenterCertificateId String
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
    certificateId String
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
    certificateSource String
    HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
    createdTime String
    监听器的创建时间。
    customizedCfgId String
    个性化配置ID,未绑定时值为空字符串。
    description String
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    domainExtensions List<GetListenerDomainExtension>
    HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
    enableHttp2 String
    HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
    enableQuic String
    QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
    enabled String
    监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
    id String
    Uniquely identifies the resource.
    listenerId String
    监听器 ID。
    listenerName String
    监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
    loadBalancerId String
    监听器所属的负载均衡实例 ID。
    pcaLeafCertificateId String
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    pcaRootCaCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    pcaSubCaCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    port Integer
    监听器的监听端口,取值:1 - 65535 。
    projectName String
    监听器所属项目名称。
    protocol String
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    serverGroupId String
    监听器的默认服务器组。
    serverGroups List<GetListenerServerGroup>
    关联监听器的所有服务器组。
    status String
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    tags List<GetListenerTag>
    监听器所属标签。
    updatedTime String
    监听器最近一次的操作时间。
    accessLogRecordCustomizedHeadersEnabled string
    监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
    aclIds string[]
    监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
    aclStatus string
    是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
    aclType string
    访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
    caCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    caCertificateSource string
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    certCenterCertificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
    certificateId string
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
    certificateSource string
    HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
    createdTime string
    监听器的创建时间。
    customizedCfgId string
    个性化配置ID,未绑定时值为空字符串。
    description string
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    domainExtensions GetListenerDomainExtension[]
    HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
    enableHttp2 string
    HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
    enableQuic string
    QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
    enabled string
    监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
    id string
    Uniquely identifies the resource.
    listenerId string
    监听器 ID。
    listenerName string
    监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
    loadBalancerId string
    监听器所属的负载均衡实例 ID。
    pcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    pcaRootCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    pcaSubCaCertificateId string
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    port number
    监听器的监听端口,取值:1 - 65535 。
    projectName string
    监听器所属项目名称。
    protocol string
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    serverGroupId string
    监听器的默认服务器组。
    serverGroups GetListenerServerGroup[]
    关联监听器的所有服务器组。
    status string
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    tags GetListenerTag[]
    监听器所属标签。
    updatedTime string
    监听器最近一次的操作时间。
    access_log_record_customized_headers_enabled str
    监听器是否已开启“在访问日志中记录自定义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_id str
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    ca_certificate_source str
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    cert_center_certificate_id str
    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_id str
    个性化配置ID,未绑定时值为空字符串。
    description str
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    domain_extensions Sequence[GetListenerDomainExtension]
    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_id str
    监听器所属的负载均衡实例 ID。
    pca_leaf_certificate_id str
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    pca_root_ca_certificate_id str
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    pca_sub_ca_certificate_id str
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    port int
    监听器的监听端口,取值:1 - 65535 。
    project_name str
    监听器所属项目名称。
    protocol str
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    server_group_id str
    监听器的默认服务器组。
    server_groups Sequence[GetListenerServerGroup]
    关联监听器的所有服务器组。
    status str
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    tags Sequence[GetListenerTag]
    监听器所属标签。
    updated_time str
    监听器最近一次的操作时间。
    accessLogRecordCustomizedHeadersEnabled String
    监听器是否已开启“在访问日志中记录自定义header”的功能:on:表示该功能已开启。off:表示该功能未开启。
    aclIds List<String>
    监听器绑定的访问控制策略组 ID。当AclStatus参数配置为 on 时,AclIds为必填参数。
    aclStatus String
    是否开启访问控制功能。取值如下:on:开启。off :不开启(默认)。
    aclType String
    访问控制的方式,取值如下:white:白名单方式。表示监听器仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器不会转发任何请求。black:黑名单方式。表示仅拒绝来自所选访问控制策略组中设置的IP地址或地址段的请求。 如果所选策略组中没有添加任何IP,则监听器会转发全部请求。当AclStatus参数配置为 on 时,AclType为必填参数。
    caCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 alb 时,必须指定 CACertificateId 参数。
    caCertificateSource String
    HTTPS 监听器关联的 CA 证书的来源,用于双向认证。alb(默认):表示通过 ALB 上传的证书。标准版 ALB 实例不支持此来源的证书。pcaroot:表示通过火山引擎证书中心购买或上传的私有根 CA 证书。pcasub:表示通过火山引擎证书中心购买或上传的私有子 CA 证书。
    certCenterCertificateId String
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 cert_center 时必传。
    certificateId String
    HTTPS监听器关联的证书 ID。创建 HTTPS 监听器且证书来源为 alb 时必传。
    certificateSource String
    HTTPS监听器关联的默认证书的来源,取值:alb:表示通过 ALB 上传的证书。certcenter:表示通过火山引擎证书中心购买或上传的 SSL 证书。pcaleaf:表示通过火山引擎证书中心购买或上传的私有叶子证书。
    createdTime String
    监听器的创建时间。
    customizedCfgId String
    个性化配置ID,未绑定时值为空字符串。
    description String
    监听器的描述。不能以http://或https://开头。必须以字母或中文开头,可包含数字、英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。) 。长度限制为1 ~ 255个字符。不填默认为空字符串。
    domainExtensions List<Property Map>
    HTTPS监听器关联的扩展域名列表。一个HTTPS监听器能关联的扩展域名上限为20个。
    enableHttp2 String
    HTTP2.0 特性开关,该参数仅对 HTTPS 监听器有效。取值如下:on:开启。off:关闭(默认)。
    enableQuic String
    QUIC 特性开关,该参数仅对 HTTPS 监听器有效,取值如下:on:开启。off:关闭(默认)。只有标准版 ALB 实例支持 QUIC。
    enabled String
    监听器开启/关闭,取值如下:on:开启(默认)。off:关闭。
    id String
    Uniquely identifies the resource.
    listenerId String
    监听器 ID。
    listenerName String
    监听器的名字。不填写时以“协议-端口”格式命名。不能以http://或https://开头。必须以字母或中文开头,可包含数字、点(.)、下划线(_)和短横线(-)。长度限制在1-128字符之间。
    loadBalancerId String
    监听器所属的负载均衡实例 ID。
    pcaLeafCertificateId String
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    pcaRootCaCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_root 时,必须指定 PcaRootCACertificateId 参数。
    pcaSubCaCertificateId String
    HTTPS 监听器关联的 CA 证书 ID。该参数用于 HTTPS 监听器的双向认证。当证书来源是 pca_sub 时,必须指定 PcaSubCACertificateId 参数。
    port Number
    监听器的监听端口,取值:1 - 65535 。
    projectName String
    监听器所属项目名称。
    protocol String
    监听器的协议,支持 HTTP 协议和 HTTPS 协议。
    serverGroupId String
    监听器的默认服务器组。
    serverGroups List<Property Map>
    关联监听器的所有服务器组。
    status String
    监听器的状态。取值如下:Creating:创建中。Active: 运行中。Pending: 变配中。Disabled:已停止。Deleting:删除中。
    tags List<Property Map>
    监听器所属标签。
    updatedTime String
    监听器最近一次的操作时间。

    Supporting Types

    GetListenerDomainExtension

    CertCenterCertificateId string
    域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
    CertificateId string
    域名使用的服务器证书 ID。当证书来源为 alb 时生效。
    CertificateSource string
    域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
    Domain string
    域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
    DomainExtensionId string
    扩展域名 ID 。
    ListenerId string
    扩展域名所属的监听器 ID。
    PcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    San string
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
    CertCenterCertificateId string
    域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
    CertificateId string
    域名使用的服务器证书 ID。当证书来源为 alb 时生效。
    CertificateSource string
    域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
    Domain string
    域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
    DomainExtensionId string
    扩展域名 ID 。
    ListenerId string
    扩展域名所属的监听器 ID。
    PcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    San string
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
    certCenterCertificateId String
    域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
    certificateId String
    域名使用的服务器证书 ID。当证书来源为 alb 时生效。
    certificateSource String
    域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
    domain String
    域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
    domainExtensionId String
    扩展域名 ID 。
    listenerId String
    扩展域名所属的监听器 ID。
    pcaLeafCertificateId String
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    san String
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
    certCenterCertificateId string
    域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
    certificateId string
    域名使用的服务器证书 ID。当证书来源为 alb 时生效。
    certificateSource string
    域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
    domain string
    域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
    domainExtensionId string
    扩展域名 ID 。
    listenerId string
    扩展域名所属的监听器 ID。
    pcaLeafCertificateId string
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    san string
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
    cert_center_certificate_id str
    域名使用的服务器证书 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_id str
    扩展域名 ID 。
    listener_id str
    扩展域名所属的监听器 ID。
    pca_leaf_certificate_id str
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    san str
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。
    certCenterCertificateId String
    域名使用的服务器证书 ID 。当证书来源为 cert_center 时生效。
    certificateId String
    域名使用的服务器证书 ID。当证书来源为 alb 时生效。
    certificateSource String
    域名使用的服务器证书的来源,取值:alb:表示通过 ALB 上传的证书。cert_center:表示通过火山引擎证书中心购买或上传的 SSL 证书。
    domain String
    域名。通常不能为空,若实例支持自动选择扩展证书,即SniAutoMatch为on,则Domain需传入空字符串。需至少包含一个‘.’,且不允许以‘.’开头或结尾。仅允许包含小写字、字、‘.’、‘-‘、‘’。长度限制为1 ~ 128个字符。泛域名:使用“”代替1个或多个字符。“”必须在域名开头或结尾。同一条域名中“”不能出现两次。“*”前后不能有除了.以外的字符。精确域名:符合域名规范的精确域名。同一HTTPS监听器下的域名不能重复。匹配域名时,对域名的大小写不敏感。
    domainExtensionId String
    扩展域名 ID 。
    listenerId String
    扩展域名所属的监听器 ID。
    pcaLeafCertificateId String
    HTTPS监听器关联的私有叶子证书 ID。创建 HTTPS 监听器且证书来源为 pca_leaf 时必传。
    san String
    若实例支持自动选择扩展证书,即SniAutoMatch为on时,则Domain是空字符串。San为证书的扩展域名,用英文,分隔多个域名。

    GetListenerServerGroup

    ServerGroupId string
    服务器组 ID 。
    ServerGroupName string
    服务器组名称。
    ServerGroupId string
    服务器组 ID 。
    ServerGroupName string
    服务器组名称。
    serverGroupId String
    服务器组 ID 。
    serverGroupName String
    服务器组名称。
    serverGroupId string
    服务器组 ID 。
    serverGroupName string
    服务器组名称。
    server_group_id str
    服务器组 ID 。
    server_group_name str
    服务器组名称。
    serverGroupId String
    服务器组 ID 。
    serverGroupName String
    服务器组名称。

    GetListenerTag

    Key string
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    Value string
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。
    Key string
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    Value string
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。
    key String
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    value String
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。
    key string
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    value string
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。
    key str
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    value str
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。
    key String
    用户标签的标签键。具体规则如下:长度限制为1~128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格)、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。同一资源的标签键不允许重复。
    value String
    用户标签的标签值。具体规则如下:长度限制为0~256个字符。大小写敏感。不能以空格开头或结尾。允许包含各国语言文字、数字、空格()、下划线(_)、点号(.)、半角冒(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
      Meet Neo: Your AI Platform Teammate