getClb

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getClb

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 getClb(args: GetClbArgs, opts?: InvokeOptions): Promise<GetClbResult>
function getClbOutput(args: GetClbOutputArgs, opts?: InvokeOptions): Output<GetClbResult>

def get_clb(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetClbResult
def get_clb_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetClbResult]

func LookupClb(ctx *Context, args *LookupClbArgs, opts ...InvokeOption) (*LookupClbResult, error)
func LookupClbOutput(ctx *Context, args *LookupClbOutputArgs, opts ...InvokeOption) LookupClbResultOutput

> Note: This function is named LookupClb in the Go SDK.

public static class GetClb 
{
    public static Task<GetClbResult> InvokeAsync(GetClbArgs args, InvokeOptions? opts = null)
    public static Output<GetClbResult> Invoke(GetClbInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClbResult> getClb(GetClbArgs args, InvokeOptions options)
public static Output<GetClbResult> getClb(GetClbArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:clb/getClb:getClb
  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.

getClb Result

The following output properties are available:

AccessLog Volcengine.GetClbAccessLog: Access log information in the load balancer instance
AccountId string: Account ID to which the load balancer instance belongs
AddressIpVersion string: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
AllowedPorts List<string>: Allowed port ranges
AutoRenewal bool: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
BusinessStatus string: Whether the load balancer instance is locked
BypassSecurityGroupEnabled string: Whether to enable bypass security group feature
CreateTime string: Creation time of the load balancer instance
DeletedTime string: Expected recycling time of the load balancer instance
Description string: Description of the load balancer instance
Eip Volcengine.GetClbEip: Public IP information of the load balancer instance
EipAddress string: Public IP address
EipId string: Public IP ID
Enabled bool: Enable status of the load balancer instance
Eni Volcengine.GetClbEni: Private IPv4 address information of the load balancer instance
EniAddressNum double: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
EniIpv6Address string: Private IPv6 address of the load balancer instance
Enis Volcengine.GetClbEnis: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
ExclusiveClusterId string: Dedicated cluster ID
ExpiredTime string: Expiration time of the load balancer instance
Id string: Uniquely identifies the resource.
Ipv6AddressBandwidth Volcengine.GetClbIpv6AddressBandwidth: IPv6 public bandwidth information for the load balancing instance
Listeners List<Volcengine.GetClbListener>: Listener information in the load balancer instance
LoadBalancerBillingType double: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
LoadBalancerId string: Load balancer instance ID
LoadBalancerName string: Name of the load balancer instance
LoadBalancerSpec string: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
LockReason string: Reason why the load balancer instance is frozen
MasterZoneId string: Main availability zone ID of the load balancer instance
ModificationProtectionReason string: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
ModificationProtectionStatus string: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
NewArch bool: Whether it is a new architecture
OrderId string: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
OverdueTime string: Freeze time of the load balancer instance
Period double: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
PeriodUnit string: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
ProjectName string: Name of the project associated with the CLB instance
ServerGroups List<Volcengine.GetClbServerGroup>: Backend server group information in the load balancer instance
ServiceManaged bool: Whether the CLB instance is a managed resource
SlaveZoneId string: Secondary availability zone ID of the load balancer instance
Status string: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
SubnetId string: Subnet ID within the VPC of the load balancer instance
Tags List<Volcengine.GetClbTag>: CLB instance tags
TimestampRemoveEnabled string: Enable TCP timestamp removal
Type string: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
UpdateTime string: Most recent operation time of the load balancer instance
VpcId string: VPC ID of the load balancer instance
ZoneType string: Availability zone type of the load balancer instance

AccessLog GetClbAccessLog: Access log information in the load balancer instance
AccountId string: Account ID to which the load balancer instance belongs
AddressIpVersion string: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
AllowedPorts []string: Allowed port ranges
AutoRenewal bool: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
BusinessStatus string: Whether the load balancer instance is locked
BypassSecurityGroupEnabled string: Whether to enable bypass security group feature
CreateTime string: Creation time of the load balancer instance
DeletedTime string: Expected recycling time of the load balancer instance
Description string: Description of the load balancer instance
Eip GetClbEip: Public IP information of the load balancer instance
EipAddress string: Public IP address
EipId string: Public IP ID
Enabled bool: Enable status of the load balancer instance
Eni GetClbEni: Private IPv4 address information of the load balancer instance
EniAddressNum float64: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
EniIpv6Address string: Private IPv6 address of the load balancer instance
Enis GetClbEnis: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
ExclusiveClusterId string: Dedicated cluster ID
ExpiredTime string: Expiration time of the load balancer instance
Id string: Uniquely identifies the resource.
Ipv6AddressBandwidth GetClbIpv6AddressBandwidth: IPv6 public bandwidth information for the load balancing instance
Listeners []GetClbListener: Listener information in the load balancer instance
LoadBalancerBillingType float64: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
LoadBalancerId string: Load balancer instance ID
LoadBalancerName string: Name of the load balancer instance
LoadBalancerSpec string: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
LockReason string: Reason why the load balancer instance is frozen
MasterZoneId string: Main availability zone ID of the load balancer instance
ModificationProtectionReason string: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
ModificationProtectionStatus string: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
NewArch bool: Whether it is a new architecture
OrderId string: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
OverdueTime string: Freeze time of the load balancer instance
Period float64: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
PeriodUnit string: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
ProjectName string: Name of the project associated with the CLB instance
ServerGroups []GetClbServerGroup: Backend server group information in the load balancer instance
ServiceManaged bool: Whether the CLB instance is a managed resource
SlaveZoneId string: Secondary availability zone ID of the load balancer instance
Status string: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
SubnetId string: Subnet ID within the VPC of the load balancer instance
Tags []GetClbTag: CLB instance tags
TimestampRemoveEnabled string: Enable TCP timestamp removal
Type string: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
UpdateTime string: Most recent operation time of the load balancer instance
VpcId string: VPC ID of the load balancer instance
ZoneType string: Availability zone type of the load balancer instance

accessLog GetClbAccessLog: Access log information in the load balancer instance
accountId String: Account ID to which the load balancer instance belongs
addressIpVersion String: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
allowedPorts List<String>: Allowed port ranges
autoRenewal Boolean: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
businessStatus String: Whether the load balancer instance is locked
bypassSecurityGroupEnabled String: Whether to enable bypass security group feature
createTime String: Creation time of the load balancer instance
deletedTime String: Expected recycling time of the load balancer instance
description String: Description of the load balancer instance
eip GetClbEip: Public IP information of the load balancer instance
eipAddress String: Public IP address
eipId String: Public IP ID
enabled Boolean: Enable status of the load balancer instance
eni GetClbEni: Private IPv4 address information of the load balancer instance
eniAddressNum Double: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
eniIpv6Address String: Private IPv6 address of the load balancer instance
enis GetClbEnis: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
exclusiveClusterId String: Dedicated cluster ID
expiredTime String: Expiration time of the load balancer instance
id String: Uniquely identifies the resource.
ipv6AddressBandwidth GetClbIpv6AddressBandwidth: IPv6 public bandwidth information for the load balancing instance
listeners List<GetClbListener>: Listener information in the load balancer instance
loadBalancerBillingType Double: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
loadBalancerId String: Load balancer instance ID
loadBalancerName String: Name of the load balancer instance
loadBalancerSpec String: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
lockReason String: Reason why the load balancer instance is frozen
masterZoneId String: Main availability zone ID of the load balancer instance
modificationProtectionReason String: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
modificationProtectionStatus String: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
newArch Boolean: Whether it is a new architecture
orderId String: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
overdueTime String: Freeze time of the load balancer instance
period Double: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
periodUnit String: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
projectName String: Name of the project associated with the CLB instance
serverGroups List<GetClbServerGroup>: Backend server group information in the load balancer instance
serviceManaged Boolean: Whether the CLB instance is a managed resource
slaveZoneId String: Secondary availability zone ID of the load balancer instance
status String: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
subnetId String: Subnet ID within the VPC of the load balancer instance
tags List<GetClbTag>: CLB instance tags
timestampRemoveEnabled String: Enable TCP timestamp removal
type String: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
updateTime String: Most recent operation time of the load balancer instance
vpcId String: VPC ID of the load balancer instance
zoneType String: Availability zone type of the load balancer instance

accessLog GetClbAccessLog: Access log information in the load balancer instance
accountId string: Account ID to which the load balancer instance belongs
addressIpVersion string: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
allowedPorts string[]: Allowed port ranges
autoRenewal boolean: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
businessStatus string: Whether the load balancer instance is locked
bypassSecurityGroupEnabled string: Whether to enable bypass security group feature
createTime string: Creation time of the load balancer instance
deletedTime string: Expected recycling time of the load balancer instance
description string: Description of the load balancer instance
eip GetClbEip: Public IP information of the load balancer instance
eipAddress string: Public IP address
eipId string: Public IP ID
enabled boolean: Enable status of the load balancer instance
eni GetClbEni: Private IPv4 address information of the load balancer instance
eniAddressNum number: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
eniIpv6Address string: Private IPv6 address of the load balancer instance
enis GetClbEnis: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
exclusiveClusterId string: Dedicated cluster ID
expiredTime string: Expiration time of the load balancer instance
id string: Uniquely identifies the resource.
ipv6AddressBandwidth GetClbIpv6AddressBandwidth: IPv6 public bandwidth information for the load balancing instance
listeners GetClbListener[]: Listener information in the load balancer instance
loadBalancerBillingType number: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
loadBalancerId string: Load balancer instance ID
loadBalancerName string: Name of the load balancer instance
loadBalancerSpec string: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
lockReason string: Reason why the load balancer instance is frozen
masterZoneId string: Main availability zone ID of the load balancer instance
modificationProtectionReason string: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
modificationProtectionStatus string: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
newArch boolean: Whether it is a new architecture
orderId string: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
overdueTime string: Freeze time of the load balancer instance
period number: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
periodUnit string: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
projectName string: Name of the project associated with the CLB instance
serverGroups GetClbServerGroup[]: Backend server group information in the load balancer instance
serviceManaged boolean: Whether the CLB instance is a managed resource
slaveZoneId string: Secondary availability zone ID of the load balancer instance
status string: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
subnetId string: Subnet ID within the VPC of the load balancer instance
tags GetClbTag[]: CLB instance tags
timestampRemoveEnabled string: Enable TCP timestamp removal
type string: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
updateTime string: Most recent operation time of the load balancer instance
vpcId string: VPC ID of the load balancer instance
zoneType string: Availability zone type of the load balancer instance

access_log GetClbAccessLog: Access log information in the load balancer instance
account_id str: Account ID to which the load balancer instance belongs
address_ip_version str: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
allowed_ports Sequence[str]: Allowed port ranges
auto_renewal bool: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
business_status str: Whether the load balancer instance is locked
bypass_security_group_enabled str: Whether to enable bypass security group feature
create_time str: Creation time of the load balancer instance
deleted_time str: Expected recycling time of the load balancer instance
description str: Description of the load balancer instance
eip GetClbEip: Public IP information of the load balancer instance
eip_address str: Public IP address
eip_id str: Public IP ID
enabled bool: Enable status of the load balancer instance
eni GetClbEni: Private IPv4 address information of the load balancer instance
eni_address_num float: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
eni_ipv6_address str: Private IPv6 address of the load balancer instance
enis GetClbEnis: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
exclusive_cluster_id str: Dedicated cluster ID
expired_time str: Expiration time of the load balancer instance
id str: Uniquely identifies the resource.
ipv6_address_bandwidth GetClbIpv6AddressBandwidth: IPv6 public bandwidth information for the load balancing instance
listeners Sequence[GetClbListener]: Listener information in the load balancer instance
load_balancer_billing_type float: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
load_balancer_id str: Load balancer instance ID
load_balancer_name str: Name of the load balancer instance
load_balancer_spec str: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
lock_reason str: Reason why the load balancer instance is frozen
master_zone_id str: Main availability zone ID of the load balancer instance
modification_protection_reason str: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
modification_protection_status str: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
new_arch bool: Whether it is a new architecture
order_id str: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
overdue_time str: Freeze time of the load balancer instance
period float: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
period_unit str: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
project_name str: Name of the project associated with the CLB instance
server_groups Sequence[GetClbServerGroup]: Backend server group information in the load balancer instance
service_managed bool: Whether the CLB instance is a managed resource
slave_zone_id str: Secondary availability zone ID of the load balancer instance
status str: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
subnet_id str: Subnet ID within the VPC of the load balancer instance
tags Sequence[GetClbTag]: CLB instance tags
timestamp_remove_enabled str: Enable TCP timestamp removal
type str: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
update_time str: Most recent operation time of the load balancer instance
vpc_id str: VPC ID of the load balancer instance
zone_type str: Availability zone type of the load balancer instance

accessLog Property Map: Access log information in the load balancer instance
accountId String: Account ID to which the load balancer instance belongs
addressIpVersion String: IP address type of the CLB instance. Values: ipv4 (default): Indicates the CLB is IPv4 type and only supports forwarding IPv4 requests. DualStack: Indicates the CLB is dual-stack type and supports forwarding both IPv4 and IPv6 requests. DualStack can only be specified when Type is set to private
allowedPorts List<String>: Allowed port ranges
autoRenewal Boolean: Whether to enable auto-renewal. true: Yes, default auto-renewal is 1 month. false (default): No
businessStatus String: Whether the load balancer instance is locked
bypassSecurityGroupEnabled String: Whether to enable bypass security group feature
createTime String: Creation time of the load balancer instance
deletedTime String: Expected recycling time of the load balancer instance
description String: Description of the load balancer instance
eip Property Map: Public IP information of the load balancer instance
eipAddress String: Public IP address
eipId String: Public IP ID
enabled Boolean: Enable status of the load balancer instance
eni Property Map: Private IPv4 address information of the load balancer instance
eniAddressNum Number: Number of private IPv4 addresses for the load balancer instance. This parameter cannot be used together with EniAddress. If this parameter is provided, EniAddress is not required
eniIpv6Address String: Private IPv6 address of the load balancer instance
enis Property Map: List of private IPv4 addresses for the load balancer instance, specified by EniAddressNum during creation
exclusiveClusterId String: Dedicated cluster ID
expiredTime String: Expiration time of the load balancer instance
id String: Uniquely identifies the resource.
ipv6AddressBandwidth Property Map: IPv6 public bandwidth information for the load balancing instance
listeners List<Property Map>: Listener information in the load balancer instance
loadBalancerBillingType Number: CLB instance billing method. Available values: 1: Annual/monthly subscription. 2 (default): Pay-as-you-go (by specification). 3: Pay-as-you-go (by usage)
loadBalancerId String: Load balancer instance ID
loadBalancerName String: Name of the load balancer instance
loadBalancerSpec String: CLB instance specification. Different specifications provide different forwarding capabilities. small1: Small I. small2: Small II. medium1: Medium I. medium2: Medium II. large1: Large I. large2: Large II
lockReason String: Reason why the load balancer instance is frozen
masterZoneId String: Main availability zone ID of the load balancer instance
modificationProtectionReason String: Reason for setting modification protection status. This parameter is valid only when ModificationProtectionStatus is set to ConsoleProtection. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: half-width period (.), underscore (_), and hyphen (-). Length must be 1–80 characters
modificationProtectionStatus String: Whether CLB instance enables modification protection in the console. When enabled, modification or deletion via the console is prohibited. Available values: NonProtection: Disabled. ConsoleProtection: Enabled
newArch Boolean: Whether it is a new architecture
orderId String: Order ID. This parameter is only available when LoadBalancerBillingType is set to 1 during creation
overdueTime String: Freeze time of the load balancer instance
period Number: Duration for purchasing a CLB instance by year or by month. Default is '1'. When PeriodUnit is set to Month, valid values are 1–9, 12, 24, and 36. When PeriodUnit is set to Year, valid values are 1–3
periodUnit String: Duration unit for purchasing subscription CLB instances. This parameter is valid only when LoadBalancerBillingType is set to 1. Values: Month (default): month. Year: year
projectName String: Name of the project associated with the CLB instance
serverGroups List<Property Map>: Backend server group information in the load balancer instance
serviceManaged Boolean: Whether the CLB instance is a managed resource
slaveZoneId String: Secondary availability zone ID of the load balancer instance
status String: Load balancer instance status: Inactive: stopped. Active: running. Creating: creating. Provisioning: creating. Configuring: configuring. Deleting: deleting. CreateFailed: creation failed.
subnetId String: Subnet ID within the VPC of the load balancer instance
tags List<Property Map>: CLB instance tags
timestampRemoveEnabled String: Enable TCP timestamp removal
type String: CLB instance type. Values: public: Public type. When you create a public CLB instance, the system assigns a public IP address for forwarding public requests. private: Private type. When you create a private CLB instance, the system does not assign a public IP address; you must bind a public IP manually before it can forward public requests
updateTime String: Most recent operation time of the load balancer instance
vpcId String: VPC ID of the load balancer instance
zoneType String: Availability zone type of the load balancer instance

Supporting Types

GetClbAccessLog

BucketName string: Name of the object storage bucket for storing Layer 7 access logs
DeliveryType string: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
Enabled bool: Enable access log (Layer 7) delivery to object storage TOS
TlsProjectId string: Log project
TlsTopicId string: Log topic

BucketName string: Name of the object storage bucket for storing Layer 7 access logs
DeliveryType string: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
Enabled bool: Enable access log (Layer 7) delivery to object storage TOS
TlsProjectId string: Log project
TlsTopicId string: Log topic

bucketName String: Name of the object storage bucket for storing Layer 7 access logs
deliveryType String: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
enabled Boolean: Enable access log (Layer 7) delivery to object storage TOS
tlsProjectId String: Log project
tlsTopicId String: Log topic

bucketName string: Name of the object storage bucket for storing Layer 7 access logs
deliveryType string: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
enabled boolean: Enable access log (Layer 7) delivery to object storage TOS
tlsProjectId string: Log project
tlsTopicId string: Log topic

bucket_name str: Name of the object storage bucket for storing Layer 7 access logs
delivery_type str: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
enabled bool: Enable access log (Layer 7) delivery to object storage TOS
tls_project_id str: Log project
tls_topic_id str: Log topic

bucketName String: Name of the object storage bucket for storing Layer 7 access logs
deliveryType String: Log delivery type. Available values: tos (default): Deliver logs to object storage service TOS. tls: Deliver logs to log service TLS
enabled Boolean: Enable access log (Layer 7) delivery to object storage TOS
tlsProjectId String: Log project
tlsTopicId String: Log topic

GetClbEip

Bandwidth double: Peak bandwidth
BandwidthPackageId string: Shared bandwidth package ID
EipBillingType double: Billing method
Isp string: Line type
SecurityProtectionInstanceId double: Protection package ID
SecurityProtectionTypes List<string>: Security protection type

Bandwidth float64: Peak bandwidth
BandwidthPackageId string: Shared bandwidth package ID
EipBillingType float64: Billing method
Isp string: Line type
SecurityProtectionInstanceId float64: Protection package ID
SecurityProtectionTypes []string: Security protection type

bandwidth Double: Peak bandwidth
bandwidthPackageId String: Shared bandwidth package ID
eipBillingType Double: Billing method
isp String: Line type
securityProtectionInstanceId Double: Protection package ID
securityProtectionTypes List<String>: Security protection type

bandwidth number: Peak bandwidth
bandwidthPackageId string: Shared bandwidth package ID
eipBillingType number: Billing method
isp string: Line type
securityProtectionInstanceId number: Protection package ID
securityProtectionTypes string[]: Security protection type

bandwidth float: Peak bandwidth
bandwidth_package_id str: Shared bandwidth package ID
eip_billing_type float: Billing method
isp str: Line type
security_protection_instance_id float: Protection package ID
security_protection_types Sequence[str]: Security protection type

bandwidth Number: Peak bandwidth
bandwidthPackageId String: Shared bandwidth package ID
eipBillingType Number: Billing method
isp String: Line type
securityProtectionInstanceId Number: Protection package ID
securityProtectionTypes List<String>: Security protection type

GetClbEni

EniAddress string: Private IP address of the load balancer instance
EniId string: Network interface ID occupied by the load balancer instance

EniAddress string: Private IP address of the load balancer instance
EniId string: Network interface ID occupied by the load balancer instance

eniAddress String: Private IP address of the load balancer instance
eniId String: Network interface ID occupied by the load balancer instance

eniAddress string: Private IP address of the load balancer instance
eniId string: Network interface ID occupied by the load balancer instance

eni_address str: Private IP address of the load balancer instance
eni_id str: Network interface ID occupied by the load balancer instance

eniAddress String: Private IP address of the load balancer instance
eniId String: Network interface ID occupied by the load balancer instance

GetClbEnis

EniAddress string: Private IP address of the load balancer instance
EniId string: Network interface ID occupied by the load balancer instance

EniAddress string: Private IP address of the load balancer instance
EniId string: Network interface ID occupied by the load balancer instance

eniAddress String: Private IP address of the load balancer instance
eniId String: Network interface ID occupied by the load balancer instance

eniAddress string: Private IP address of the load balancer instance
eniId string: Network interface ID occupied by the load balancer instance

eni_address str: Private IP address of the load balancer instance
eni_id str: Network interface ID occupied by the load balancer instance

eniAddress String: Private IP address of the load balancer instance
eniId String: Network interface ID occupied by the load balancer instance

GetClbIpv6AddressBandwidth

Bandwidth double: Peak bandwidth of IPv6 public bandwidth, in Mbps
BandwidthPackageId string: Shared bandwidth package ID associated with IPv6 public bandwidth
BillingType double: Billing type for IPv6 public bandwidth
Isp string: Line type of IPv6 public bandwidth
NetworkType string: Network type of the load balancer instance's IPv6 address

Bandwidth float64: Peak bandwidth of IPv6 public bandwidth, in Mbps
BandwidthPackageId string: Shared bandwidth package ID associated with IPv6 public bandwidth
BillingType float64: Billing type for IPv6 public bandwidth
Isp string: Line type of IPv6 public bandwidth
NetworkType string: Network type of the load balancer instance's IPv6 address

bandwidth Double: Peak bandwidth of IPv6 public bandwidth, in Mbps
bandwidthPackageId String: Shared bandwidth package ID associated with IPv6 public bandwidth
billingType Double: Billing type for IPv6 public bandwidth
isp String: Line type of IPv6 public bandwidth
networkType String: Network type of the load balancer instance's IPv6 address

bandwidth number: Peak bandwidth of IPv6 public bandwidth, in Mbps
bandwidthPackageId string: Shared bandwidth package ID associated with IPv6 public bandwidth
billingType number: Billing type for IPv6 public bandwidth
isp string: Line type of IPv6 public bandwidth
networkType string: Network type of the load balancer instance's IPv6 address

bandwidth float: Peak bandwidth of IPv6 public bandwidth, in Mbps
bandwidth_package_id str: Shared bandwidth package ID associated with IPv6 public bandwidth
billing_type float: Billing type for IPv6 public bandwidth
isp str: Line type of IPv6 public bandwidth
network_type str: Network type of the load balancer instance's IPv6 address

bandwidth Number: Peak bandwidth of IPv6 public bandwidth, in Mbps
bandwidthPackageId String: Shared bandwidth package ID associated with IPv6 public bandwidth
billingType Number: Billing type for IPv6 public bandwidth
isp String: Line type of IPv6 public bandwidth
networkType String: Network type of the load balancer instance's IPv6 address

GetClbListener

ListenerId string: Listener ID
ListenerName string: Listener name

ListenerId string: Listener ID
ListenerName string: Listener name

listenerId String: Listener ID
listenerName String: Listener name

listenerId string: Listener ID
listenerName string: Listener name

listener_id str: Listener ID
listener_name str: Listener name

listenerId String: Listener ID
listenerName String: Listener name

GetClbServerGroup

ServerGroupId string: ID of the backend server group in the load balancer instance
ServerGroupName string: Name of the backend server group in the load balancer instance

ServerGroupId string: ID of the backend server group in the load balancer instance
ServerGroupName string: Name of the backend server group in the load balancer instance

serverGroupId String: ID of the backend server group in the load balancer instance
serverGroupName String: Name of the backend server group in the load balancer instance

serverGroupId string: ID of the backend server group in the load balancer instance
serverGroupName string: Name of the backend server group in the load balancer instance

server_group_id str: ID of the backend server group in the load balancer instance
server_group_name str: Name of the backend server group in the load balancer instance

serverGroupId String: ID of the backend server group in the load balancer instance
serverGroupName String: Name of the backend server group in the load balancer instance

GetClbTag

Key string: Tag key
Value string: Tag value

Key string: Tag key
Value string: Tag value

key String: Tag key
value String: Tag value

key string: Tag key
value string: Tag value

key str: Tag key
value str: Tag value

key String: Tag key
value String: Tag value

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.clb.getClb

On this page

On this page

Using getClb

getClb Result

Supporting Types

GetClbAccessLog

GetClbEip

GetClbEni

GetClbEnis

GetClbIpv6AddressBandwidth

GetClbListener

GetClbServerGroup

GetClbTag

Package Details

On this page

On this page