resolver_endpoints

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

Overview

Name	`resolver_endpoints`
Type	Resource
Id	`oci.dns.resolver_endpoints`

Fields

The following fields are returned by SELECT queries:

get
list

A Response containing a single resolver endpoint object.

Name	Datatype	Description
`name`	`string`	The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9]*$</code>)
`compartmentId`	`string`	The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.
`endpointType`	`string`	The type of resolver endpoint. VNIC is currently the only supported type. (VNIC) (default: VNIC)
`forwardingAddress`	`string`	An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.
`isForwarding`	`boolean`	A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
`isListening`	`boolean`	A Boolean flag indicating whether or not the resolver endpoint is for listening.
`lifecycleState`	`string`	The current state of the resource. (ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING)
`listeningAddress`	`string`	An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.
`self`	`string (url)`	The canonical absolute URL of the resource.
`timeCreated`	`string (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`
`timeUpdated`	`string (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`

An OCI DNS resolver endpoint. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Name	Datatype	Description
`name`	`string`	The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9]*$</code>)
`compartmentId`	`string`	The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.
`endpointType`	`string`	The type of resolver endpoint. VNIC is currently the only supported type. (VNIC) (default: VNIC)
`forwardingAddress`	`string`	An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.
`isForwarding`	`boolean`	A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
`isListening`	`boolean`	A Boolean flag indicating whether or not the resolver endpoint is for listening.
`lifecycleState`	`string`	The current state of the resource. (ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING)
`listeningAddress`	`string`	An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.
`self`	`string (url)`	The canonical absolute URL of the resource.
`timeCreated`	`string (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`
`timeUpdated`	`string (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:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`resolverId`, `resolverEndpointName`, `region`	`If-Modified-Since`, `If-None-Match`, `opc-request-id`, `scope`	Gets information about a specific resolver endpoint.<br /><br />Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result<br />in a `404` response to be consistent with other operations of the API.<br />
`list`	`select`	`resolverId`, `region`	`opc-request-id`, `name`, `page`, `limit`, `sortOrder`, `sortBy`, `lifecycleState`, `scope`	Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state.<br />It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState<br />query parameter is provided, the collection does not include resolver endpoints in the DELETED<br />lifecycle state to be consistent with other operations of the API.<br />
`create`	`insert`	`resolverId`, `region`, `name`, `isForwarding`, `isListening`	`opc-retry-token`, `opc-request-id`, `scope`	Creates a new resolver endpoint in the same compartment as the resolver.<br />
`update`	`update`	`resolverId`, `resolverEndpointName`, `region`	`If-Match`, `If-Unmodified-Since`, `opc-request-id`, `scope`	Updates the specified resolver endpoint with your new information.<br />
`delete`	`delete`	`resolverId`, `resolverEndpointName`, `region`	`If-Match`, `If-Unmodified-Since`, `opc-request-id`, `scope`	Deletes the specified resolver endpoint.<br /><br />Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in<br />a `404` response to be consistent with other operations of the API. Resolver endpoints may not<br />be deleted if they are referenced by a resolver rule.<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.

Name	Datatype	Description
`region`	`string`	OCI 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)
`resolverEndpointName`	`string`	The name of the target resolver endpoint.
`resolverId`	`string`	The OCID of the target resolver.
`If-Match`	`string`	The `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-Since`	`string`	The `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-Match`	`string`	The `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-Since`	`string`	The `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.
`lifecycleState`	`string`	The state of a resource.
`limit`	`integer (int64)`	The maximum number of items to return in a page of the collection.
`name`	`string`	The name of a resource.
`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.
`opc-retry-token`	`string`	A 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).
`page`	`string`	The value of the `opc-next-page` response header from the previous "List" call.
`scope`	`string`	Specifies to operate only on resources that have a matching DNS scope.
`sortBy`	`string`	The field by which to sort resolver endpoints.
`sortOrder`	`string`	The order to sort the resources.

`SELECT` examples

get
list

Gets information about a specific resolver endpoint. Note that attempting to get a resolver endpoint in the DELETED lifecycle state will result in a 404 response to be consistent with other operations of the API.

SELECT
name,
compartmentId,
endpointType,
forwardingAddress,
isForwarding,
isListening,
lifecycleState,
listeningAddress,
self,
timeCreated,
timeUpdated
FROM oci.dns.resolver_endpoints
WHERE resolverId = '{{ resolverId }}' -- required
AND resolverEndpointName = '{{ resolverEndpointName }}' -- 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 }}'
;

Gets a list of all endpoints within a resolver. The collection can be filtered by name or lifecycle state. It can be sorted on creation time or name both in ASC or DESC order. Note that when no lifecycleState query parameter is provided, the collection does not include resolver endpoints in the DELETED lifecycle state to be consistent with other operations of the API.

SELECT
name,
compartmentId,
endpointType,
forwardingAddress,
isForwarding,
isListening,
lifecycleState,
listeningAddress,
self,
timeCreated,
timeUpdated
FROM oci.dns.resolver_endpoints
WHERE resolverId = '{{ resolverId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND name = '{{ name }}'
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND lifecycleState = '{{ lifecycleState }}'
AND scope = '{{ scope }}'
;

`INSERT` examples

create
Manifest

Creates a new resolver endpoint in the same compartment as the resolver.

INSERT INTO oci.dns.resolver_endpoints (
endpointType,
forwardingAddress,
isForwarding,
isListening,
listeningAddress,
name,
resolverId,
region,
opc-retry-token,
opc-request-id,
scope
)
SELECT 
'{{ endpointType }}',
'{{ forwardingAddress }}',
{{ isForwarding }} /* required */,
{{ isListening }} /* required */,
'{{ listeningAddress }}',
'{{ name }}' /* required */,
'{{ resolverId }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}',
'{{ scope }}'
RETURNING
name,
compartmentId,
endpointType,
forwardingAddress,
isForwarding,
isListening,
lifecycleState,
listeningAddress,
self,
timeCreated,
timeUpdated
;

# Description fields are for documentation purposes
- name: resolver_endpoints
props:
  - name: resolverId
    value: "{{ resolverId }}"
    description: Required parameter for the resolver_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the resolver_endpoints resource.
  - name: endpointType
    value: "{{ endpointType }}"
    description: |
      The type of resolver endpoint. VNIC is currently the only supported type.
    valid_values: ['VNIC']
    default: VNIC
  - name: forwardingAddress
    value: "{{ forwardingAddress }}"
    description: |
      An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part
      of the subnet and will be assigned by the system if unspecified when isForwarding is true.
  - name: isForwarding
    value: {{ isForwarding }}
    description: |
      A Boolean flag indicating whether or not the resolver endpoint is for forwarding.
  - name: isListening
    value: {{ isListening }}
    description: |
      A Boolean flag indicating whether or not the resolver endpoint is for listening.
  - name: listeningAddress
    value: "{{ listeningAddress }}"
    description: |
      An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the
      subnet and will be assigned by the system if unspecified when isListening is true.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A 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). 
    description: A 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). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: scope
    value: "{{ scope }}"
    description: Specifies to operate only on resources that have a matching DNS scope. 
    description: Specifies to operate only on resources that have a matching DNS scope. 

`UPDATE` examples

update

Updates the specified resolver endpoint with your new information.

UPDATE oci.dns.resolver_endpoints
SET 
endpointType = '{{ endpointType }}'
WHERE 
resolverId = '{{ resolverId }}' --required
AND resolverEndpointName = '{{ resolverEndpointName }}' --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
name,
compartmentId,
endpointType,
forwardingAddress,
isForwarding,
isListening,
lifecycleState,
listeningAddress,
self,
timeCreated,
timeUpdated;

`DELETE` examples

delete

Deletes the specified resolver endpoint. Note that attempting to delete a resolver endpoint in the DELETED lifecycle state will result in a 404 response to be consistent with other operations of the API. Resolver endpoints may not be deleted if they are referenced by a resolver rule.

DELETE FROM oci.dns.resolver_endpoints
WHERE resolverId = '{{ resolverId }}' --required
AND resolverEndpointName = '{{ resolverEndpointName }}' --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 }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​