Skip to main content

resolvers

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

Overview​

Nameresolvers
TypeResource
Idoci.dns.resolvers

Fields​

The following fields are returned by SELECT queries:

A Response containing a single resolver object.

NameDatatypeDescription
idstringThe OCID of the resolver.
attachedVcnIdstringThe OCID of the attached VCN.
attachedViewsarrayThe attached views. Views are evaluated in order.
compartmentIdstringThe OCID of the owning compartment.
defaultViewIdstringThe OCID of the default view.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringThe display name of the resolver. (x-default-description: This field will be set to a value in the format "dnsresolver<currentTimestampUTC>" where currentTimestampUTC<br />is in ISO 8601 basic format "yyyyMMddHHmmss".<br />)
endpointsarrayRead-only array of endpoints for the resolver.
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](/Content/General/Concepts/resourcetags.htm). Example: &#123;"Department": "Finance"&#125;
isProtectedbooleanA Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
lifecycleStatestringThe current state of the resource. (ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING)
rulesarrayRules for the resolver. Rules are evaluated in order, and only the first matching rule will have its action applied.
selfstring (url)The canonical absolute URL of the resource.
timeCreatedstring (date-time)The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. Example: 2016-07-22T17:23:59:60Z
timeUpdatedstring (date-time)The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. Example: 2016-07-22T17:23:59:60Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresolverId, regionIf-Modified-Since, If-None-Match, opc-request-id, scopeGets information about a specific resolver.<br /><br />Note that attempting to get a resolver in the DELETED lifecycleState will result in a 404<br />response to be consistent with other operations of the API.<br />
listselectcompartmentId, regionopc-request-id, displayName, id, page, limit, sortOrder, sortBy, lifecycleState, scopeGets a list of all resolvers within a compartment.<br /><br />The collection can be filtered by display name, id, or lifecycle state. It can be sorted<br />on creation time or displayName both in ASC or DESC order. Note that when no lifecycleState<br />query parameter is provided, the collection does not include resolvers in the DELETED<br />lifecycleState to be consistent with other operations of the API.<br />
updateupdateresolverId, regionIf-Match, If-Unmodified-Since, opc-request-id, scopeUpdates the specified resolver with your new information.<br />
change_compartmentexecresolverId, region, compartmentIdIf-Match, opc-retry-token, opc-request-id, scopeMoves a resolver into a different compartment along with its protected default view and any endpoints.<br /><br />Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment<br />as their corresponding VCN, but can then be moved to a different compartment.<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 of the compartment the resource belongs to.
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)
resolverIdstringThe OCID of the target resolver.
If-MatchstringThe If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
If-Modified-SincestringThe If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
If-None-MatchstringThe If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
If-Unmodified-SincestringThe If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
displayNamestringThe displayName of a resource.
idstringThe OCID of a resource.
lifecycleStatestringThe state of a resource.
limitinteger (int64)The maximum number of items to return in a page of the collection.
opc-request-idstringUnique Oracle-assigned 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).
pagestringThe value of the opc-next-page response header from the previous "List" call.
scopestringSpecifies to operate only on resources that have a matching DNS scope.
sortBystringThe field by which to sort resolvers.
sortOrderstringThe order to sort the resources.

SELECT examples​

Gets information about a specific resolver.<br /><br />Note that attempting to get a resolver in the DELETED lifecycleState will result in a 404<br />response to be consistent with other operations of the API.<br />

SELECT
id,
attachedVcnId,
attachedViews,
compartmentId,
defaultViewId,
definedTags,
displayName,
endpoints,
freeformTags,
isProtected,
lifecycleState,
rules,
self,
timeCreated,
timeUpdated
FROM oci.dns.resolvers
WHERE resolverId = '{{ resolverId }}' -- required
AND region = '{{ region }}' -- required
AND If-Modified-Since = '{{ If-Modified-Since }}'
AND If-None-Match = '{{ If-None-Match }}'
AND opc-request-id = '{{ opc-request-id }}'
AND scope = '{{ scope }}'
;

UPDATE examples​

Updates the specified resolver with your new information.<br />

UPDATE oci.dns.resolvers
SET 
attachedViews = '{{ attachedViews }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
rules = '{{ rules }}'
WHERE 
resolverId = '{{ resolverId }}' --required
AND region = '{{ region }}' --required
AND If-Match = '{{ If-Match}}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since}}'
AND opc-request-id = '{{ opc-request-id}}'
AND scope = '{{ scope}}'
RETURNING
id,
attachedVcnId,
attachedViews,
compartmentId,
defaultViewId,
definedTags,
displayName,
endpoints,
freeformTags,
isProtected,
lifecycleState,
rules,
self,
timeCreated,
timeUpdated;

Lifecycle Methods​

Moves a resolver into a different compartment along with its protected default view and any endpoints.<br /><br />Zones in the default view are not moved. VCN-dedicated resolvers are initially created in the same compartment<br />as their corresponding VCN, but can then be moved to a different compartment.<br />

EXEC oci.dns.resolvers.change_compartment 
@resolverId='{{ resolverId }}' --required, 
@region='{{ region }}' --required, 
@If-Match='{{ If-Match }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@scope='{{ scope }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;