1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getEip
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpc.getEip

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::VPC::EIP

    Using getEip

    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 getEip(args: GetEipArgs, opts?: InvokeOptions): Promise<GetEipResult>
function getEipOutput(args: GetEipOutputArgs, opts?: InvokeOptions): Output<GetEipResult>
    def get_eip(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetEipResult
def get_eip_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetEipResult]
    func LookupEip(ctx *Context, args *LookupEipArgs, opts ...InvokeOption) (*LookupEipResult, error)
func LookupEipOutput(ctx *Context, args *LookupEipOutputArgs, opts ...InvokeOption) LookupEipResultOutput

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

    public static class GetEip 
{
    public static Task<GetEipResult> InvokeAsync(GetEipArgs args, InvokeOptions? opts = null)
    public static Output<GetEipResult> Invoke(GetEipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEipResult> getEip(GetEipArgs args, InvokeOptions options)
public static Output<GetEipResult> getEip(GetEipArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:vpc/getEip:getEip
  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.

    getEip Result

    The following output properties are available:

    AllocationId string
    Public IP ID.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    Name string
    Name of the public IP.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes List<string>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    Tags List<Volcengine.GetEipTag>
    Tag information of the public IP
    UpdatedTime string
    Time when the public IP was updated.
    AllocationId string
    Public IP ID.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    Name string
    Name of the public IP.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes []string
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    Tags []GetEipTag
    Tag information of the public IP
    UpdatedTime string
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    bandwidth Integer
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType Integer
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id String
    Uniquely identifies the resource.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name String
    Name of the public IP.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period Integer
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Integer
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Integer
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Integer
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Integer
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags List<GetEipTag>
    Tag information of the public IP
    updatedTime String
    Time when the public IP was updated.
    allocationId string
    Public IP ID.
    bandwidth number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime string
    Creation time of the public IP.
    deletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description string
    Description of the public IP.
    directMode boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress string
    Public IP address.
    expiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id string
    Uniquely identifies the resource.
    instanceId string
    Currently bound instance ID.
    instanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId string
    IP address pool ID.
    isBlocked boolean
    Whether it is blocked. true: yes. false: no.
    isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name string
    Name of the public IP.
    overdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName string
    Name of the project to which the public IP belongs.
    releaseWithInstance boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes string[]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged boolean
    Managed by service
    status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags GetEipTag[]
    Tag information of the public IP
    updatedTime string
    Time when the public IP was updated.
    allocation_id str
    Public IP ID.
    bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidth_package_id str
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billing_type int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    business_status str
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    created_time str
    Creation time of the public IP.
    deleted_time str
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description str
    Description of the public IP.
    direct_mode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eip_address str
    Public IP address.
    expired_time str
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id str
    Uniquely identifies the resource.
    instance_id str
    Currently bound instance ID.
    instance_type str
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ip_address str
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ip_address_pool_id str
    IP address pool ID.
    is_blocked bool
    Whether it is blocked. true: yes. false: no.
    isp str
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lock_reason str
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name str
    Name of the public IP.
    overdue_time str
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    period_unit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    private_ip_address str
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    project_name str
    Name of the project to which the public IP belongs.
    release_with_instance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renew_period_times int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renew_type int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    security_protection_instance_id int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    security_protection_types Sequence[str]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    service_managed bool
    Managed by service
    status str
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags Sequence[GetEipTag]
    Tag information of the public IP
    updated_time str
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    bandwidth Number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType Number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id String
    Uniquely identifies the resource.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name String
    Name of the public IP.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period Number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags List<Property Map>
    Tag information of the public IP
    updatedTime String
    Time when the public IP was updated.

    Supporting Types

    GetEipTag

    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.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.