DnsClient¶

class oci.dns.DnsClient(config, **kwargs)¶

API for the DNS service. Use this API to manage DNS zones, records, and other DNS resources. For more information, see [Overview of the DNS Service](/iaas/Content/DNS/Concepts/dnszonemanagement.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_resolver_compartment`(resolver_id, …)	Moves a resolver into a different compartment along with its protected default view and any endpoints.
`change_steering_policy_compartment`(…)	Moves a steering policy into a different compartment.
`change_tsig_key_compartment`(tsig_key_id, …)	Moves a TSIG key into a different compartment.
`change_view_compartment`(view_id, …)	Moves a view into a different compartment.
`change_zone_compartment`(zone_id, …)	Moves a zone into a different compartment.
`create_resolver_endpoint`(resolver_id, …)	Creates a new resolver endpoint in the same compartment as the resolver.
`create_steering_policy`(…)	Creates a new steering policy in the specified compartment.
`create_steering_policy_attachment`(…)	Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain.
`create_tsig_key`(create_tsig_key_details, …)	Creates a new TSIG key in the specified compartment.
`create_view`(create_view_details, **kwargs)	Creates a new view in the specified compartment.
`create_zone`(create_zone_details, **kwargs)	Creates a new zone in the specified compartment.
`create_zone_from_zone_file`(compartment_id, …)	Creates a new zone from a zone file in the specified compartment.
`delete_domain_records`(zone_name_or_id, …)	Deletes all records at the specified zone and domain.
`delete_resolver_endpoint`(resolver_id, …)	Deletes the specified resolver endpoint.
`delete_rr_set`(zone_name_or_id, domain, …)	Deletes all records in the specified RRSet.
`delete_steering_policy`(steering_policy_id, …)	Deletes the specified steering policy.
`delete_steering_policy_attachment`(…)	Deletes the specified steering policy attachment.
`delete_tsig_key`(tsig_key_id, **kwargs)	Deletes the specified TSIG key.
`delete_view`(view_id, **kwargs)	Deletes the specified view.
`delete_zone`(zone_name_or_id, **kwargs)	Deletes the specified zone and all its steering policy attachments.
`get_domain_records`(zone_name_or_id, domain, …)	Gets a list of all records at the specified zone and domain.
`get_resolver`(resolver_id, **kwargs)	Gets information about a specific resolver.
`get_resolver_endpoint`(resolver_id, …)	Gets information about a specific resolver endpoint.
`get_rr_set`(zone_name_or_id, domain, rtype, …)	Gets a list of all records in the specified RRSet.
`get_steering_policy`(steering_policy_id, **kwargs)	Gets information about the specified steering policy.
`get_steering_policy_attachment`(…)	Gets information about the specified steering policy attachment.
`get_tsig_key`(tsig_key_id, **kwargs)	Gets information about the specified TSIG key.
`get_view`(view_id, **kwargs)	Gets information about a specific view.
`get_zone`(zone_name_or_id, **kwargs)	Gets information about the specified zone, including its creation date, zone type, and serial.
`get_zone_content`(zone_name_or_id, **kwargs)	Gets the requested zone’s zone file.
`get_zone_records`(zone_name_or_id, **kwargs)	Gets all records in the specified zone.
`list_resolver_endpoints`(resolver_id, **kwargs)	Gets a list of all endpoints within a resolver.
`list_resolvers`(compartment_id, **kwargs)	Gets a list of all resolvers within a compartment.
`list_steering_policies`(compartment_id, **kwargs)	Gets a list of all steering policies in the specified compartment.
`list_steering_policy_attachments`(…)	Lists the steering policy attachments in the specified compartment.
`list_tsig_keys`(compartment_id, **kwargs)	Gets a list of all TSIG keys in the specified compartment.
`list_views`(compartment_id, **kwargs)	Gets a list of all views within a compartment.
`list_zone_transfer_servers`(compartment_id, …)	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.
`list_zones`(compartment_id, **kwargs)	Gets a list of all zones in the specified compartment.
`patch_domain_records`(zone_name_or_id, …)	Updates records in the specified zone at a domain.
`patch_rr_set`(zone_name_or_id, domain, rtype, …)	Updates records in the specified RRSet.
`patch_zone_records`(zone_name_or_id, …)	Updates a collection of records in the specified zone.
`promote_zone_dnssec_key_version`(zone_id, …)	Promotes a specified DnssecKeyVersion on the zone.
`stage_zone_dnssec_key_version`(zone_id, …)	Stages a new DnssecKeyVersion on the zone.
`update_domain_records`(zone_name_or_id, …)	Replaces records in the specified zone at a domain with the records specified in the request body.
`update_resolver`(resolver_id, …)	Updates the specified resolver with your new information.
`update_resolver_endpoint`(resolver_id, …)	Updates the specified resolver endpoint with your new information.
`update_rr_set`(zone_name_or_id, domain, …)	Replaces records in the specified RRSet.
`update_steering_policy`(steering_policy_id, …)	Updates the configuration of the specified steering policy.
`update_steering_policy_attachment`(…)	Updates the specified steering policy attachment with your new information.
`update_tsig_key`(tsig_key_id, …)	Updates the specified TSIG key.
`update_view`(view_id, update_view_details, …)	Updates the specified view with your new information.
`update_zone`(zone_name_or_id, …)	Updates the zone with the specified information.
`update_zone_records`(zone_name_or_id, …)	Replaces records in the specified zone with the records specified in the request body.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_resolver_compartment(resolver_id, change_resolver_compartment_details, **kwargs)¶

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.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. change_resolver_compartment_details (oci.dns.models.ChangeResolverCompartmentDetails) – (required) Details for moving a resolver, along with its protected default view and endpoints, into a different compartment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_resolver_compartment API.

change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, **kwargs)¶

Moves a steering policy into a different compartment.

Parameters:	steering_policy_id (str) – (required) The OCID of the target steering policy. change_steering_policy_compartment_details (oci.dns.models.ChangeSteeringPolicyCompartmentDetails) – (required) Details for moving a steering policy into a different compartment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_steering_policy_compartment API.

change_tsig_key_compartment(tsig_key_id, change_tsig_key_compartment_details, **kwargs)¶

Moves a TSIG key into a different compartment.

Parameters:	tsig_key_id (str) – (required) The OCID of the target TSIG key. change_tsig_key_compartment_details (oci.dns.models.ChangeTsigKeyCompartmentDetails) – (required) Details for moving a TSIG key into a different compartment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_tsig_key_compartment API.

change_view_compartment(view_id, change_view_compartment_details, **kwargs)¶

Moves a view into a different compartment.

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

Parameters:	view_id (str) – (required) The OCID of the target view. change_view_compartment_details (oci.dns.models.ChangeViewCompartmentDetails) – (required) Details for moving a view into a different compartment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_view_compartment API.

change_zone_compartment(zone_id, change_zone_compartment_details, **kwargs)¶

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.

Parameters:	zone_id (str) – (required) The OCID of the target zone. change_zone_compartment_details (oci.dns.models.ChangeZoneCompartmentDetails) – (required) Details for moving a zone into a different compartment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_zone_compartment API.

create_resolver_endpoint(resolver_id, create_resolver_endpoint_details, **kwargs)¶

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

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. create_resolver_endpoint_details (oci.dns.models.CreateResolverEndpointDetails) – (required) Details for creating a new resolver endpoint. opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ResolverEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use create_resolver_endpoint API.

create_steering_policy(create_steering_policy_details, **kwargs)¶

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

Parameters:	create_steering_policy_details (oci.dns.models.CreateSteeringPolicyDetails) – (required) Details for creating a new steering policy. opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use create_steering_policy API.

create_steering_policy_attachment(create_steering_policy_attachment_details, **kwargs)¶

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.

Parameters:	create_steering_policy_attachment_details (oci.dns.models.CreateSteeringPolicyAttachmentDetails) – (required) Details for creating a new steering policy attachment. opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicyAttachment`
Return type:	`Response`
Example:

Click here to see an example of how to use create_steering_policy_attachment API.

create_tsig_key(create_tsig_key_details, **kwargs)¶

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

Parameters:	create_tsig_key_details (oci.dns.models.CreateTsigKeyDetails) – (required) Details for creating a new TSIG key. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TsigKey`
Return type:	`Response`
Example:

Click here to see an example of how to use create_tsig_key API.

create_view(create_view_details, **kwargs)¶

Creates a new view in the specified compartment.

Parameters:	create_view_details (oci.dns.models.CreateViewDetails) – (required) Details for creating a new view. opc_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `View`
Return type:	`Response`
Example:

Click here to see an example of how to use create_view API.

create_zone(create_zone_details, **kwargs)¶

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.

Parameters:	create_zone_details (oci.dns.models.CreateZoneBaseDetails) – (required) Details for creating a new zone. opc_request_id (str) – (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 (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the resource is associated with. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Zone`
Return type:	`Response`
Example:

Click here to see an example of how to use create_zone API.

create_zone_from_zone_file(compartment_id, create_zone_from_zone_file_details, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. create_zone_from_zone_file_details (stream) – (required) The zone file contents. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the resource is associated with. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings buffer_limit (int) – (optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown. The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.
Returns:	A `Response` object with data of type `Zone`
Return type:	`Response`
Example:

Click here to see an example of how to use create_zone_from_zone_file API.

delete_domain_records(zone_name_or_id, domain, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_domain_records API.

delete_resolver_endpoint(resolver_id, resolver_endpoint_name, **kwargs)¶

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.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. resolver_endpoint_name (str) – (required) The name of the target resolver endpoint. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_resolver_endpoint API.

delete_rr_set(zone_name_or_id, domain, rtype, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. rtype (str) – (required) The type of the target RRSet within the target zone. if_match (str) – (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* (str) – (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 (str) – (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 (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_rr_set API.

delete_steering_policy(steering_policy_id, **kwargs)¶

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.

Parameters:	steering_policy_id (str) – (required) The OCID of the target steering policy. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_steering_policy API.

delete_steering_policy_attachment(steering_policy_attachment_id, **kwargs)¶

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

Parameters:	steering_policy_attachment_id (str) – (required) The OCID of the target steering policy attachment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_steering_policy_attachment API.

delete_tsig_key(tsig_key_id, **kwargs)¶

Deletes the specified TSIG key.

Parameters:	tsig_key_id (str) – (required) The OCID of the target TSIG key. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_tsig_key API.

delete_view(view_id, **kwargs)¶

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.

Parameters:	view_id (str) – (required) The OCID of the target view. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_view API.

delete_zone(zone_name_or_id, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_zone API.

get_domain_records(zone_name_or_id, domain, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. zone_version (str) – (optional) The version of the zone for which data is requested. rtype (str) – (optional) Search by record type. Will match any record whose type (case-insensitive) equals the provided value. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. sort_by (str) – (optional) The field by which to sort records. Allowed values are: “rtype”, “ttl” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_domain_records API.

get_resolver(resolver_id, **kwargs)¶

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.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. if_modified_since (str) – (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 (str) – (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* (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Resolver`
Return type:	`Response`
Example:

Click here to see an example of how to use get_resolver API.

get_resolver_endpoint(resolver_id, resolver_endpoint_name, **kwargs)¶

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.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. resolver_endpoint_name (str) – (required) The name of the target resolver endpoint. if_modified_since (str) – (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 (str) – (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* (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ResolverEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use get_resolver_endpoint API.

get_rr_set(zone_name_or_id, domain, rtype, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. rtype (str) – (required) The type of the target RRSet within the target zone. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. zone_version (str) – (optional) The version of the zone for which data is requested. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RRSet`
Return type:	`Response`
Example:

Click here to see an example of how to use get_rr_set API.

get_steering_policy(steering_policy_id, **kwargs)¶

Gets information about the specified steering policy.

Parameters:	steering_policy_id (str) – (required) The OCID of the target steering policy. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use get_steering_policy API.

get_steering_policy_attachment(steering_policy_attachment_id, **kwargs)¶

Gets information about the specified steering policy attachment.

Parameters:	steering_policy_attachment_id (str) – (required) The OCID of the target steering policy attachment. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicyAttachment`
Return type:	`Response`
Example:

Click here to see an example of how to use get_steering_policy_attachment API.

get_tsig_key(tsig_key_id, **kwargs)¶

Gets information about the specified TSIG key.

Parameters:	tsig_key_id (str) – (required) The OCID of the target TSIG key. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TsigKey`
Return type:	`Response`
Example:

Click here to see an example of how to use get_tsig_key API.

get_view(view_id, **kwargs)¶

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.

Parameters:	view_id (str) – (required) The OCID of the target view. if_modified_since (str) – (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 (str) – (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* (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `View`
Return type:	`Response`
Example:

Click here to see an example of how to use get_view API.

get_zone(zone_name_or_id, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Zone`
Return type:	`Response`
Example:

Click here to see an example of how to use get_zone API.

get_zone_content(zone_name_or_id, **kwargs)¶

Gets the requested zone’s zone file.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_zone_content API.

get_zone_records(zone_name_or_id, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. if_none_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. zone_version (str) – (optional) The version of the zone for which data is requested. domain (str) – (optional) Search by domain. Will match any record whose domain (case-insensitive) equals the provided value. domain_contains (str) – (optional) Search by domain. Will match any record whose domain (case-insensitive) contains the provided value. rtype (str) – (optional) Search by record type. Will match any record whose type (case-insensitive) equals the provided value. sort_by (str) – (optional) The field by which to sort records. Allowed values are: “domain”, “rtype”, “ttl” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_zone_records API.

list_resolver_endpoints(resolver_id, **kwargs)¶

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.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. name (str) – (optional) The name of a resource. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. limit (int) – (optional) The maximum number of items to return in a page of the collection. sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field by which to sort resolver endpoints. Allowed values are: “name”, “timeCreated” lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ResolverEndpointSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_resolver_endpoints API.

list_resolvers(compartment_id, **kwargs)¶

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.

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (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 (str) – (optional) The displayName of a resource. id (str) – (optional) The OCID of a resource. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. limit (int) – (optional) The maximum number of items to return in a page of the collection. sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field by which to sort resolvers. Allowed values are: “displayName”, “timeCreated” lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ResolverSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_resolvers API.

list_steering_policies(compartment_id, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. id (str) – (optional) The OCID of a resource. display_name (str) – (optional) The displayName of a resource. display_name_contains (str) – (optional) The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value. health_check_monitor_id (str) – (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 (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time. time_created_less_than (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time. template (str) – (optional) Search by steering template type. Will match any resource whose template type matches the provided value. lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING” sort_by (str) – (optional) The field by which to sort steering policies. If unspecified, defaults to timeCreated. Allowed values are: “displayName”, “timeCreated”, “template” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SteeringPolicySummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_steering_policies API.

list_steering_policy_attachments(compartment_id, **kwargs)¶

Lists the steering policy attachments in the specified compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. id (str) – (optional) The OCID of a resource. display_name (str) – (optional) The displayName of a resource. steering_policy_id (str) – (optional) Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value. zone_id (str) – (optional) Search by zone OCID. Will match any resource whose zone ID matches the provided value. domain (str) – (optional) Search by domain. Will match any record whose domain (case-insensitive) equals the provided value. domain_contains (str) – (optional) Search by domain. Will match any record whose domain (case-insensitive) contains the provided value. time_created_greater_than_or_equal_to (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time. time_created_less_than (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time. lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “CREATING”, “ACTIVE”, “DELETING” sort_by (str) – (optional) The field by which to sort steering policy attachments. If unspecified, defaults to timeCreated. Allowed values are: “displayName”, “timeCreated”, “domainName” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SteeringPolicyAttachmentSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_steering_policy_attachments API.

list_tsig_keys(compartment_id, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. id (str) – (optional) The OCID of a resource. name (str) – (optional) The name of a resource. lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING” sort_by (str) – (optional) The field by which to sort TSIG keys. If unspecified, defaults to timeCreated. Allowed values are: “name”, “timeCreated” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `TsigKeySummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_tsig_keys API.

list_views(compartment_id, **kwargs)¶

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.

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (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 (str) – (optional) The displayName of a resource. id (str) – (optional) The OCID of a resource. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. limit (int) – (optional) The maximum number of items to return in a page of the collection. sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field by which to sort views. Allowed values are: “displayName”, “timeCreated” lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “DELETED”, “DELETING”, “UPDATING” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ViewSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_views API.

list_zone_transfer_servers(compartment_id, **kwargs)¶

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.

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ZoneTransferServer`
Return type:	`Response`
Example:

Click here to see an example of how to use list_zone_transfer_servers API.

list_zones(compartment_id, **kwargs)¶

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.

Parameters:	compartment_id (str) – (required) The OCID of the compartment the resource belongs to. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) The maximum number of items to return in a page of the collection. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. name (str) – (optional) A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value. name_contains (str) – (optional) Search by zone name. Will match any zone whose name (case-insensitive) contains the provided value. zone_type (str) – (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 (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created on or after the indicated time. time_created_less_than (datetime) – (optional) An RFC 3339 timestamp that states all returned resources were created before the indicated time. lifecycle_state (str) – (optional) The state of a resource. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING” sort_by (str) – (optional) The field by which to sort zones. Allowed values are: “name”, “zoneType”, “timeCreated” sort_order (str) – (optional) The order to sort the resources. Allowed values are: “ASC”, “DESC” scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the resource is associated with. tsig_key_id (str) – (optional) Search for zones that are associated with a TSIG key. dnssec_state (str) – (optional) Search for zones that have the given DnssecState. Allowed values are: “ENABLED”, “DISABLED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ZoneSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_zones API.

patch_domain_records(zone_name_or_id, domain, patch_domain_records_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. patch_domain_records_details (oci.dns.models.PatchDomainRecordsDetails) – (required) Operations describing how to modify the collection of records. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use patch_domain_records API.

patch_rr_set(zone_name_or_id, domain, rtype, patch_rr_set_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. rtype (str) – (required) The type of the target RRSet within the target zone. patch_rr_set_details (oci.dns.models.PatchRRSetDetails) – (required) Operations describing how to modify the collection of records. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use patch_rr_set API.

patch_zone_records(zone_name_or_id, patch_zone_records_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. patch_zone_records_details (oci.dns.models.PatchZoneRecordsDetails) – (required) The operations describing how to modify the collection of records. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use patch_zone_records API.

promote_zone_dnssec_key_version(zone_id, promote_zone_dnssec_key_version_details, **kwargs)¶

Promotes a specified DnssecKeyVersion on the zone.

If the DnssecKeyVersion identified in the request body is a key signing key (KSK) that is replacing another DnssecKeyVersion, then the old DnssecKeyVersion is scheduled for removal from the zone.

For key signing keys (KSKs), you must create the DS record with the new key information before promoting the new key to establish a chain of trust. To avoid a service disruption, remove the old DS record as soon as its TTL (time to live) expires.

For more information, see DNSSEC.

Parameters:	zone_id (str) – (required) The OCID of the target zone. promote_zone_dnssec_key_version_details (oci.dns.models.PromoteZoneDnssecKeyVersionDetails) – (required) Details for promoting a DnssecKeyVersion. if_match (str) – (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* (str) – (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_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use promote_zone_dnssec_key_version API.

stage_zone_dnssec_key_version(zone_id, stage_zone_dnssec_key_version_details, **kwargs)¶

Stages a new DnssecKeyVersion on the zone. Staging is a process that generates a new “successor” key version that replaces an existing “predecessor” key version. Note: A new key-signing key (KSK) version is inert until you update the parent zone DS records.

For more information, see the DNSSEC documentation.

Parameters:	zone_id (str) – (required) The OCID of the target zone. stage_zone_dnssec_key_version_details (oci.dns.models.StageZoneDnssecKeyVersionDetails) – (required) Details for staging a DnssecKeyVersion. if_match (str) – (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* (str) – (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_retry_token (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use stage_zone_dnssec_key_version API.

update_domain_records(zone_name_or_id, domain, update_domain_records_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. update_domain_records_details (oci.dns.models.UpdateDomainRecordsDetails) – (required) A full list of records for the domain. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use update_domain_records API.

update_resolver(resolver_id, update_resolver_details, **kwargs)¶

Updates the specified resolver with your new information.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. update_resolver_details (oci.dns.models.UpdateResolverDetails) – (required) New data for the resolver. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Resolver`
Return type:	`Response`
Example:

Click here to see an example of how to use update_resolver API.

update_resolver_endpoint(resolver_id, resolver_endpoint_name, update_resolver_endpoint_details, **kwargs)¶

Updates the specified resolver endpoint with your new information.

Parameters:	resolver_id (str) – (required) The OCID of the target resolver. resolver_endpoint_name (str) – (required) The name of the target resolver endpoint. update_resolver_endpoint_details (oci.dns.models.UpdateResolverEndpointDetails) – (required) New data for the resolver endpoint. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ResolverEndpoint`
Return type:	`Response`
Example:

Click here to see an example of how to use update_resolver_endpoint API.

update_rr_set(zone_name_or_id, domain, rtype, update_rr_set_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. domain (str) – (required) The target fully-qualified domain name (FQDN) within the target zone. rtype (str) – (required) The type of the target RRSet within the target zone. update_rr_set_details (oci.dns.models.UpdateRRSetDetails) – (required) A full list of records for the RRSet. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use update_rr_set API.

update_steering_policy(steering_policy_id, update_steering_policy_details, **kwargs)¶

Updates the configuration of the specified steering policy.

Parameters:	steering_policy_id (str) – (required) The OCID of the target steering policy. update_steering_policy_details (oci.dns.models.UpdateSteeringPolicyDetails) – (required) New data for the steering policy. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicy`
Return type:	`Response`
Example:

Click here to see an example of how to use update_steering_policy API.

update_steering_policy_attachment(steering_policy_attachment_id, update_steering_policy_attachment_details, **kwargs)¶

Updates the specified steering policy attachment with your new information.

Parameters:	steering_policy_attachment_id (str) – (required) The OCID of the target steering policy attachment. update_steering_policy_attachment_details (oci.dns.models.UpdateSteeringPolicyAttachmentDetails) – (required) New data for the steering policy attachment. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SteeringPolicyAttachment`
Return type:	`Response`
Example:

Click here to see an example of how to use update_steering_policy_attachment API.

update_tsig_key(tsig_key_id, update_tsig_key_details, **kwargs)¶

Updates the specified TSIG key.

Parameters:	tsig_key_id (str) – (required) The OCID of the target TSIG key. update_tsig_key_details (oci.dns.models.UpdateTsigKeyDetails) – (required) New data for the TSIG key. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TsigKey`
Return type:	`Response`
Example:

Click here to see an example of how to use update_tsig_key API.

update_view(view_id, update_view_details, **kwargs)¶

Updates the specified view with your new information.

Parameters:	view_id (str) – (required) The OCID of the target view. update_view_details (oci.dns.models.UpdateViewDetails) – (required) New data for the view. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `View`
Return type:	`Response`
Example:

Click here to see an example of how to use update_view API.

update_zone(zone_name_or_id, update_zone_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. update_zone_details (oci.dns.models.UpdateZoneDetails) – (required) New data for the zone. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Zone`
Return type:	`Response`
Example:

Click here to see an example of how to use update_zone API.

update_zone_records(zone_name_or_id, update_zone_records_details, **kwargs)¶

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.

Parameters:	zone_name_or_id (str) – (required) The name or OCID of the target zone. update_zone_records_details (oci.dns.models.UpdateZoneRecordsDetails) – (required) A full list of records for the zone. if_match (str) – (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* (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. scope (str) – (optional) Specifies to operate only on resources that have a matching DNS scope. Allowed values are: “GLOBAL”, “PRIVATE” view_id (str) – (optional) The OCID of the view the zone is associated with. Required when accessing a private zone by name. compartment_id (str) – (optional) The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RecordCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use update_zone_records API.