List Route Tables
get
/20160918/routeTables
List the route tables in the specified VCN and specified compartment. If the VCN OCID is not provided, then the list includes the route tables from all VCNs in the specified compartment.
The response includes the default route table that automatically comes with each VCN in the specified compartment, plus any route tables that you created.
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" ]
-
vcnId: string
Minimum Length:
1
Maximum Length:255
The OCID of the VCN.
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:
Show Source
array
-
Array of:
object RouteTable
A collection of RouteRule objects, which are used to route packets based on destination IP to a particular network entity.
Nested Schema : RouteTable
Type:
object
A collection of RouteRule objects, which are used to route packets based on destination IP to a particular network entity.
Show Source
-
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment containing the route table. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined 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. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-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 route table's OCID. -
isEcmpEnabled:
boolean
Indicates whether or not ECMP is enabled on the route table.
-
lifecycleState(required):
string
Allowed Values:
[ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]
The route table's current state. -
localRouteRules:
array localRouteRules
The collection of local route rules generated by OCI.
-
routeRules(required):
array routeRules
The collection of rules for routing destination IPs to network devices.
-
timeCreated:
string(date-time)
The date and time the route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
vcnId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the VCN the route table list belongs to.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Defined tags for this resource. Each key is predefined and scoped to a namespace.
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 : localRouteRules
Type:
array
The collection of local route rules generated by OCI.
Show Source
-
Array of:
object RouteRule
A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
Nested Schema : routeRules
Type:
array
The collection of rules for routing destination IPs to network devices.
Show Source
-
Array of:
object RouteRule
A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
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 : RouteRule
Type:
object
A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
Show Source
-
cidrBlock:
string
Minimum Length:
9
Maximum Length:18
Deprecated. Instead use destination and destinationType. Requests that include both cidrBlock and destination will be rejected. A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target). Cannot be an IPv6 CIDR. Example: 0.0.0.0/0 -
description:
string
Minimum Length:
1
Maximum Length:255
An optional description of your choice for the rule. -
destination:
string
Minimum Length:
1
Maximum Length:255
This is the range of IP addresses used for matching when routing traffic. This value is required if you provide a destinationType. The following values are allowed:- IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway.
- The cidrBlock value for a Service, if you're setting up a route rule for traffic destined for a particular Service through a service gateway.
-
destinationType:
string
Default Value:
CIDR_BLOCK
Allowed Values:[ "CIDR_BLOCK", "SERVICE_CIDR_BLOCK" ]
Type of destination for the rule. This value is required if you provide a destination. The following values are allowed:- CIDR_BLOCK: If the rule's destination is an IP address range in CIDR notation.
- SERVICE_CIDR_BLOCK: If the rule's destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).
-
networkEntityId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID for the route rule's target. -
routeType:
string
Allowed Values:
[ "STATIC", "LOCAL" ]
A route rule can be STATIC if manually added to the Route Table, LOCAL if added by OCI to the Route Table.
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.
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.
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.
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.