Skip to main content

drg_route_distributions

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

Overview​

Namedrg_route_distributions
TypeResource
Idoci.network.drg_route_distributions

Fields​

The following fields are returned by SELECT queries:

The route distribution was retrieved.

NameDatatypeDescription
idstringThe route distribution's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution.
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.
distributionTypestringWhether this distribution defines how routes get imported into route tables or exported through DRG attachments. (IMPORT, EXPORT)
drgIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that contains this route distribution.
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 distribution's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
timeCreatedstring (date-time)The date and time the route distribution was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdrgRouteDistributionId, regionGets the specified route distribution's information.
listselectdrgId, regionlimit, page, displayName, sortBy, sortOrder, lifecycleStateLists the route distributions in the specified DRG.<br /><br />To retrieve the statements in a distribution, use the<br />ListDrgRouteDistributionStatements operation.<br />
createinsertregion, drgId, distributionTypeopc-retry-tokenCreates a new route distribution for the specified DRG.<br />Assign the route distribution as an import distribution to a DRG route table using the UpdateDrgRouteTable or CreateDrgRouteTable operations.<br />Assign the route distribution as an export distribution to a DRG attachment<br />using the UpdateDrgAttachment or CreateDrgAttachment operations.<br />
updateupdatedrgRouteDistributionId, regionif-matchUpdates the specified route distribution<br />
deletedeletedrgRouteDistributionId, regionif-matchDeletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.<br /><br />Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations.<br />
add_drg_route_distribution_statementsexecdrgRouteDistributionId, region, statementsAdds one or more route distribution statements to the specified route distribution.<br />
remove_drg_route_distribution_statementsexecdrgRouteDistributionId, regionRemoves one or more route distribution statements from the specified route distribution's map.<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
drgIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
drgRouteDistributionIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution.
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)
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 that only returns resources that match the specified lifecycle state. The 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-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.

SELECT examples​

Gets the specified route distribution's information.

SELECT
id,
compartmentId,
definedTags,
displayName,
distributionType,
drgId,
freeformTags,
lifecycleState,
timeCreated
FROM oci.network.drg_route_distributions
WHERE drgRouteDistributionId = '{{ drgRouteDistributionId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Creates a new route distribution for the specified DRG.<br />Assign the route distribution as an import distribution to a DRG route table using the UpdateDrgRouteTable or CreateDrgRouteTable operations.<br />Assign the route distribution as an export distribution to a DRG attachment<br />using the UpdateDrgAttachment or CreateDrgAttachment operations.<br />

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

UPDATE examples​

Updates the specified route distribution<br />

UPDATE oci.network.drg_route_distributions
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
drgRouteDistributionId = '{{ drgRouteDistributionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
distributionType,
drgId,
freeformTags,
lifecycleState,
timeCreated;

DELETE examples​

Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.<br /><br />Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations.<br />

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

Lifecycle Methods​

Adds one or more route distribution statements to the specified route distribution.<br />

EXEC oci.network.drg_route_distributions.add_drg_route_distribution_statements 
@drgRouteDistributionId='{{ drgRouteDistributionId }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"statements": "{{ statements }}"
}'
;