REST API for Oracle Private Cloud Appliance Compute Enclave

List VCNs

get

/20160918/vcns

List the virtual cloud networks (VCNs) in the specified compartment.

Request

Supported Media Types

application/json

Query Parameters

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment.
displayName: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match the entire display name given.
lifecycleState: string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limit: integer

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
page: string

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
sortBy: string

The optional field to sort the results by.

Allowed Values: [ "TIMECREATED", "NAME" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]

Response

Supported Media Types

application/json

200 Response

The list is being retrieved.

Headers

opc-next-page: string

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).
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : schema

Type: array

Show Source

Array of: object Vcn

A virtual cloud network (VCN).

{
    "items":{
        "$ref":"#/definitions/Vcn"
    },
    "type":"array"
}

Nested Schema : Vcn

Type: object

A virtual cloud network (VCN).

Show Source

byoipv6CidrBlocks: array byoipv6CidrBlocks

Unique Items Required: true

The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.
cidrBlock(required): string

Minimum Length: 1

Maximum Length: 32

Deprecated. The first CIDR IP address from cidrBlocks. Example: 172.16.0.0/16
cidrBlocks(required): array cidrBlocks

Maximum Number of Items: 5

Unique Items Required: true

The list of IPv4 CIDR blocks the VCN will use.
compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment containing the VCN.
defaultDhcpOptionsId: string

Minimum Length: 1

Maximum Length: 255

The OCID for the VCN's default set of DHCP options.
defaultRouteTableId: string

Minimum Length: 1

Maximum Length: 255

The OCID for the VCN's default route table.
defaultSecurityListId: string

Minimum Length: 1

Maximum Length: 255

The OCID for the VCN's default security list.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
dnsLabel: string

Minimum Length: 1

Maximum Length: 15

A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet'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. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not work for this VCN. Example: vcn1
freeformTags: object 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"}
id(required): string

Minimum Length: 1

Maximum Length: 255

The VCN's OCID.
ipv6CidrBlock: string

Minimum Length: 1

Maximum Length: 45

To be deprecated.
ipv6CidrBlocks: array ipv6CidrBlocks

Maximum Number of Items: 1

Unique Items Required: true

For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.
ipv6PrivateCidrBlocks: array ipv6PrivateCidrBlocks

Unique Items Required: true

For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.
ipv6PublicCidrBlock: string

Minimum Length: 1

Maximum Length: 45

To be deprecated.
isEncrypted: boolean

Indicates whether traffic within the VCN is encrypted.
lifecycleState(required): string

Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "UPDATING" ]

The VCN's current state.
timeCreated: string(date-time)

The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vcnDomainName: string

Minimum Length: 1

Maximum Length: 253

The VCN's domain name, which consists of the VCN's DNS label, and the domain. Example: vcn1.oraclevcn.com
zprTags: object zprTags

Additional Properties Allowed: additionalProperties

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

{
    "description":"A virtual cloud network (VCN).",
    "x-obmcs-splat":{
        "resourceKind":"vcn",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            "TERMINATED"
        ],
        "getOperationId":"GetVcn",
        "listResourcesOperationId":"ListVcns",
        "ocidEntityType":"vcn"
    },
    "properties":{
        "byoipv6CidrBlocks":{
            "description":"The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.",
            "items":{
                "type":"string",
                "maxLength":45,
                "minLength":1
            },
            "type":"array",
            "uniqueItems":true
        },
        "ipv6PrivateCidrBlocks":{
            "description":"For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.",
            "items":{
                "type":"string",
                "maxLength":45,
                "minLength":1
            },
            "type":"array",
            "uniqueItems":true
        },
        "cidrBlock":{
            "description":"Deprecated. The first CIDR IP address from cidrBlocks. Example: 172.16.0.0/16 ",
            "maxLength":32,
            "minLength":1,
            "type":"string"
        },
        "cidrBlocks":{
            "description":"The list of IPv4 CIDR blocks the VCN will use.",
            "items":{
                "type":"string",
                "maxLength":32,
                "minLength":1
            },
            "maxItems":5,
            "type":"array",
            "uniqueItems":true
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the VCN.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "defaultDhcpOptionsId":{
            "description":"The OCID for the VCN's default set of DHCP options.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "defaultRouteTableId":{
            "description":"The OCID for the VCN's default route table.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "defaultSecurityListId":{
            "description":"The OCID for the VCN's default security list.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "dnsLabel":{
            "description":"A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet'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. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not work for this VCN. Example: vcn1 ",
            "maxLength":15,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "zprTags":{
            "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. ",
                    "type":"object"
                }
            }
        },
        "id":{
            "description":"The VCN's OCID.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "ipv6CidrBlocks":{
            "description":"For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.",
            "items":{
                "type":"string",
                "maxLength":45,
                "minLength":1
            },
            "maxItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "ipv6CidrBlock":{
            "description":"To be deprecated.",
            "maxLength":45,
            "minLength":1,
            "type":"string"
        },
        "ipv6PublicCidrBlock":{
            "description":"To be deprecated.",
            "maxLength":45,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The VCN's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED",
                "UPDATING"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "vcnDomainName":{
            "description":"The VCN's domain name, which consists of the VCN's DNS label, and the domain. Example: vcn1.oraclevcn.com ",
            "maxLength":253,
            "minLength":1,
            "type":"string"
        },
        "isEncrypted":{
            "description":"Indicates whether traffic within the VCN is encrypted.",
            "type":"boolean"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "cidrBlock",
        "lifecycleState",
        "cidrBlocks"
    ],
    "x-example":"{   \"cidrBlock\" : \"10.0.0.0/16\",   \"cidrBlocks\" : [\"10.0.0.0/16\",\"192.168.0.0/16\"],   \"compartmentId\" : \"ocid1.compartment.oc1..&lt;unique_ID&gt;\",   \"defaultDhcpOptionsId\" : \"ocid1.dhcpoptions.oc1.phx.&lt;unique_ID&gt;\",   \"defaultRouteTableId\" : \"ocid1.routetable.oc1.phx.&lt;unique_ID&gt;\",   \"defaultSecurityListId\" : \"ocid1.securitylist.oc1.phx.&lt;unique_ID&gt;\",   \"displayName\" : \"MyVcn\",   \"id\" : \"ocid1.vcn.oc1.phx.&lt;unique_ID&gt;\",   \"lifecycleState\" : \"AVAILABLE\",   \"timeCreated\" : \"2016-11-18T22:16:24.423Z\" } ",
    "type":"object"
}

Nested Schema : byoipv6CidrBlocks

Type: array

Unique Items Required: true

The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 45

{
    "description":"The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.",
    "items":{
        "type":"string",
        "maxLength":45,
        "minLength":1
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : cidrBlocks

Type: array

Maximum Number of Items: 5

Unique Items Required: true

The list of IPv4 CIDR blocks the VCN will use.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 32

{
    "description":"The list of IPv4 CIDR blocks the VCN will use.",
    "items":{
        "type":"string",
        "maxLength":32,
        "minLength":1
    },
    "maxItems":5,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

Maximum Number of Items: 1

Unique Items Required: true

For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 45

{
    "description":"For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.",
    "items":{
        "type":"string",
        "maxLength":45,
        "minLength":1
    },
    "maxItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : ipv6PrivateCidrBlocks

Type: array

Unique Items Required: true

For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 45

{
    "description":"For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.",
    "items":{
        "type":"string",
        "maxLength":45,
        "minLength":1
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : zprTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. ",
            "type":"object"
        }
    }
}

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

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.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag.

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

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).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

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).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

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).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

The properties that define an error.

Show Source

code(required): string

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).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}