Skip to main content

route_tables

Creates, updates, deletes, gets or lists a route_tables resource.

Overview​

Nameroute_tables
TypeResource
Idoci.network.route_tables

Fields​

The following fields are returned by SELECT queries:

The route table was retrieved.

NameDatatypeDescription
idstringThe route table's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route table.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleStatestringThe route table's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
routeRulesarrayThe collection of rules for routing destination IPs to network devices.
timeCreatedstring (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
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table list belongs to.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectrtId, regionGets the specified route table's information.
listselectcompartmentId, regionlimit, page, vcnId, displayName, sortBy, sortOrder, lifecycleStateLists the route tables in the specified VCN and specified compartment.<br />If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment.<br />The response includes the default route table that automatically comes with<br />each VCN in the specified compartment, plus any route tables you've created.<br />
createinsertregion, compartmentId, routeRules, vcnIdopc-retry-tokenCreates a new route table for the specified VCN. In the request you must also include at least one route<br />rule for the new route table. For information on the number of rules you can have in a route table, see<br />[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route<br />tables in your VCN and the types of targets you can use in route rules,<br />see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route<br />table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,<br />or other Networking Service components. If you're not sure which compartment to use, put the route<br />table in the same compartment as the VCN. For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the route table, otherwise a default is provided.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />
updateupdatertId, regionif-matchUpdates the specified route table's display name or route rules.<br />Avoid entering confidential information.<br /><br />Note that the routeRules object you provide replaces the entire existing set of rules.<br />
deletedeletertId, regionif-matchDeletes the specified route table, but only if it's not associated with a subnet. You can't delete a<br />VCN's default route table.<br /><br />This is an asynchronous operation. The route table's lifecycleState will change to TERMINATING temporarily<br />until the route table is completely removed.<br />
change_compartmentexecrtId, region, compartmentIdopc-request-id, opc-retry-tokenMoves a route table into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
rtIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table.
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleStatestringA filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.

SELECT examples​

Gets the specified route table's information.

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
routeRules,
timeCreated,
vcnId
FROM oci.network.route_tables
WHERE rtId = '{{ rtId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a new route table for the specified VCN. In the request you must also include at least one route<br />rule for the new route table. For information on the number of rules you can have in a route table, see<br />[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route<br />tables in your VCN and the types of targets you can use in route rules,<br />see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route<br />table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,<br />or other Networking Service components. If you're not sure which compartment to use, put the route<br />table in the same compartment as the VCN. For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see<br />[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the route table, otherwise a default is provided.<br />It does not have to be unique, and you can change it. Avoid entering confidential information.<br />

INSERT INTO oci.network.route_tables (
compartmentId,
definedTags,
displayName,
freeformTags,
routeRules,
vcnId,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ routeRules }}' /* required */,
'{{ vcnId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
routeRules,
timeCreated,
vcnId
;

UPDATE examples​

Updates the specified route table's display name or route rules.<br />Avoid entering confidential information.<br /><br />Note that the routeRules object you provide replaces the entire existing set of rules.<br />

UPDATE oci.network.route_tables
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
routeRules = '{{ routeRules }}'
WHERE 
rtId = '{{ rtId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
routeRules,
timeCreated,
vcnId;

DELETE examples​

Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a<br />VCN's default route table.<br /><br />This is an asynchronous operation. The route table's lifecycleState will change to TERMINATING temporarily<br />until the route table is completely removed.<br />

DELETE FROM oci.network.route_tables
WHERE rtId = '{{ rtId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods​

Moves a route table into a different compartment within the same tenancy. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.network.route_tables.change_compartment 
@rtId='{{ rtId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;