DNS Functions

Package: DBMS_CLOUD_OCI_DNS_DNS

CHANGE_RESOLVER_COMPARTMENT Function

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

Syntax

FUNCTION change_resolver_compartment (
  resolver_id varchar2,
  change_resolver_compartment_details dbms_cloud_oci_dns_change_resolver_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_change_resolver_compartment_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`change_resolver_compartment_details`	(required) Details for moving a resolver, along with its protected default view and endpoints, into a different compartment.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_STEERING_POLICY_COMPARTMENT Function

Moves a steering policy into a different compartment.

Syntax

FUNCTION change_steering_policy_compartment (
  steering_policy_id varchar2,
  change_steering_policy_compartment_details dbms_cloud_oci_dns_change_steering_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_change_steering_policy_compartment_response_t;

Parameters

Parameter	Description
`steering_policy_id`	(required) The OCID of the target steering policy.
`change_steering_policy_compartment_details`	(required) Details for moving a steering policy into a different compartment.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_TSIG_KEY_COMPARTMENT Function

Moves a TSIG key into a different compartment.

Syntax

FUNCTION change_tsig_key_compartment (
  tsig_key_id varchar2,
  change_tsig_key_compartment_details dbms_cloud_oci_dns_change_tsig_key_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_change_tsig_key_compartment_response_t;

Parameters

Parameter	Description
`tsig_key_id`	(required) The OCID of the target TSIG key.
`change_tsig_key_compartment_details`	(required) Details for moving a TSIG key into a different compartment.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VIEW_COMPARTMENT Function

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

Syntax

FUNCTION change_view_compartment (
  view_id varchar2,
  change_view_compartment_details dbms_cloud_oci_dns_change_view_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_change_view_compartment_response_t;

Parameters

Parameter	Description
`view_id`	(required) The OCID of the target view.
`change_view_compartment_details`	(required) Details for moving a view into a different compartment.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ZONE_COMPARTMENT Function

Moves a zone into a different compartment. Protected zones cannot have their compartment changed. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required. **Note:** All SteeringPolicyAttachment objects associated with this zone will also be moved into the provided compartment.

Syntax

FUNCTION change_zone_compartment (
  zone_id varchar2,
  change_zone_compartment_details dbms_cloud_oci_dns_change_zone_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_change_zone_compartment_response_t;

Parameters

Parameter	Description
`zone_id`	(required) The OCID of the target zone.
`change_zone_compartment_details`	(required) Details for moving a zone into a different compartment.
`if_match`	(optional) 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.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_RESOLVER_ENDPOINT Function

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

Syntax

FUNCTION create_resolver_endpoint (
  resolver_id varchar2,
  create_resolver_endpoint_details dbms_cloud_oci_dns_create_resolver_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_resolver_endpoint_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`create_resolver_endpoint_details`	(required) Details for creating a new resolver endpoint.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STEERING_POLICY Function

Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.

Syntax

FUNCTION create_steering_policy (
  create_steering_policy_details dbms_cloud_oci_dns_create_steering_policy_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_steering_policy_response_t;

Parameters

Parameter	Description
`create_steering_policy_details`	(required) Details for creating a new steering policy.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STEERING_POLICY_ATTACHMENT Function

Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain. For the purposes of access control, the attachment is automatically placed into the same compartment as the domain's zone.

Syntax

FUNCTION create_steering_policy_attachment (
  create_steering_policy_attachment_details dbms_cloud_oci_dns_create_steering_policy_attachment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_steering_policy_attachment_response_t;

Parameters

Parameter	Description
`create_steering_policy_attachment_details`	(required) Details for creating a new steering policy attachment.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TSIG_KEY Function

Creates a new TSIG key in the specified compartment. There is no `opc-retry-token` header since TSIG key names must be globally unique.

Syntax

FUNCTION create_tsig_key (
  create_tsig_key_details dbms_cloud_oci_dns_create_tsig_key_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_tsig_key_response_t;

Parameters

Parameter	Description
`create_tsig_key_details`	(required) Details for creating a new TSIG key.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VIEW Function

Creates a new view in the specified compartment.

Syntax

FUNCTION create_view (
  create_view_details dbms_cloud_oci_dns_create_view_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_view_response_t;

Parameters

Parameter	Description
`create_view_details`	(required) Details for creating a new view.
`opc_retry_token`	(optional) 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).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ZONE Function

Creates a new zone in the specified compartment. Private zones must have a zone type of `PRIMARY`. Creating a private zone at or under `oraclevcn.com` within the default protected view of a VCN-dedicated resolver is not permitted.

Syntax

FUNCTION create_zone (
  create_zone_details dbms_cloud_oci_dns_create_zone_base_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_zone_response_t;

Parameters

Parameter	Description
`create_zone_details`	(required) Details for creating a new zone.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ZONE_FROM_ZONE_FILE Function

Creates a new zone from a zone file in the specified compartment. Not supported for private zones.

Syntax

FUNCTION create_zone_from_zone_file (
  compartment_id varchar2,
  create_zone_from_zone_file_details blob,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_create_zone_from_zone_file_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`create_zone_from_zone_file_details`	(required) The zone file contents.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DOMAIN_RECORDS Function

Deletes all records at the specified zone and domain. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION delete_domain_records (
  zone_name_or_id varchar2,
  domain varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_domain_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RR_SET Function

Deletes all records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION delete_rr_set (
  zone_name_or_id varchar2,
  domain varchar2,
  rtype varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_rr_set_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`rtype`	(required) The type of the target RRSet within the target zone.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RESOLVER_ENDPOINT Function

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.

Syntax

FUNCTION delete_resolver_endpoint (
  resolver_id varchar2,
  resolver_endpoint_name varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_resolver_endpoint_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`resolver_endpoint_name`	(required) The name of the target resolver endpoint.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STEERING_POLICY Function

Deletes the specified steering policy. A `204` response indicates that the delete has been successful. Deletion will fail if the policy is attached to any zones. To detach a policy from a zone, see `DeleteSteeringPolicyAttachment`.

Syntax

FUNCTION delete_steering_policy (
  steering_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_steering_policy_response_t;

Parameters

Parameter	Description
`steering_policy_id`	(required) The OCID of the target steering policy.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STEERING_POLICY_ATTACHMENT Function

Deletes the specified steering policy attachment. A `204` response indicates that the delete has been successful.

Syntax

FUNCTION delete_steering_policy_attachment (
  steering_policy_attachment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_steering_policy_attachment_response_t;

Parameters

Parameter	Description
`steering_policy_attachment_id`	(required) The OCID of the target steering policy attachment.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TSIG_KEY Function

Deletes the specified TSIG key.

Syntax

FUNCTION delete_tsig_key (
  tsig_key_id varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_tsig_key_response_t;

Parameters

Parameter	Description
`tsig_key_id`	(required) The OCID of the target TSIG key.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VIEW Function

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

Syntax

FUNCTION delete_view (
  view_id varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_view_response_t;

Parameters

Parameter	Description
`view_id`	(required) The OCID of the target view.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ZONE Function

Deletes the specified zone and all its steering policy attachments. A `204` response indicates that the zone has been successfully deleted. Protected zones cannot be deleted. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION delete_zone (
  zone_name_or_id varchar2,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_delete_zone_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DOMAIN_RECORDS Function

Gets a list of all records at the specified zone and domain. The results are sorted by `rtype` in alphabetical order by default. You can optionally filter and/or sort the results using the listed parameters. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION get_domain_records (
  zone_name_or_id varchar2,
  domain varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  zone_version varchar2 DEFAULT NULL,
  rtype varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_domain_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`zone_version`	(optional) The version of the zone for which data is requested.
`rtype`	(optional) Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`sort_by`	(optional) The field by which to sort records. Allowed values are: 'rtype', 'ttl'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RR_SET Function

Gets a list of all records in the specified RRSet. The results are sorted by `recordHash` by default. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION get_rr_set (
  zone_name_or_id varchar2,
  domain varchar2,
  rtype varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  zone_version varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_rr_set_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`rtype`	(required) The type of the target RRSet within the target zone.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`zone_version`	(optional) The version of the zone for which data is requested.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RESOLVER Function

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

Syntax

FUNCTION get_resolver (
  resolver_id varchar2,
  if_modified_since varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_resolver_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`if_modified_since`	(optional) 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`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RESOLVER_ENDPOINT Function

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.

Syntax

FUNCTION get_resolver_endpoint (
  resolver_id varchar2,
  resolver_endpoint_name varchar2,
  if_modified_since varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_resolver_endpoint_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`resolver_endpoint_name`	(required) The name of the target resolver endpoint.
`if_modified_since`	(optional) 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`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STEERING_POLICY Function

Gets information about the specified steering policy.

Syntax

FUNCTION get_steering_policy (
  steering_policy_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_steering_policy_response_t;

Parameters

Parameter	Description
`steering_policy_id`	(required) The OCID of the target steering policy.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STEERING_POLICY_ATTACHMENT Function

Gets information about the specified steering policy attachment.

Syntax

FUNCTION get_steering_policy_attachment (
  steering_policy_attachment_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_steering_policy_attachment_response_t;

Parameters

Parameter	Description
`steering_policy_attachment_id`	(required) The OCID of the target steering policy attachment.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TSIG_KEY Function

Gets information about the specified TSIG key.

Syntax

FUNCTION get_tsig_key (
  tsig_key_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_tsig_key_response_t;

Parameters

Parameter	Description
`tsig_key_id`	(required) The OCID of the target TSIG key.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VIEW Function

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

Syntax

FUNCTION get_view (
  view_id varchar2,
  if_modified_since varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_view_response_t;

Parameters

Parameter	Description
`view_id`	(required) The OCID of the target view.
`if_modified_since`	(optional) 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`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ZONE Function

Gets information about the specified zone, including its creation date, zone type, and serial. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION get_zone (
  zone_name_or_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_zone_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ZONE_CONTENT Function

Gets the requested zone's zone file.

Syntax

FUNCTION get_zone_content (
  zone_name_or_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_zone_content_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ZONE_RECORDS Function

Gets all records in the specified zone. The results are sorted by `domain` in alphabetical order by default. For more information about records, see Resource Record (RR) TYPEs. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION get_zone_records (
  zone_name_or_id varchar2,
  if_none_match varchar2 DEFAULT NULL,
  if_modified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  zone_version varchar2 DEFAULT NULL,
  domain varchar2 DEFAULT NULL,
  domain_contains varchar2 DEFAULT NULL,
  rtype varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_get_zone_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`if_none_match`	(optional) 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_modified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`zone_version`	(optional) The version of the zone for which data is requested.
`domain`	(optional) Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
`domain_contains`	(optional) Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
`rtype`	(optional) Search by record type. Will match any record whose type (case-insensitive) equals the provided value.
`sort_by`	(optional) The field by which to sort records. Allowed values are: 'domain', 'rtype', 'ttl'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RESOLVER_ENDPOINTS Function

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.

Syntax

FUNCTION list_resolver_endpoints (
  resolver_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_resolver_endpoints_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`name`	(optional) The name of a resource.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field by which to sort resolver endpoints. Allowed values are: 'name', 'timeCreated'
`lifecycle_state`	(optional) The state of a resource.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RESOLVERS Function

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

Syntax

FUNCTION list_resolvers (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_resolvers_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) The displayName of a resource.
`id`	(optional) The OCID of a resource.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field by which to sort resolvers. Allowed values are: 'displayName', 'timeCreated'
`lifecycle_state`	(optional) The state of a resource.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STEERING_POLICIES Function

Gets a list of all steering policies in the specified compartment.

Syntax

FUNCTION list_steering_policies (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  health_check_monitor_id varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  template varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_steering_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`id`	(optional) The OCID of a resource.
`display_name`	(optional) The displayName of a resource.
`display_name_contains`	(optional) The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
`health_check_monitor_id`	(optional) Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
`time_created_greater_than_or_equal_to`	(optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
`time_created_less_than`	(optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time.
`template`	(optional) Search by steering template type. Will match any resource whose template type matches the provided value.
`lifecycle_state`	(optional) The state of a resource.
`sort_by`	(optional) The field by which to sort steering policies. If unspecified, defaults to `timeCreated`. Allowed values are: 'displayName', 'timeCreated', 'template'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STEERING_POLICY_ATTACHMENTS Function

Lists the steering policy attachments in the specified compartment.

Syntax

FUNCTION list_steering_policy_attachments (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  steering_policy_id varchar2 DEFAULT NULL,
  zone_id varchar2 DEFAULT NULL,
  domain varchar2 DEFAULT NULL,
  domain_contains varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_steering_policy_attachments_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`id`	(optional) The OCID of a resource.
`display_name`	(optional) The displayName of a resource.
`steering_policy_id`	(optional) Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value.
`zone_id`	(optional) Search by zone OCID. Will match any resource whose zone ID matches the provided value.
`domain`	(optional) Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
`domain_contains`	(optional) Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
`time_created_greater_than_or_equal_to`	(optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
`time_created_less_than`	(optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time.
`lifecycle_state`	(optional) The state of a resource.
`sort_by`	(optional) The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. Allowed values are: 'displayName', 'timeCreated', 'domainName'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TSIG_KEYS Function

Gets a list of all TSIG keys in the specified compartment.

Syntax

FUNCTION list_tsig_keys (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_tsig_keys_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`id`	(optional) The OCID of a resource.
`name`	(optional) The name of a resource.
`lifecycle_state`	(optional) The state of a resource.
`sort_by`	(optional) The field by which to sort TSIG keys. If unspecified, defaults to `timeCreated`. Allowed values are: 'name', 'timeCreated'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VIEWS Function

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

Syntax

FUNCTION list_views (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_views_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) The displayName of a resource.
`id`	(optional) The OCID of a resource.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field by which to sort views. Allowed values are: 'displayName', 'timeCreated'
`lifecycle_state`	(optional) The state of a resource.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ZONE_TRANSFER_SERVERS Function

Gets a list of IP addresses of OCI nameservers for inbound and outbound transfer of zones in the specified compartment (which must be the root compartment of a tenancy) that transfer zone data with external master or downstream nameservers.

Syntax

FUNCTION list_zone_transfer_servers (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_zone_transfer_servers_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ZONES Function

Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, scope, associated view, and zone type. Filtering by view is only supported for private zones.

Syntax

FUNCTION list_zones (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  zone_type varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  time_created_less_than timestamp with time zone DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  tsig_key_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_list_zones_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment the resource belongs to.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a page of the collection.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`name`	(optional) A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value.
`name_contains`	(optional) Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value.
`zone_type`	(optional) Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value. Allowed values are: 'PRIMARY', 'SECONDARY'
`time_created_greater_than_or_equal_to`	(optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
`time_created_less_than`	(optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time.
`lifecycle_state`	(optional) The state of a resource. Allowed values are: 'ACTIVE', 'CREATING', 'DELETED', 'DELETING', 'FAILED', 'UPDATING'
`sort_by`	(optional) The field by which to sort zones. Allowed values are: 'name', 'zoneType', 'timeCreated'
`sort_order`	(optional) The order to sort the resources. Allowed values are: 'ASC', 'DESC'
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`tsig_key_id`	(optional) Search for zones that are associated with a TSIG key.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_DOMAIN_RECORDS Function

Updates records in the specified zone at a domain. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION patch_domain_records (
  zone_name_or_id varchar2,
  domain varchar2,
  patch_domain_records_details dbms_cloud_oci_dns_patch_domain_records_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_patch_domain_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`patch_domain_records_details`	(required) Operations describing how to modify the collection of records.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_RR_SET Function

Updates records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION patch_rr_set (
  zone_name_or_id varchar2,
  domain varchar2,
  rtype varchar2,
  patch_rr_set_details dbms_cloud_oci_dns_patch_rr_set_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_patch_rr_set_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`rtype`	(required) The type of the target RRSet within the target zone.
`patch_rr_set_details`	(required) Operations describing how to modify the collection of records.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PATCH_ZONE_RECORDS Function

Updates a collection of records in the specified zone. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION patch_zone_records (
  zone_name_or_id varchar2,
  patch_zone_records_details dbms_cloud_oci_dns_patch_zone_records_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_patch_zone_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`patch_zone_records_details`	(required) The operations describing how to modify the collection of records.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DOMAIN_RECORDS Function

Replaces records in the specified zone at a domain with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION update_domain_records (
  zone_name_or_id varchar2,
  domain varchar2,
  update_domain_records_details dbms_cloud_oci_dns_update_domain_records_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_domain_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`update_domain_records_details`	(required) A full list of records for the domain.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RR_SET Function

Replaces records in the specified RRSet. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION update_rr_set (
  zone_name_or_id varchar2,
  domain varchar2,
  rtype varchar2,
  update_rr_set_details dbms_cloud_oci_dns_update_rr_set_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_rr_set_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`domain`	(required) The target fully-qualified domain name (FQDN) within the target zone.
`rtype`	(required) The type of the target RRSet within the target zone.
`update_rr_set_details`	(required) A full list of records for the RRSet.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RESOLVER Function

Updates the specified resolver with your new information.

Syntax

FUNCTION update_resolver (
  resolver_id varchar2,
  update_resolver_details dbms_cloud_oci_dns_update_resolver_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_resolver_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`update_resolver_details`	(required) New data for the resolver.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RESOLVER_ENDPOINT Function

Updates the specified resolver endpoint with your new information.

Syntax

FUNCTION update_resolver_endpoint (
  resolver_id varchar2,
  resolver_endpoint_name varchar2,
  update_resolver_endpoint_details dbms_cloud_oci_dns_update_resolver_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_resolver_endpoint_response_t;

Parameters

Parameter	Description
`resolver_id`	(required) The OCID of the target resolver.
`resolver_endpoint_name`	(required) The name of the target resolver endpoint.
`update_resolver_endpoint_details`	(required) New data for the resolver endpoint.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_STEERING_POLICY Function

Updates the configuration of the specified steering policy.

Syntax

FUNCTION update_steering_policy (
  steering_policy_id varchar2,
  update_steering_policy_details dbms_cloud_oci_dns_update_steering_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_steering_policy_response_t;

Parameters

Parameter	Description
`steering_policy_id`	(required) The OCID of the target steering policy.
`update_steering_policy_details`	(required) New data for the steering policy.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_STEERING_POLICY_ATTACHMENT Function

Updates the specified steering policy attachment with your new information.

Syntax

FUNCTION update_steering_policy_attachment (
  steering_policy_attachment_id varchar2,
  update_steering_policy_attachment_details dbms_cloud_oci_dns_update_steering_policy_attachment_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_steering_policy_attachment_response_t;

Parameters

Parameter	Description
`steering_policy_attachment_id`	(required) The OCID of the target steering policy attachment.
`update_steering_policy_attachment_details`	(required) New data for the steering policy attachment.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TSIG_KEY Function

Updates the specified TSIG key.

Syntax

FUNCTION update_tsig_key (
  tsig_key_id varchar2,
  update_tsig_key_details dbms_cloud_oci_dns_update_tsig_key_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_tsig_key_response_t;

Parameters

Parameter	Description
`tsig_key_id`	(required) The OCID of the target TSIG key.
`update_tsig_key_details`	(required) New data for the TSIG key.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VIEW Function

Updates the specified view with your new information.

Syntax

FUNCTION update_view (
  view_id varchar2,
  update_view_details dbms_cloud_oci_dns_update_view_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_view_response_t;

Parameters

Parameter	Description
`view_id`	(required) The OCID of the target view.
`update_view_details`	(required) New data for the view.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ZONE Function

Updates the zone with the specified information. Global secondary zones may have their external masters updated. For more information about secondary zones, see Manage DNS Service Zone. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION update_zone (
  zone_name_or_id varchar2,
  update_zone_details dbms_cloud_oci_dns_update_zone_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_zone_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`update_zone_details`	(required) New data for the zone.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ZONE_RECORDS Function

Replaces records in the specified zone with the records specified in the request body. If a specified record does not exist, it will be created. If the record exists, then it will be updated to represent the record in the body of the request. If a record in the zone does not exist in the request body, the record will be removed from the zone. When the zone name is provided as a path parameter and `PRIVATE` is used for the scope query parameter then the viewId query parameter is required.

Syntax

FUNCTION update_zone_records (
  zone_name_or_id varchar2,
  update_zone_records_details dbms_cloud_oci_dns_update_zone_records_details_t,
  if_match varchar2 DEFAULT NULL,
  if_unmodified_since varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  scope varchar2 DEFAULT NULL,
  view_id varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dns_dns_update_zone_records_response_t;

Parameters

Parameter	Description
`zone_name_or_id`	(required) The name or OCID of the target zone.
`update_zone_records_details`	(required) A full list of records for the zone.
`if_match`	(optional) 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_unmodified_since`	(optional) 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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`scope`	(optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: 'GLOBAL', 'PRIVATE'
`view_id`	(optional) The OCID of the view the resource is associated with.
`compartment_id`	(optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dns.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_RESOLVER_COMPARTMENT Function 🔗

CHANGE_STEERING_POLICY_COMPARTMENT Function 🔗

CHANGE_TSIG_KEY_COMPARTMENT Function 🔗

CHANGE_VIEW_COMPARTMENT Function 🔗

CHANGE_ZONE_COMPARTMENT Function 🔗

CREATE_RESOLVER_ENDPOINT Function 🔗

CREATE_STEERING_POLICY Function 🔗

CREATE_STEERING_POLICY_ATTACHMENT Function 🔗

CREATE_TSIG_KEY Function 🔗

CREATE_VIEW Function 🔗

CREATE_ZONE Function 🔗

CREATE_ZONE_FROM_ZONE_FILE Function 🔗

DELETE_DOMAIN_RECORDS Function 🔗

DELETE_RR_SET Function 🔗

DELETE_RESOLVER_ENDPOINT Function 🔗

DELETE_STEERING_POLICY Function 🔗

DELETE_STEERING_POLICY_ATTACHMENT Function 🔗

DELETE_TSIG_KEY Function 🔗

DELETE_VIEW Function 🔗

DELETE_ZONE Function 🔗

GET_DOMAIN_RECORDS Function 🔗

GET_RR_SET Function 🔗

GET_RESOLVER Function 🔗

GET_RESOLVER_ENDPOINT Function 🔗

GET_STEERING_POLICY Function 🔗

GET_STEERING_POLICY_ATTACHMENT Function 🔗

GET_TSIG_KEY Function 🔗

GET_VIEW Function 🔗

GET_ZONE Function 🔗

GET_ZONE_CONTENT Function 🔗

GET_ZONE_RECORDS Function 🔗

LIST_RESOLVER_ENDPOINTS Function 🔗

LIST_RESOLVERS Function 🔗

LIST_STEERING_POLICIES Function 🔗

LIST_STEERING_POLICY_ATTACHMENTS Function 🔗

LIST_TSIG_KEYS Function 🔗

LIST_VIEWS Function 🔗

LIST_ZONE_TRANSFER_SERVERS Function 🔗

LIST_ZONES Function 🔗

PATCH_DOMAIN_RECORDS Function 🔗

PATCH_RR_SET Function 🔗

PATCH_ZONE_RECORDS Function 🔗

UPDATE_DOMAIN_RECORDS Function 🔗

UPDATE_RR_SET Function 🔗

UPDATE_RESOLVER Function 🔗

UPDATE_RESOLVER_ENDPOINT Function 🔗

UPDATE_STEERING_POLICY Function 🔗

UPDATE_STEERING_POLICY_ATTACHMENT Function 🔗

UPDATE_TSIG_KEY Function 🔗

UPDATE_VIEW Function 🔗

UPDATE_ZONE Function 🔗

UPDATE_ZONE_RECORDS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_RESOLVER_COMPARTMENT Function

CHANGE_STEERING_POLICY_COMPARTMENT Function

CHANGE_TSIG_KEY_COMPARTMENT Function

CHANGE_VIEW_COMPARTMENT Function

CHANGE_ZONE_COMPARTMENT Function

CREATE_RESOLVER_ENDPOINT Function

CREATE_STEERING_POLICY Function

CREATE_STEERING_POLICY_ATTACHMENT Function

CREATE_TSIG_KEY Function

CREATE_VIEW Function

CREATE_ZONE Function

CREATE_ZONE_FROM_ZONE_FILE Function

DELETE_DOMAIN_RECORDS Function

DELETE_RR_SET Function

DELETE_RESOLVER_ENDPOINT Function

DELETE_STEERING_POLICY Function

DELETE_STEERING_POLICY_ATTACHMENT Function

DELETE_TSIG_KEY Function

DELETE_VIEW Function

DELETE_ZONE Function

GET_DOMAIN_RECORDS Function

GET_RR_SET Function

GET_RESOLVER Function

GET_RESOLVER_ENDPOINT Function

GET_STEERING_POLICY Function

GET_STEERING_POLICY_ATTACHMENT Function

GET_TSIG_KEY Function

GET_VIEW Function

GET_ZONE Function

GET_ZONE_CONTENT Function

GET_ZONE_RECORDS Function

LIST_RESOLVER_ENDPOINTS Function

LIST_RESOLVERS Function

LIST_STEERING_POLICIES Function

LIST_STEERING_POLICY_ATTACHMENTS Function

LIST_TSIG_KEYS Function

LIST_VIEWS Function

LIST_ZONE_TRANSFER_SERVERS Function

LIST_ZONES Function

PATCH_DOMAIN_RECORDS Function

PATCH_RR_SET Function

PATCH_ZONE_RECORDS Function

UPDATE_DOMAIN_RECORDS Function

UPDATE_RR_SET Function

UPDATE_RESOLVER Function

UPDATE_RESOLVER_ENDPOINT Function

UPDATE_STEERING_POLICY Function

UPDATE_STEERING_POLICY_ATTACHMENT Function

UPDATE_TSIG_KEY Function

UPDATE_VIEW Function

UPDATE_ZONE Function

UPDATE_ZONE_RECORDS Function