1. Packages
  2. Volcengine
  3. API Docs
  4. eip
  5. getAddresses
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.eip.getAddresses

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of eip addresses

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooAddress = new volcengine.eip.Address("fooAddress", {billingType: "PostPaidByTraffic"});
const fooAddresses = volcengine.eip.getAddressesOutput({
    ids: [fooAddress.id],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_address = volcengine.eip.Address("fooAddress", billing_type="PostPaidByTraffic")
foo_addresses = volcengine.eip.get_addresses_output(ids=[foo_address.id])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/eip"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooAddress, err := eip.NewAddress(ctx, "fooAddress", &eip.AddressArgs{
			BillingType: pulumi.String("PostPaidByTraffic"),
		})
		if err != nil {
			return err
		}
		_ = eip.GetAddressesOutput(ctx, eip.GetAddressesOutputArgs{
			Ids: pulumi.StringArray{
				fooAddress.ID(),
			},
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooAddress = new Volcengine.Eip.Address("fooAddress", new()
    {
        BillingType = "PostPaidByTraffic",
    });

    var fooAddresses = Volcengine.Eip.GetAddresses.Invoke(new()
    {
        Ids = new[]
        {
            fooAddress.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.eip.Address;
import com.pulumi.volcengine.eip.AddressArgs;
import com.pulumi.volcengine.eip.EipFunctions;
import com.pulumi.volcengine.eip.inputs.GetAddressesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fooAddress = new Address("fooAddress", AddressArgs.builder()        
            .billingType("PostPaidByTraffic")
            .build());

        final var fooAddresses = EipFunctions.getAddresses(GetAddressesArgs.builder()
            .ids(fooAddress.id())
            .build());

    }
}

    resources:
  fooAddress:
    type: volcengine:eip:Address
    properties:
      billingType: PostPaidByTraffic
variables:
  fooAddresses:
    fn::invoke:
      Function: volcengine:eip:getAddresses
      Arguments:
        ids:
          - ${fooAddress.id}

    Using getAddresses

    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 getAddresses(args: GetAddressesArgs, opts?: InvokeOptions): Promise<GetAddressesResult>
function getAddressesOutput(args: GetAddressesOutputArgs, opts?: InvokeOptions): Output<GetAddressesResult>
    def get_addresses(associated_instance_id: Optional[str] = None,
                  associated_instance_type: Optional[str] = None,
                  eip_addresses: Optional[Sequence[str]] = None,
                  ids: Optional[Sequence[str]] = None,
                  isp: Optional[str] = None,
                  name: Optional[str] = None,
                  output_file: Optional[str] = None,
                  project_name: Optional[str] = None,
                  status: Optional[str] = None,
                  tags: Optional[Sequence[GetAddressesTag]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAddressesResult
def get_addresses_output(associated_instance_id: Optional[pulumi.Input[str]] = None,
                  associated_instance_type: Optional[pulumi.Input[str]] = None,
                  eip_addresses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  isp: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  project_name: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetAddressesTagArgs]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAddressesResult]
    func GetAddresses(ctx *Context, args *GetAddressesArgs, opts ...InvokeOption) (*GetAddressesResult, error)
func GetAddressesOutput(ctx *Context, args *GetAddressesOutputArgs, opts ...InvokeOption) GetAddressesResultOutput

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

    public static class GetAddresses 
{
    public static Task<GetAddressesResult> InvokeAsync(GetAddressesArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressesResult> Invoke(GetAddressesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddressesResult> getAddresses(GetAddressesArgs args, InvokeOptions options)
public static Output<GetAddressesResult> getAddresses(GetAddressesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:eip/getAddresses:getAddresses
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AssociatedInstanceId string
    An id of associated instance.
    AssociatedInstanceType string
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    EipAddresses List<string>
    A list of EIP ip address that you want to query.
    Ids List<string>
    A list of EIP allocation ids.
    Isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    Name string
    A name of EIP.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of EIP.
    Status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    Tags List<GetAddressesTag>
    Tags.
    AssociatedInstanceId string
    An id of associated instance.
    AssociatedInstanceType string
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    EipAddresses []string
    A list of EIP ip address that you want to query.
    Ids []string
    A list of EIP allocation ids.
    Isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    Name string
    A name of EIP.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of EIP.
    Status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    Tags []GetAddressesTag
    Tags.
    associatedInstanceId String
    An id of associated instance.
    associatedInstanceType String
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    eipAddresses List<String>
    A list of EIP ip address that you want to query.
    ids List<String>
    A list of EIP allocation ids.
    isp String
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    name String
    A name of EIP.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of EIP.
    status String
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags List<GetAddressesTag>
    Tags.
    associatedInstanceId string
    An id of associated instance.
    associatedInstanceType string
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    eipAddresses string[]
    A list of EIP ip address that you want to query.
    ids string[]
    A list of EIP allocation ids.
    isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    name string
    A name of EIP.
    outputFile string
    File name where to save data source results.
    projectName string
    The ProjectName of EIP.
    status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags GetAddressesTag[]
    Tags.
    associated_instance_id str
    An id of associated instance.
    associated_instance_type str
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    eip_addresses Sequence[str]
    A list of EIP ip address that you want to query.
    ids Sequence[str]
    A list of EIP allocation ids.
    isp str
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    name str
    A name of EIP.
    output_file str
    File name where to save data source results.
    project_name str
    The ProjectName of EIP.
    status str
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags Sequence[GetAddressesTag]
    Tags.
    associatedInstanceId String
    An id of associated instance.
    associatedInstanceType String
    A type of associated instance, the value can be Nat, NetworkInterface, ClbInstance, AlbInstance, HaVip or EcsInstance.
    eipAddresses List<String>
    A list of EIP ip address that you want to query.
    ids List<String>
    A list of EIP allocation ids.
    isp String
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    name String
    A name of EIP.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of EIP.
    status String
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags List<Property Map>
    Tags.

    getAddresses Result

    The following output properties are available:

    Addresses List<GetAddressesAddress>
    The collection of EIP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of EIP addresses query.
    AssociatedInstanceId string
    AssociatedInstanceType string
    EipAddresses List<string>
    Ids List<string>
    Isp string
    The ISP of EIP Address.
    Name string
    The name of the EIP.
    OutputFile string
    ProjectName string
    The ProjectName of the EIP.
    Status string
    The status of the EIP.
    Tags List<GetAddressesTag>
    Tags.
    Addresses []GetAddressesAddress
    The collection of EIP addresses.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of EIP addresses query.
    AssociatedInstanceId string
    AssociatedInstanceType string
    EipAddresses []string
    Ids []string
    Isp string
    The ISP of EIP Address.
    Name string
    The name of the EIP.
    OutputFile string
    ProjectName string
    The ProjectName of the EIP.
    Status string
    The status of the EIP.
    Tags []GetAddressesTag
    Tags.
    addresses List<GetAddressesAddress>
    The collection of EIP addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of EIP addresses query.
    associatedInstanceId String
    associatedInstanceType String
    eipAddresses List<String>
    ids List<String>
    isp String
    The ISP of EIP Address.
    name String
    The name of the EIP.
    outputFile String
    projectName String
    The ProjectName of the EIP.
    status String
    The status of the EIP.
    tags List<GetAddressesTag>
    Tags.
    addresses GetAddressesAddress[]
    The collection of EIP addresses.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of EIP addresses query.
    associatedInstanceId string
    associatedInstanceType string
    eipAddresses string[]
    ids string[]
    isp string
    The ISP of EIP Address.
    name string
    The name of the EIP.
    outputFile string
    projectName string
    The ProjectName of the EIP.
    status string
    The status of the EIP.
    tags GetAddressesTag[]
    Tags.
    addresses Sequence[GetAddressesAddress]
    The collection of EIP addresses.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of EIP addresses query.
    associated_instance_id str
    associated_instance_type str
    eip_addresses Sequence[str]
    ids Sequence[str]
    isp str
    The ISP of EIP Address.
    name str
    The name of the EIP.
    output_file str
    project_name str
    The ProjectName of the EIP.
    status str
    The status of the EIP.
    tags Sequence[GetAddressesTag]
    Tags.
    addresses List<Property Map>
    The collection of EIP addresses.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of EIP addresses query.
    associatedInstanceId String
    associatedInstanceType String
    eipAddresses List<String>
    ids List<String>
    isp String
    The ISP of EIP Address.
    name String
    The name of the EIP.
    outputFile String
    projectName String
    The ProjectName of the EIP.
    status String
    The status of the EIP.
    tags List<Property Map>
    Tags.

    Supporting Types

    GetAddressesAddress

    AllocationId string
    The id of the EIP address.
    AllocationTime string
    The allocation time of the EIP.
    Bandwidth int
    The peek bandwidth of the EIP.
    BandwidthPackageId string
    The id of the bandwidth package.
    BillingType string
    The billing type of the EIP.
    BusinessStatus string
    The business status of the EIP.
    DeletedTime string
    The deleted time of the EIP.
    Description string
    The description of the EIP.
    EipAddress string
    The EIP ip address of the EIP.
    ExpiredTime string
    The expired time of the EIP.
    Id string
    The id of the EIP address.
    InstanceId string
    The instance id which be associated to the EIP.
    InstanceType string
    The type of the associated instance.
    Isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    LockReason string
    The lock reason of the EIP.
    Name string
    A name of EIP.
    OverdueTime string
    The overdue time of the EIP.
    ProjectName string
    The ProjectName of EIP.
    SecurityProtectionTypes List<string>
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    Status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    Tags List<GetAddressesAddressTag>
    Tags.
    UpdatedAt string
    The last update time of the EIP.
    AllocationId string
    The id of the EIP address.
    AllocationTime string
    The allocation time of the EIP.
    Bandwidth int
    The peek bandwidth of the EIP.
    BandwidthPackageId string
    The id of the bandwidth package.
    BillingType string
    The billing type of the EIP.
    BusinessStatus string
    The business status of the EIP.
    DeletedTime string
    The deleted time of the EIP.
    Description string
    The description of the EIP.
    EipAddress string
    The EIP ip address of the EIP.
    ExpiredTime string
    The expired time of the EIP.
    Id string
    The id of the EIP address.
    InstanceId string
    The instance id which be associated to the EIP.
    InstanceType string
    The type of the associated instance.
    Isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    LockReason string
    The lock reason of the EIP.
    Name string
    A name of EIP.
    OverdueTime string
    The overdue time of the EIP.
    ProjectName string
    The ProjectName of EIP.
    SecurityProtectionTypes []string
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    Status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    Tags []GetAddressesAddressTag
    Tags.
    UpdatedAt string
    The last update time of the EIP.
    allocationId String
    The id of the EIP address.
    allocationTime String
    The allocation time of the EIP.
    bandwidth Integer
    The peek bandwidth of the EIP.
    bandwidthPackageId String
    The id of the bandwidth package.
    billingType String
    The billing type of the EIP.
    businessStatus String
    The business status of the EIP.
    deletedTime String
    The deleted time of the EIP.
    description String
    The description of the EIP.
    eipAddress String
    The EIP ip address of the EIP.
    expiredTime String
    The expired time of the EIP.
    id String
    The id of the EIP address.
    instanceId String
    The instance id which be associated to the EIP.
    instanceType String
    The type of the associated instance.
    isp String
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    lockReason String
    The lock reason of the EIP.
    name String
    A name of EIP.
    overdueTime String
    The overdue time of the EIP.
    projectName String
    The ProjectName of EIP.
    securityProtectionTypes List<String>
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    status String
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags List<GetAddressesAddressTag>
    Tags.
    updatedAt String
    The last update time of the EIP.
    allocationId string
    The id of the EIP address.
    allocationTime string
    The allocation time of the EIP.
    bandwidth number
    The peek bandwidth of the EIP.
    bandwidthPackageId string
    The id of the bandwidth package.
    billingType string
    The billing type of the EIP.
    businessStatus string
    The business status of the EIP.
    deletedTime string
    The deleted time of the EIP.
    description string
    The description of the EIP.
    eipAddress string
    The EIP ip address of the EIP.
    expiredTime string
    The expired time of the EIP.
    id string
    The id of the EIP address.
    instanceId string
    The instance id which be associated to the EIP.
    instanceType string
    The type of the associated instance.
    isp string
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    lockReason string
    The lock reason of the EIP.
    name string
    A name of EIP.
    overdueTime string
    The overdue time of the EIP.
    projectName string
    The ProjectName of EIP.
    securityProtectionTypes string[]
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    status string
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags GetAddressesAddressTag[]
    Tags.
    updatedAt string
    The last update time of the EIP.
    allocation_id str
    The id of the EIP address.
    allocation_time str
    The allocation time of the EIP.
    bandwidth int
    The peek bandwidth of the EIP.
    bandwidth_package_id str
    The id of the bandwidth package.
    billing_type str
    The billing type of the EIP.
    business_status str
    The business status of the EIP.
    deleted_time str
    The deleted time of the EIP.
    description str
    The description of the EIP.
    eip_address str
    The EIP ip address of the EIP.
    expired_time str
    The expired time of the EIP.
    id str
    The id of the EIP address.
    instance_id str
    The instance id which be associated to the EIP.
    instance_type str
    The type of the associated instance.
    isp str
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    lock_reason str
    The lock reason of the EIP.
    name str
    A name of EIP.
    overdue_time str
    The overdue time of the EIP.
    project_name str
    The ProjectName of EIP.
    security_protection_types Sequence[str]
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    status str
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags Sequence[GetAddressesAddressTag]
    Tags.
    updated_at str
    The last update time of the EIP.
    allocationId String
    The id of the EIP address.
    allocationTime String
    The allocation time of the EIP.
    bandwidth Number
    The peek bandwidth of the EIP.
    bandwidthPackageId String
    The id of the bandwidth package.
    billingType String
    The billing type of the EIP.
    businessStatus String
    The business status of the EIP.
    deletedTime String
    The deleted time of the EIP.
    description String
    The description of the EIP.
    eipAddress String
    The EIP ip address of the EIP.
    expiredTime String
    The expired time of the EIP.
    id String
    The id of the EIP address.
    instanceId String
    The instance id which be associated to the EIP.
    instanceType String
    The type of the associated instance.
    isp String
    An ISP of EIP Address, the value can be BGP or ChinaMobile or ChinaUnicom or ChinaTelecom.
    lockReason String
    The lock reason of the EIP.
    name String
    A name of EIP.
    overdueTime String
    The overdue time of the EIP.
    projectName String
    The ProjectName of EIP.
    securityProtectionTypes List<String>
    Security protection types for shared bandwidth packages. Parameter - N: Indicates the number of security protection types, currently only supports taking 1. Value: AntiDDoS_Enhanced.
    status String
    A status of EIP, the value can be Attaching or Detaching or Attached or Available.
    tags List<Property Map>
    Tags.
    updatedAt String
    The last update time of the EIP.

    GetAddressesAddressTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetAddressesTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate