1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getSubnet
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::VPC::Subnet

    Using getSubnet

    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 getSubnet(args: GetSubnetArgs, opts?: InvokeOptions): Promise<GetSubnetResult>
    function getSubnetOutput(args: GetSubnetOutputArgs, opts?: InvokeOptions): Output<GetSubnetResult>
    def get_subnet(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSubnetResult
    def get_subnet_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSubnetResult]
    func LookupSubnet(ctx *Context, args *LookupSubnetArgs, opts ...InvokeOption) (*LookupSubnetResult, error)
    func LookupSubnetOutput(ctx *Context, args *LookupSubnetOutputArgs, opts ...InvokeOption) LookupSubnetResultOutput

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

    public static class GetSubnet 
    {
        public static Task<GetSubnetResult> InvokeAsync(GetSubnetArgs args, InvokeOptions? opts = null)
        public static Output<GetSubnetResult> Invoke(GetSubnetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
    public static Output<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:vpc/getSubnet:getSubnet
      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.

    getSubnet Result

    The following output properties are available:

    AccountId string
    ID of the account to which the subnet belongs
    AvailableIpAddressCount int
    Number of available IP addresses in the subnet
    CidrBlock string
    Subnet IPv4 CIDR block
    CreatedTime string
    Subnet creation time
    Description string
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    EnableIpv6 bool
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    Id string
    Uniquely identifies the resource.
    Ipv6CidrBlock string
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    IsDefault bool
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    NetworkAclId string
    ID of the network ACL associated with the subnet
    ProjectName string
    Name of the project associated with the VPC instance where the subnet resides
    ReadIpv6CidrBlock string
    Read-only field, subnet IPv6 CIDR block
    RouteTable Volcengine.GetSubnetRouteTable
    Route table information
    Status string
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    SubnetId string
    ID of the subnet whose information is to be modified
    SubnetName string
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    Tags List<Volcengine.GetSubnetTag>
    Subnet tag information
    TotalIpv4Count int
    Total number of available IPs in the subnet
    UpdatedTime string
    Subnet update time
    VpcId string
    ID of the VPC to which the subnet belongs
    ZoneId string
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones
    AccountId string
    ID of the account to which the subnet belongs
    AvailableIpAddressCount int
    Number of available IP addresses in the subnet
    CidrBlock string
    Subnet IPv4 CIDR block
    CreatedTime string
    Subnet creation time
    Description string
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    EnableIpv6 bool
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    Id string
    Uniquely identifies the resource.
    Ipv6CidrBlock string
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    IsDefault bool
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    NetworkAclId string
    ID of the network ACL associated with the subnet
    ProjectName string
    Name of the project associated with the VPC instance where the subnet resides
    ReadIpv6CidrBlock string
    Read-only field, subnet IPv6 CIDR block
    RouteTable GetSubnetRouteTable
    Route table information
    Status string
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    SubnetId string
    ID of the subnet whose information is to be modified
    SubnetName string
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    Tags []GetSubnetTag
    Subnet tag information
    TotalIpv4Count int
    Total number of available IPs in the subnet
    UpdatedTime string
    Subnet update time
    VpcId string
    ID of the VPC to which the subnet belongs
    ZoneId string
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones
    accountId String
    ID of the account to which the subnet belongs
    availableIpAddressCount Integer
    Number of available IP addresses in the subnet
    cidrBlock String
    Subnet IPv4 CIDR block
    createdTime String
    Subnet creation time
    description String
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    enableIpv6 Boolean
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    id String
    Uniquely identifies the resource.
    ipv6CidrBlock String
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    isDefault Boolean
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    networkAclId String
    ID of the network ACL associated with the subnet
    projectName String
    Name of the project associated with the VPC instance where the subnet resides
    readIpv6CidrBlock String
    Read-only field, subnet IPv6 CIDR block
    routeTable GetSubnetRouteTable
    Route table information
    status String
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    subnetId String
    ID of the subnet whose information is to be modified
    subnetName String
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    tags List<GetSubnetTag>
    Subnet tag information
    totalIpv4Count Integer
    Total number of available IPs in the subnet
    updatedTime String
    Subnet update time
    vpcId String
    ID of the VPC to which the subnet belongs
    zoneId String
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones
    accountId string
    ID of the account to which the subnet belongs
    availableIpAddressCount number
    Number of available IP addresses in the subnet
    cidrBlock string
    Subnet IPv4 CIDR block
    createdTime string
    Subnet creation time
    description string
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    enableIpv6 boolean
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    id string
    Uniquely identifies the resource.
    ipv6CidrBlock string
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    isDefault boolean
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    networkAclId string
    ID of the network ACL associated with the subnet
    projectName string
    Name of the project associated with the VPC instance where the subnet resides
    readIpv6CidrBlock string
    Read-only field, subnet IPv6 CIDR block
    routeTable GetSubnetRouteTable
    Route table information
    status string
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    subnetId string
    ID of the subnet whose information is to be modified
    subnetName string
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    tags GetSubnetTag[]
    Subnet tag information
    totalIpv4Count number
    Total number of available IPs in the subnet
    updatedTime string
    Subnet update time
    vpcId string
    ID of the VPC to which the subnet belongs
    zoneId string
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones
    account_id str
    ID of the account to which the subnet belongs
    available_ip_address_count int
    Number of available IP addresses in the subnet
    cidr_block str
    Subnet IPv4 CIDR block
    created_time str
    Subnet creation time
    description str
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    enable_ipv6 bool
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    id str
    Uniquely identifies the resource.
    ipv6_cidr_block str
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    is_default bool
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    network_acl_id str
    ID of the network ACL associated with the subnet
    project_name str
    Name of the project associated with the VPC instance where the subnet resides
    read_ipv6_cidr_block str
    Read-only field, subnet IPv6 CIDR block
    route_table GetSubnetRouteTable
    Route table information
    status str
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    subnet_id str
    ID of the subnet whose information is to be modified
    subnet_name str
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    tags Sequence[GetSubnetTag]
    Subnet tag information
    total_ipv4_count int
    Total number of available IPs in the subnet
    updated_time str
    Subnet update time
    vpc_id str
    ID of the VPC to which the subnet belongs
    zone_id str
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones
    accountId String
    ID of the account to which the subnet belongs
    availableIpAddressCount Number
    Number of available IP addresses in the subnet
    cidrBlock String
    Subnet IPv4 CIDR block
    createdTime String
    Subnet creation time
    description String
    Subnet description. Limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。). Cannot start with http:// or https://
    enableIpv6 Boolean
    Enable or disable IPv6. This parameter can be configured only if the VPC to which the subnet belongs has IPv6 enabled. 1. true: Enable. 2. false: Disable. This value can be configured only if no cloud resources in the subnet have assigned IPv6 addresses
    id String
    Uniquely identifies the resource.
    ipv6CidrBlock String
    Subnet IPv6 CIDR block. 1. When creating or modifying, enter the last 8 bits of the subnet IPv6 CIDR block (subnet mask is fixed at /64). 2. This parameter is supported only when EnableIpv6 is set to true. 3. Value range: 0–255. Mask is fixed at /64
    isDefault Boolean
    Whether the subnet is a default subnet. 1. true: Default subnet, created automatically when an ECS instance is created. 2. false: Non-default subnet, created manually by the user
    networkAclId String
    ID of the network ACL associated with the subnet
    projectName String
    Name of the project associated with the VPC instance where the subnet resides
    readIpv6CidrBlock String
    Read-only field, subnet IPv6 CIDR block
    routeTable Property Map
    Route table information
    status String
    Subnet status. 1. Pending: Configuring. 2. Available: Available
    subnetId String
    ID of the subnet whose information is to be modified
    subnetName String
    Subnet name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Cannot start with http:// or https://. If not specified, defaults to the subnet ID
    tags List<Property Map>
    Subnet tag information
    totalIpv4Count Number
    Total number of available IPs in the subnet
    updatedTime String
    Subnet update time
    vpcId String
    ID of the VPC to which the subnet belongs
    zoneId String
    Availability zone ID for the subnet to be created. For more information, see Regions and Availability Zones

    Supporting Types

    GetSubnetRouteTable

    RouteTableId string
    ID of the route table associated with the subnet
    RouteTableType string
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table
    RouteTableId string
    ID of the route table associated with the subnet
    RouteTableType string
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table
    routeTableId String
    ID of the route table associated with the subnet
    routeTableType String
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table
    routeTableId string
    ID of the route table associated with the subnet
    routeTableType string
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table
    route_table_id str
    ID of the route table associated with the subnet
    route_table_type str
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table
    routeTableId String
    ID of the route table associated with the subnet
    routeTableType String
    Type of route table associated with the subnet. 1. System: System route table. 2. Custom: Custom route table

    GetSubnetTag

    Key string
    User tag key
    Value string
    User tag value
    Key string
    User tag key
    Value string
    User tag value
    key String
    User tag key
    value String
    User tag value
    key string
    User tag key
    value string
    User tag value
    key str
    User tag key
    value str
    User tag value
    key String
    User tag key
    value String
    User 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
      Try Pulumi Cloud free. Your team will thank you.