1. REST API for Oracle Private Cloud Appliance Compute Enclave
  2. Tasks
  3. Networking
  4. Subnets

List Subnets

get

/20160918/subnets

List the subnets in the specified VCN and the specified compartment. If the VCN OCID is not provided, then the list includes the subnets from all VCNs in the specified compartment.

Request

Supported Media Types
Query Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment.
  • Minimum Length: 1
    Maximum Length: 255
    A filter to return only resources that match the entire display name given.
  • A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
  • Minimum Value: 1
    Maximum Value: 1000
    For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.
    Default Value: 100
  • Minimum Length: 1
    Maximum Length: 512
    For list pagination. The value of the opc-next-page response header from the previous List call.
    Default Value: 0
  • The optional field to sort the results by.
    Allowed Values: [ "TIMECREATED", "NAME" ]
  • The sort order to use, either ascending (ASC) or descending (DESC).
    Default Value: ASC
    Allowed Values: [ "ASC", "DESC" ]
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the VCN.
Back to Top

Response

Supported Media Types

200 Response

The list is being retrieved.
Headers
  • For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : schema
Type: array
Show Source
  • Subnet
    A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24.
Nested Schema : Subnet
Type: object
A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: AD-1
  • Minimum Length: 1
    Maximum Length: 32
    The subnet's CIDR block. Example: 10.0.1.0/24
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment containing the subnet.
  • definedTags
    Additional Properties Allowed: additionalProperties
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the set of DHCP options that the subnet uses.
  • Minimum Length: 1
    Maximum Length: 255
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
  • Minimum Length: 1
    Maximum Length: 15
    A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance-1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet. Example: subnet123
  • freeformTags
    Additional Properties Allowed: additionalProperties
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
  • Minimum Length: 1
    Maximum Length: 255
    The subnet's OCID.
  • Minimum Length: 1
    Maximum Length: 45
    For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's IP address space. The subnet size is always /64. Example: 2001:0db8:0123:1111::/64
  • ipv6CidrBlocks
    Unique Items Required: true
    The list of all IPv6 CIDR blocks (Oracle allocated IPv6 GUA, ULA or private IPv6 CIDR blocks, BYOIPv6 CIDR blocks) for the subnet.
  • Minimum Length: 1
    Maximum Length: 45
    To be deprecated.
  • Minimum Length: 1
    Maximum Length: 45
    For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: 2001:0db8:0123:1111:89ab:cdef:1234:5678
  • Whether learning mode is enabled for this subnet. The default is false. Note: When a subnet has learning mode enabled, only certain types of resources can be launched in the subnet.
  • Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "UPDATING" ]
    The subnet's current state.
  • Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false. For IPV4, prohibitInternetIngress behaves similarly to prohibitPublicIpOnVnic. If it is set to false, VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitInternetIngress is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). For IPv6, if prohibitInternetIngress is set to true, internet access is not allowed for any IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.
  • Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the assignPublicIp flag in CreateVnicDetails). If prohibitPublicIpOnVnic is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet).
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the route table that the subnet uses.
  • securityListIds
    The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
  • Minimum Length: 1
    Maximum Length: 253
    The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the domain. Example: subnet123.vcn1.oraclevcn.com
  • The date and time the subnet was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the VCN the subnet is in.
  • Minimum Length: 1
    Maximum Length: 32
    The IP address of the virtual router. Example: 10.0.14.1
  • Minimum Length: 1
    Maximum Length: 32
    The MAC address of the virtual router. Example: 00:00:00:00:00:01
  • The VLAN tag assigned to VNIC Attachments within this Subnet if the Subnet has learning enabled. Note: When a subnet does not have learning enabled, this field will be null. Example: 100
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : ipv6CidrBlocks
Type: array
Unique Items Required: true
The list of all IPv6 CIDR blocks (Oracle allocated IPv6 GUA, ULA or private IPv6 CIDR blocks, BYOIPv6 CIDR blocks) for the subnet.
Show Source
Nested Schema : securityListIds
Type: array
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated with the subnet, but the rules are applied to the individual VNICs in the subnet.
Show Source
  • Minimum Value: 0
    Maximum Value: 5
    Minimum Length: 1
    Maximum Length: 255
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

An error has occurred.
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top