Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getIpPool
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpc.getIpPool

volcenginecc logo
Viewing docs for volcenginecc v0.0.57
published on Monday, Aug 24, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::VPC::IpPool

    Using getIpPool

    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 getIpPool(args: GetIpPoolArgs, opts?: InvokeOptions): Promise<GetIpPoolResult>
function getIpPoolOutput(args: GetIpPoolOutputArgs, opts?: InvokeOutputOptions): Output<GetIpPoolResult>
    def get_ip_pool(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetIpPoolResult
def get_ip_pool_output(id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetIpPoolResult]
    func LookupIpPool(ctx *Context, args *LookupIpPoolArgs, opts ...InvokeOption) (*LookupIpPoolResult, error)
func LookupIpPoolOutput(ctx *Context, args *LookupIpPoolOutputArgs, opts ...InvokeOption) LookupIpPoolResultOutput

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

    public static class GetIpPool 
{
    public static Task<GetIpPoolResult> InvokeAsync(GetIpPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIpPoolResult> Invoke(GetIpPoolInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetIpPoolResult> Invoke(GetIpPoolInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetIpPoolResult> getIpPool(GetIpPoolArgs args, InvokeOptions options)
public static Output<GetIpPoolResult> getIpPool(GetIpPoolArgs args, InvokeOptions options)
public static Output<GetIpPoolResult> getIpPool(GetIpPoolArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: volcenginecc:vpc/getIpPool:getIpPool
  arguments:
    # arguments dictionary
    data "volcenginecc_vpc_get_ip_pool" "name" {
    # arguments
}

    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 string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getIpPool Result

    The following output properties are available:

    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrBlocks List<string>
    IP range information in the IP address pool.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Description string
    Description of the IP address pool.
    Id string
    Uniquely identifies the resource.
    IpAddressPoolId string
    ID of the IP address pool.
    Isp string
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    Name string
    Name of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    Tags List<Volcengine.GetIpPoolTag>
    Tag information of the IP address pool.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    AddressSource string
    Address source.
    BusinessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    CidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    CidrBlocks []string
    IP range information in the IP address pool.
    CidrMask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    CreationTime string
    Creation time of the IP address pool.
    DeletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    Description string
    Description of the IP address pool.
    Id string
    Uniquely identifies the resource.
    IpAddressPoolId string
    ID of the IP address pool.
    Isp string
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    Name string
    Name of the IP address pool.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    ProjectName string
    Name of the project to which the IP address pool belongs.
    SpecificEgress string
    Specific egress.
    Status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    Tags []GetIpPoolTag
    Tag information of the IP address pool.
    TotalIpCount int
    Total number of IP addresses contained in the IP address pool.
    UpdateTime string
    Update time of the IP address pool.
    UsedIpCount int
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source string
    Address source.
    business_status string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_block string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_blocks list(string)
    IP range information in the IP address pool.
    cidr_mask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creation_time string
    Creation time of the IP address pool.
    deleted_time string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description string
    Description of the IP address pool.
    id string
    Uniquely identifies the resource.
    ip_address_pool_id string
    ID of the IP address pool.
    isp string
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name string
    Name of the IP address pool.
    overdue_time string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    project_name string
    Name of the project to which the IP address pool belongs.
    specific_egress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags list(object)
    Tag information of the IP address pool.
    total_ip_count number
    Total number of IP addresses contained in the IP address pool.
    update_time string
    Update time of the IP address pool.
    used_ip_count number
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    cidrMask Integer
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description String
    Description of the IP address pool.
    id String
    Uniquely identifies the resource.
    ipAddressPoolId String
    ID of the IP address pool.
    isp String
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name String
    Name of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName String
    Name of the project to which the IP address pool belongs.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags List<GetIpPoolTag>
    Tag information of the IP address pool.
    totalIpCount Integer
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Integer
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource string
    Address source.
    businessStatus string
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock string
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks string[]
    IP range information in the IP address pool.
    cidrMask number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime string
    Creation time of the IP address pool.
    deletedTime string
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description string
    Description of the IP address pool.
    id string
    Uniquely identifies the resource.
    ipAddressPoolId string
    ID of the IP address pool.
    isp string
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name string
    Name of the IP address pool.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName string
    Name of the project to which the IP address pool belongs.
    specificEgress string
    Specific egress.
    status string
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags GetIpPoolTag[]
    Tag information of the IP address pool.
    totalIpCount number
    Total number of IP addresses contained in the IP address pool.
    updateTime string
    Update time of the IP address pool.
    usedIpCount number
    Number of IP addresses allocated as EIP in the IP address pool.
    address_source str
    Address source.
    business_status str
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidr_block str
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidr_blocks Sequence[str]
    IP range information in the IP address pool.
    cidr_mask int
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creation_time str
    Creation time of the IP address pool.
    deleted_time str
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description str
    Description of the IP address pool.
    id str
    Uniquely identifies the resource.
    ip_address_pool_id str
    ID of the IP address pool.
    isp str
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name str
    Name of the IP address pool.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    project_name str
    Name of the project to which the IP address pool belongs.
    specific_egress str
    Specific egress.
    status str
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags Sequence[GetIpPoolTag]
    Tag information of the IP address pool.
    total_ip_count int
    Total number of IP addresses contained in the IP address pool.
    update_time str
    Update time of the IP address pool.
    used_ip_count int
    Number of IP addresses allocated as EIP in the IP address pool.
    addressSource String
    Address source.
    businessStatus String
    Whether the IP address pool is locked. Normal: Normal. FinancialLocked: Financially locked.
    cidrBlock String
    Example: 101.0.XX.XX/24, IP address range. Only IPv4 address ranges are supported and cannot start with 0. Mask range: 23–30. Note: Only one of CidrBlock or CidrMask can be configured.
    cidrBlocks List<String>
    IP range information in the IP address pool.
    cidrMask Number
    IP address range mask. Range: 24–28. After entering the mask, the IP address range will be automatically assigned. Note: Only one of CidrBlock or CidrMask can be configured.
    creationTime String
    Creation time of the IP address pool.
    deletedTime String
    Resource reclaim time. This parameter is returned only when the resource is shut down due to overdue payment.
    description String
    Description of the IP address pool.
    id String
    Uniquely identifies the resource.
    ipAddressPoolId String
    ID of the IP address pool.
    isp String
    Line type. Valid values: 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), PremiumBGP (Premium BGP), FusionBGP (Fusion BGP), ChinaMobileValue (China Mobile Value static single line), ChinaUnicomValue (China Unicom Value static single line), ChinaTelecomValue (China Telecom Value static single line).
    name String
    Name of the IP address pool.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    projectName String
    Name of the project to which the IP address pool belongs.
    specificEgress String
    Specific egress.
    status String
    Status of the IP address pool. Creating: Creating. Available: Available. Deleting: Deleting. Pending: In configuration.
    tags List<Property Map>
    Tag information of the IP address pool.
    totalIpCount Number
    Total number of IP addresses contained in the IP address pool.
    updateTime String
    Update time of the IP address pool.
    usedIpCount Number
    Number of IP addresses allocated as EIP in the IP address pool.

    Supporting Types

    GetIpPoolTag

    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 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.57
    published on Monday, Aug 24, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial