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

volcengine.vpc.getVpcs

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 vpcs

    Example Usage

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

const default = volcengine.vpc.getVpcs({
    ids: ["vpc-mizl7m1kqccg5smt1bdpijuj"],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.vpc.get_vpcs(ids=["vpc-mizl7m1kqccg5smt1bdpijuj"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.GetVpcs(ctx, &vpc.GetVpcsArgs{
			Ids: []string{
				"vpc-mizl7m1kqccg5smt1bdpijuj",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Vpc.GetVpcs.Invoke(new()
    {
        Ids = new[]
        {
            "vpc-mizl7m1kqccg5smt1bdpijuj",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vpc.VpcFunctions;
import com.pulumi.volcengine.vpc.inputs.GetVpcsArgs;
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) {
        final var default = VpcFunctions.getVpcs(GetVpcsArgs.builder()
            .ids("vpc-mizl7m1kqccg5smt1bdpijuj")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:vpc:getVpcs
      Arguments:
        ids:
          - vpc-mizl7m1kqccg5smt1bdpijuj

    Using getVpcs

    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 getVpcs(args: GetVpcsArgs, opts?: InvokeOptions): Promise<GetVpcsResult>
function getVpcsOutput(args: GetVpcsOutputArgs, opts?: InvokeOptions): Output<GetVpcsResult>
    def get_vpcs(ids: Optional[Sequence[str]] = None,
             name_regex: Optional[str] = None,
             output_file: Optional[str] = None,
             project_name: Optional[str] = None,
             tags: Optional[Sequence[GetVpcsTag]] = None,
             vpc_name: Optional[str] = None,
             vpc_owner_id: Optional[int] = None,
             opts: Optional[InvokeOptions] = None) -> GetVpcsResult
def get_vpcs_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             name_regex: Optional[pulumi.Input[str]] = None,
             output_file: Optional[pulumi.Input[str]] = None,
             project_name: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpcsTagArgs]]]] = None,
             vpc_name: Optional[pulumi.Input[str]] = None,
             vpc_owner_id: Optional[pulumi.Input[int]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetVpcsResult]
    func GetVpcs(ctx *Context, args *GetVpcsArgs, opts ...InvokeOption) (*GetVpcsResult, error)
func GetVpcsOutput(ctx *Context, args *GetVpcsOutputArgs, opts ...InvokeOption) GetVpcsResultOutput

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

    public static class GetVpcs 
{
    public static Task<GetVpcsResult> InvokeAsync(GetVpcsArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcsResult> Invoke(GetVpcsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcsResult> getVpcs(GetVpcsArgs args, InvokeOptions options)
public static Output<GetVpcsResult> getVpcs(GetVpcsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:vpc/getVpcs:getVpcs
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of VPC IDs.
    NameRegex string
    A Name Regex of Vpc.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the VPC.
    Tags List<GetVpcsTag>
    Tags.
    VpcName string
    The vpc name to query.
    VpcOwnerId int
    The owner ID of the vpc.
    Ids []string
    A list of VPC IDs.
    NameRegex string
    A Name Regex of Vpc.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the VPC.
    Tags []GetVpcsTag
    Tags.
    VpcName string
    The vpc name to query.
    VpcOwnerId int
    The owner ID of the vpc.
    ids List<String>
    A list of VPC IDs.
    nameRegex String
    A Name Regex of Vpc.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the VPC.
    tags List<GetVpcsTag>
    Tags.
    vpcName String
    The vpc name to query.
    vpcOwnerId Integer
    The owner ID of the vpc.
    ids string[]
    A list of VPC IDs.
    nameRegex string
    A Name Regex of Vpc.
    outputFile string
    File name where to save data source results.
    projectName string
    The ProjectName of the VPC.
    tags GetVpcsTag[]
    Tags.
    vpcName string
    The vpc name to query.
    vpcOwnerId number
    The owner ID of the vpc.
    ids Sequence[str]
    A list of VPC IDs.
    name_regex str
    A Name Regex of Vpc.
    output_file str
    File name where to save data source results.
    project_name str
    The ProjectName of the VPC.
    tags Sequence[GetVpcsTag]
    Tags.
    vpc_name str
    The vpc name to query.
    vpc_owner_id int
    The owner ID of the vpc.
    ids List<String>
    A list of VPC IDs.
    nameRegex String
    A Name Regex of Vpc.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the VPC.
    tags List<Property Map>
    Tags.
    vpcName String
    The vpc name to query.
    vpcOwnerId Number
    The owner ID of the vpc.

    getVpcs Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of Vpc query.
    Vpcs List<GetVpcsVpc>
    The collection of Vpc query.
    Ids List<string>
    NameRegex string
    OutputFile string
    ProjectName string
    The ProjectName of the VPC.
    Tags List<GetVpcsTag>
    Tags.
    VpcName string
    The name of VPC.
    VpcOwnerId int
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of Vpc query.
    Vpcs []GetVpcsVpc
    The collection of Vpc query.
    Ids []string
    NameRegex string
    OutputFile string
    ProjectName string
    The ProjectName of the VPC.
    Tags []GetVpcsTag
    Tags.
    VpcName string
    The name of VPC.
    VpcOwnerId int
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of Vpc query.
    vpcs List<GetVpcsVpc>
    The collection of Vpc query.
    ids List<String>
    nameRegex String
    outputFile String
    projectName String
    The ProjectName of the VPC.
    tags List<GetVpcsTag>
    Tags.
    vpcName String
    The name of VPC.
    vpcOwnerId Integer
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of Vpc query.
    vpcs GetVpcsVpc[]
    The collection of Vpc query.
    ids string[]
    nameRegex string
    outputFile string
    projectName string
    The ProjectName of the VPC.
    tags GetVpcsTag[]
    Tags.
    vpcName string
    The name of VPC.
    vpcOwnerId number
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of Vpc query.
    vpcs Sequence[GetVpcsVpc]
    The collection of Vpc query.
    ids Sequence[str]
    name_regex str
    output_file str
    project_name str
    The ProjectName of the VPC.
    tags Sequence[GetVpcsTag]
    Tags.
    vpc_name str
    The name of VPC.
    vpc_owner_id int
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of Vpc query.
    vpcs List<Property Map>
    The collection of Vpc query.
    ids List<String>
    nameRegex String
    outputFile String
    projectName String
    The ProjectName of the VPC.
    tags List<Property Map>
    Tags.
    vpcName String
    The name of VPC.
    vpcOwnerId Number

    Supporting Types

    GetVpcsTag

    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.

    GetVpcsVpc

    AccountId string
    The account ID of VPC.
    AssociateCens List<GetVpcsVpcAssociateCen>
    The associate cen list of VPC.
    AuxiliaryCidrBlocks List<string>
    The auxiliary cidr block list of VPC.
    CidrBlock string
    The cidr block of VPC.
    CreationTime string
    The create time of VPC.
    Description string
    The description of VPC.
    DnsServers List<string>
    The dns server list of VPC.
    Ipv6CidrBlock string
    The IPv6 CIDR block of the VPC.
    NatGatewayIds List<string>
    The nat gateway ID list of VPC.
    ProjectName string
    The ProjectName of the VPC.
    RouteTableIds List<string>
    The route table ID list of VPC.
    SecondaryCidrBlocks List<string>
    The secondary cidr block list of VPC.
    SecurityGroupIds List<string>
    The security group ID list of VPC.
    Status string
    The status of VPC.
    SubnetIds List<string>
    The subnet ID list of VPC.
    Tags List<GetVpcsVpcTag>
    Tags.
    UpdateTime string
    The update time of VPC.
    VpcId string
    The ID of VPC.
    VpcName string
    The vpc name to query.
    AccountId string
    The account ID of VPC.
    AssociateCens []GetVpcsVpcAssociateCen
    The associate cen list of VPC.
    AuxiliaryCidrBlocks []string
    The auxiliary cidr block list of VPC.
    CidrBlock string
    The cidr block of VPC.
    CreationTime string
    The create time of VPC.
    Description string
    The description of VPC.
    DnsServers []string
    The dns server list of VPC.
    Ipv6CidrBlock string
    The IPv6 CIDR block of the VPC.
    NatGatewayIds []string
    The nat gateway ID list of VPC.
    ProjectName string
    The ProjectName of the VPC.
    RouteTableIds []string
    The route table ID list of VPC.
    SecondaryCidrBlocks []string
    The secondary cidr block list of VPC.
    SecurityGroupIds []string
    The security group ID list of VPC.
    Status string
    The status of VPC.
    SubnetIds []string
    The subnet ID list of VPC.
    Tags []GetVpcsVpcTag
    Tags.
    UpdateTime string
    The update time of VPC.
    VpcId string
    The ID of VPC.
    VpcName string
    The vpc name to query.
    accountId String
    The account ID of VPC.
    associateCens List<GetVpcsVpcAssociateCen>
    The associate cen list of VPC.
    auxiliaryCidrBlocks List<String>
    The auxiliary cidr block list of VPC.
    cidrBlock String
    The cidr block of VPC.
    creationTime String
    The create time of VPC.
    description String
    The description of VPC.
    dnsServers List<String>
    The dns server list of VPC.
    ipv6CidrBlock String
    The IPv6 CIDR block of the VPC.
    natGatewayIds List<String>
    The nat gateway ID list of VPC.
    projectName String
    The ProjectName of the VPC.
    routeTableIds List<String>
    The route table ID list of VPC.
    secondaryCidrBlocks List<String>
    The secondary cidr block list of VPC.
    securityGroupIds List<String>
    The security group ID list of VPC.
    status String
    The status of VPC.
    subnetIds List<String>
    The subnet ID list of VPC.
    tags List<GetVpcsVpcTag>
    Tags.
    updateTime String
    The update time of VPC.
    vpcId String
    The ID of VPC.
    vpcName String
    The vpc name to query.
    accountId string
    The account ID of VPC.
    associateCens GetVpcsVpcAssociateCen[]
    The associate cen list of VPC.
    auxiliaryCidrBlocks string[]
    The auxiliary cidr block list of VPC.
    cidrBlock string
    The cidr block of VPC.
    creationTime string
    The create time of VPC.
    description string
    The description of VPC.
    dnsServers string[]
    The dns server list of VPC.
    ipv6CidrBlock string
    The IPv6 CIDR block of the VPC.
    natGatewayIds string[]
    The nat gateway ID list of VPC.
    projectName string
    The ProjectName of the VPC.
    routeTableIds string[]
    The route table ID list of VPC.
    secondaryCidrBlocks string[]
    The secondary cidr block list of VPC.
    securityGroupIds string[]
    The security group ID list of VPC.
    status string
    The status of VPC.
    subnetIds string[]
    The subnet ID list of VPC.
    tags GetVpcsVpcTag[]
    Tags.
    updateTime string
    The update time of VPC.
    vpcId string
    The ID of VPC.
    vpcName string
    The vpc name to query.
    account_id str
    The account ID of VPC.
    associate_cens Sequence[GetVpcsVpcAssociateCen]
    The associate cen list of VPC.
    auxiliary_cidr_blocks Sequence[str]
    The auxiliary cidr block list of VPC.
    cidr_block str
    The cidr block of VPC.
    creation_time str
    The create time of VPC.
    description str
    The description of VPC.
    dns_servers Sequence[str]
    The dns server list of VPC.
    ipv6_cidr_block str
    The IPv6 CIDR block of the VPC.
    nat_gateway_ids Sequence[str]
    The nat gateway ID list of VPC.
    project_name str
    The ProjectName of the VPC.
    route_table_ids Sequence[str]
    The route table ID list of VPC.
    secondary_cidr_blocks Sequence[str]
    The secondary cidr block list of VPC.
    security_group_ids Sequence[str]
    The security group ID list of VPC.
    status str
    The status of VPC.
    subnet_ids Sequence[str]
    The subnet ID list of VPC.
    tags Sequence[GetVpcsVpcTag]
    Tags.
    update_time str
    The update time of VPC.
    vpc_id str
    The ID of VPC.
    vpc_name str
    The vpc name to query.
    accountId String
    The account ID of VPC.
    associateCens List<Property Map>
    The associate cen list of VPC.
    auxiliaryCidrBlocks List<String>
    The auxiliary cidr block list of VPC.
    cidrBlock String
    The cidr block of VPC.
    creationTime String
    The create time of VPC.
    description String
    The description of VPC.
    dnsServers List<String>
    The dns server list of VPC.
    ipv6CidrBlock String
    The IPv6 CIDR block of the VPC.
    natGatewayIds List<String>
    The nat gateway ID list of VPC.
    projectName String
    The ProjectName of the VPC.
    routeTableIds List<String>
    The route table ID list of VPC.
    secondaryCidrBlocks List<String>
    The secondary cidr block list of VPC.
    securityGroupIds List<String>
    The security group ID list of VPC.
    status String
    The status of VPC.
    subnetIds List<String>
    The subnet ID list of VPC.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of VPC.
    vpcId String
    The ID of VPC.
    vpcName String
    The vpc name to query.

    GetVpcsVpcAssociateCen

    CenId string
    The ID of CEN.
    CenOwnerId string
    The owner ID of CEN.
    CenStatus string
    The status of CEN.
    CenId string
    The ID of CEN.
    CenOwnerId string
    The owner ID of CEN.
    CenStatus string
    The status of CEN.
    cenId String
    The ID of CEN.
    cenOwnerId String
    The owner ID of CEN.
    cenStatus String
    The status of CEN.
    cenId string
    The ID of CEN.
    cenOwnerId string
    The owner ID of CEN.
    cenStatus string
    The status of CEN.
    cen_id str
    The ID of CEN.
    cen_owner_id str
    The owner ID of CEN.
    cen_status str
    The status of CEN.
    cenId String
    The ID of CEN.
    cenOwnerId String
    The owner ID of CEN.
    cenStatus String
    The status of CEN.

    GetVpcsVpcTag

    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