Skip to main content

views

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

Overview​

Nameviews
TypeResource
Idoci.dns.views

Fields​

The following fields are returned by SELECT queries:

A Response containing a single view object.

NameDatatypeDescription
idstringThe OCID of the view.
compartmentIdstringThe OCID of the owning compartment.
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 view. (x-default-description: This field will be set to a value in the format "dnsview<currentTimestampUTC>" where currentTimestampUTC<br />is in ISO 8601 basic format "yyyyMMddHHmmss".<br />)
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, DELETED, DELETING, UPDATING)
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
getselectviewId, regionIf-Modified-Since, If-None-Match, opc-request-id, scopeGets information about a specific view.<br /><br />Note that attempting to get a<br />view in the DELETED lifecycleState will result in a 404 response to be<br />consistent with other operations of the API.<br />
listselectcompartmentId, regionopc-request-id, displayName, id, page, limit, sortOrder, sortBy, lifecycleState, scopeGets a list of all views 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 views in the DELETED<br />lifecycleState to be consistent with other operations of the API.<br />
createinsertregion, compartmentIdopc-retry-token, opc-request-id, scopeCreates a new view in the specified compartment.<br />
updateupdateviewId, regionIf-Match, If-Unmodified-Since, opc-request-id, scopeUpdates the specified view with your new information.<br />
deletedeleteviewId, regionIf-Match, If-Unmodified-Since, opc-request-id, scopeDeletes the specified view.<br /><br />Note that attempting to delete a view in the DELETED lifecycleState will result in a 404<br />response to be consistent with other operations of the API. Views cannot be<br />deleted if they are referenced by non-deleted zones or resolvers.<br />Protected views cannot be deleted.<br />
change_compartmentexecviewId, region, compartmentIdIf-Match, opc-retry-token, opc-request-id, scopeMoves a view into a different compartment.<br /><br />To change the compartment of a protected view, change the compartment of its corresponding resolver.<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)
viewIdstringThe OCID of the target view.
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 views.
sortOrderstringThe order to sort the resources.

SELECT examples​

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

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
isProtected,
lifecycleState,
self,
timeCreated,
timeUpdated
FROM oci.dns.views
WHERE viewId = '{{ viewId }}' -- 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 }}'
;

INSERT examples​

Creates a new view in the specified compartment.<br />

INSERT INTO oci.dns.views (
compartmentId,
definedTags,
displayName,
freeformTags,
region,
opc-retry-token,
opc-request-id,
scope
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}',
'{{ scope }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
freeformTags,
isProtected,
lifecycleState,
self,
timeCreated,
timeUpdated
;

UPDATE examples​

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

UPDATE oci.dns.views
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
viewId = '{{ viewId }}' --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,
compartmentId,
definedTags,
displayName,
freeformTags,
isProtected,
lifecycleState,
self,
timeCreated,
timeUpdated;

DELETE examples​

Deletes the specified view.<br /><br />Note that attempting to delete a view in the DELETED lifecycleState will result in a 404<br />response to be consistent with other operations of the API. Views cannot be<br />deleted if they are referenced by non-deleted zones or resolvers.<br />Protected views cannot be deleted.<br />

DELETE FROM oci.dns.views
WHERE viewId = '{{ viewId }}' --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 }}'
;

Lifecycle Methods​

Moves a view into a different compartment.<br /><br />To change the compartment of a protected view, change the compartment of its corresponding resolver.<br />

EXEC oci.dns.views.change_compartment 
@viewId='{{ viewId }}' --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 }}"
}'
;