1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. vpc
  5. getVpc
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vpc.getVpc

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::VPC::VPC

    Using getVpc

    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 getVpc(args: GetVpcArgs, opts?: InvokeOptions): Promise<GetVpcResult>
function getVpcOutput(args: GetVpcOutputArgs, opts?: InvokeOptions): Output<GetVpcResult>
    def get_vpc(id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVpcResult
def get_vpc_output(id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVpcResult]
    func LookupVpc(ctx *Context, args *LookupVpcArgs, opts ...InvokeOption) (*LookupVpcResult, error)
func LookupVpcOutput(ctx *Context, args *LookupVpcOutputArgs, opts ...InvokeOption) LookupVpcResultOutput

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

    public static class GetVpc 
{
    public static Task<GetVpcResult> InvokeAsync(GetVpcArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcResult> Invoke(GetVpcInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
public static Output<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:vpc/getVpc:getVpc
  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.

    getVpc Result

    The following output properties are available:

    AccountId string
    VPC所属账号的ID。
    AssociateCens List<Byteplus.GetVpcAssociateCen>
    VPC关联的CEN信息。
    CidrBlock string
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    CreationTime string
    创建VPC的时间。
    Description string
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    DnsServers List<string>
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    EnableIpv6 bool
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    Id string
    Uniquely identifies the resource.
    Ipv4GatewayId string
    VPC 绑定的 IPv4 网关的 ID。
    Ipv6CidrBlock string
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    IsDefault bool
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    NatGatewayIds List<string>
    VPC中创建的NAT网关的ID。
    NetworkAclNum string
    VPC中的网络ACL的数量。
    ProjectName string
    VPC所属项目的名称。不填默认加入default项目。
    RouteTableIds List<string>
    VPC关联的路由表ID。
    SecondaryCidrBlocks List<string>
    VPC的辅助网段。
    SecurityGroupIds List<string>
    VPC中安全组的列表。
    Status string
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    SubnetIds List<string>
    VPC中子网的列表。
    SupportIpv4Gateway bool
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    Tags List<Byteplus.GetVpcTag>
    私有网络绑定的标签。
    UpdateTime string
    更新VPC的时间。
    UserCidrBlocks List<string>
    VPC的用户网段。
    VpcId string
    VPC的ID。
    VpcName string
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。
    AccountId string
    VPC所属账号的ID。
    AssociateCens []GetVpcAssociateCen
    VPC关联的CEN信息。
    CidrBlock string
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    CreationTime string
    创建VPC的时间。
    Description string
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    DnsServers []string
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    EnableIpv6 bool
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    Id string
    Uniquely identifies the resource.
    Ipv4GatewayId string
    VPC 绑定的 IPv4 网关的 ID。
    Ipv6CidrBlock string
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    IsDefault bool
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    NatGatewayIds []string
    VPC中创建的NAT网关的ID。
    NetworkAclNum string
    VPC中的网络ACL的数量。
    ProjectName string
    VPC所属项目的名称。不填默认加入default项目。
    RouteTableIds []string
    VPC关联的路由表ID。
    SecondaryCidrBlocks []string
    VPC的辅助网段。
    SecurityGroupIds []string
    VPC中安全组的列表。
    Status string
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    SubnetIds []string
    VPC中子网的列表。
    SupportIpv4Gateway bool
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    Tags []GetVpcTag
    私有网络绑定的标签。
    UpdateTime string
    更新VPC的时间。
    UserCidrBlocks []string
    VPC的用户网段。
    VpcId string
    VPC的ID。
    VpcName string
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。
    accountId String
    VPC所属账号的ID。
    associateCens List<GetVpcAssociateCen>
    VPC关联的CEN信息。
    cidrBlock String
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    creationTime String
    创建VPC的时间。
    description String
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    dnsServers List<String>
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    enableIpv6 Boolean
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    id String
    Uniquely identifies the resource.
    ipv4GatewayId String
    VPC 绑定的 IPv4 网关的 ID。
    ipv6CidrBlock String
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    isDefault Boolean
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    natGatewayIds List<String>
    VPC中创建的NAT网关的ID。
    networkAclNum String
    VPC中的网络ACL的数量。
    projectName String
    VPC所属项目的名称。不填默认加入default项目。
    routeTableIds List<String>
    VPC关联的路由表ID。
    secondaryCidrBlocks List<String>
    VPC的辅助网段。
    securityGroupIds List<String>
    VPC中安全组的列表。
    status String
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    subnetIds List<String>
    VPC中子网的列表。
    supportIpv4Gateway Boolean
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    tags List<GetVpcTag>
    私有网络绑定的标签。
    updateTime String
    更新VPC的时间。
    userCidrBlocks List<String>
    VPC的用户网段。
    vpcId String
    VPC的ID。
    vpcName String
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。
    accountId string
    VPC所属账号的ID。
    associateCens GetVpcAssociateCen[]
    VPC关联的CEN信息。
    cidrBlock string
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    creationTime string
    创建VPC的时间。
    description string
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    dnsServers string[]
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    enableIpv6 boolean
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    id string
    Uniquely identifies the resource.
    ipv4GatewayId string
    VPC 绑定的 IPv4 网关的 ID。
    ipv6CidrBlock string
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    isDefault boolean
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    natGatewayIds string[]
    VPC中创建的NAT网关的ID。
    networkAclNum string
    VPC中的网络ACL的数量。
    projectName string
    VPC所属项目的名称。不填默认加入default项目。
    routeTableIds string[]
    VPC关联的路由表ID。
    secondaryCidrBlocks string[]
    VPC的辅助网段。
    securityGroupIds string[]
    VPC中安全组的列表。
    status string
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    subnetIds string[]
    VPC中子网的列表。
    supportIpv4Gateway boolean
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    tags GetVpcTag[]
    私有网络绑定的标签。
    updateTime string
    更新VPC的时间。
    userCidrBlocks string[]
    VPC的用户网段。
    vpcId string
    VPC的ID。
    vpcName string
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。
    account_id str
    VPC所属账号的ID。
    associate_cens Sequence[GetVpcAssociateCen]
    VPC关联的CEN信息。
    cidr_block str
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    creation_time str
    创建VPC的时间。
    description str
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    dns_servers Sequence[str]
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    enable_ipv6 bool
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    id str
    Uniquely identifies the resource.
    ipv4_gateway_id str
    VPC 绑定的 IPv4 网关的 ID。
    ipv6_cidr_block str
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    is_default bool
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    nat_gateway_ids Sequence[str]
    VPC中创建的NAT网关的ID。
    network_acl_num str
    VPC中的网络ACL的数量。
    project_name str
    VPC所属项目的名称。不填默认加入default项目。
    route_table_ids Sequence[str]
    VPC关联的路由表ID。
    secondary_cidr_blocks Sequence[str]
    VPC的辅助网段。
    security_group_ids Sequence[str]
    VPC中安全组的列表。
    status str
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    subnet_ids Sequence[str]
    VPC中子网的列表。
    support_ipv4_gateway bool
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    tags Sequence[GetVpcTag]
    私有网络绑定的标签。
    update_time str
    更新VPC的时间。
    user_cidr_blocks Sequence[str]
    VPC的用户网段。
    vpc_id str
    VPC的ID。
    vpc_name str
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。
    accountId String
    VPC所属账号的ID。
    associateCens List<Property Map>
    VPC关联的CEN信息。
    cidrBlock String
    VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：192.168.0.0/16 ~ 24、10.0.0.0/8 ~ 24、172.16.0.0/12 ~ 24。
    creationTime String
    创建VPC的时间。
    description String
    VPC的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不能以http://或https://开头。
    dnsServers List<String>
    VPC的DNS服务器地址。单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。多个IP之间用&分隔。不填则配置为默认DNS服务器地址。
    enableIpv6 Boolean
    是否开启IPv6网段。false（默认值）：不开启。true：开启。
    id String
    Uniquely identifies the resource.
    ipv4GatewayId String
    VPC 绑定的 IPv4 网关的 ID。
    ipv6CidrBlock String
    VPC的IPv6网段。传入此参数后，参数Ipv6MaskLen不生效。参数Ipv6Isp传入非BGP后，参数Ipv6MaskLen和参数Ipv6CidrBlock二者必须传入一个。参数Ipv6Isp未传或传入BGP，此参数未传，则由系统自动分配IPv6网段。
    isDefault Boolean
    该VPC是否为默认VPC。true：默认VPC，表示该VPC是创建ECS实例时系统自动创建的VPC。false：非默认VPC，表示该VPC是用户手动创建的。
    natGatewayIds List<String>
    VPC中创建的NAT网关的ID。
    networkAclNum String
    VPC中的网络ACL的数量。
    projectName String
    VPC所属项目的名称。不填默认加入default项目。
    routeTableIds List<String>
    VPC关联的路由表ID。
    secondaryCidrBlocks List<String>
    VPC的辅助网段。
    securityGroupIds List<String>
    VPC中安全组的列表。
    status String
    VPC的状态。Creating：创建中。Pending：已创建。Available：可用。
    subnetIds List<String>
    VPC中子网的列表。
    supportIpv4Gateway Boolean
    VPC 是否启用 IPv4 网关。false（默认值）：不启用。true：启用。
    tags List<Property Map>
    私有网络绑定的标签。
    updateTime String
    更新VPC的时间。
    userCidrBlocks List<String>
    VPC的用户网段。
    vpcId String
    VPC的ID。
    vpcName String
    VPC的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为VPC实例的ID。不能以http://或https://开头。

    Supporting Types

    GetVpcAssociateCen

    CenId string
    CEN的ID。
    CenOwnerId string
    CEN的用户ID。
    CenStatus string
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载
    CenId string
    CEN的ID。
    CenOwnerId string
    CEN的用户ID。
    CenStatus string
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载
    cenId String
    CEN的ID。
    cenOwnerId String
    CEN的用户ID。
    cenStatus String
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载
    cenId string
    CEN的ID。
    cenOwnerId string
    CEN的用户ID。
    cenStatus string
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载
    cen_id str
    CEN的ID。
    cen_owner_id str
    CEN的用户ID。
    cen_status str
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载
    cenId String
    CEN的ID。
    cenOwnerId String
    CEN的用户ID。
    cenStatus String
    VPC在CEN中的状态。Attaching：加载中，Attached：已加载

    GetVpcTag

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.