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).

__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 is that the client never times out. 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.

change_steering_policy_compartment(steering_policy_id, change_steering_policy_compartment_details, **kwargs)

Moves a steering policy into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • steering_policy_id (str) -- (required) The OCID of the target steering policy.
  • change_steering_policy_compartment_details (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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_zone_compartment(zone_id, change_zone_compartment_details, **kwargs)

Moves a zone into a different compartment. When provided, If-Match is checked against ETag values of the resource. 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 (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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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 (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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicy

Return type:

Response

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 (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).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicyAttachment

Return type:

Response

create_zone(create_zone_details, **kwargs)

Creates a new zone in the specified compartment. The compartmentId query parameter is required if the Content-Type header for the request is text/dns.

Parameters:
  • create_zone_details (CreateZoneBaseDetails) -- (required) Details for creating a new zone.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Zone

Return type:

Response

delete_domain_records(zone_name_or_id, domain, **kwargs)

Deletes all records at the specified zone and domain.

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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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

Deletes all records in the specified RRSet.

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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_zone(zone_name_or_id, **kwargs)

Deletes the specified zone and all its steering policy attachments. A 204 response indicates that zone has been successfully deleted.

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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

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.

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.
  • 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.

  • 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 resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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.

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.
  • 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 resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RRSet

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicy

Return type:

Response

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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicyAttachment

Return type:

Response

get_zone(zone_name_or_id, **kwargs)

Gets information about the specified zone, including its creation date, zone type, and serial.

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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Zone

Return type:

Response

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.

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.
  • 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 resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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.
  • 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"

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SteeringPolicySummary

Return type:

Response

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.
  • 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"

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SteeringPolicyAttachmentSummary

Return type:

Response

list_zones(compartment_id, **kwargs)

Gets a list of all zones in the specified compartment. The collection can be filtered by name, time created, and zone type.

Parameters:
  • compartment_id (str) -- (required) The OCID of the compartment the resource belongs to.
  • 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"

  • 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"

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ZoneSummary

Return type:

Response

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.

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 (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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

Updates records in the specified RRSet.

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 (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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.

Parameters:
  • zone_name_or_id (str) -- (required) The name or OCID of the target zone.
  • patch_zone_records_details (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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.

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 (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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

Replaces records in the specified RRSet.

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 (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicy

Return type:

Response

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SteeringPolicyAttachment

Return type:

Response

update_zone(zone_name_or_id, update_zone_details, **kwargs)

Updates the specified secondary zone with your new external master server information. For more information about secondary zone, see Manage DNS Service Zone.

Parameters:
  • zone_name_or_id (str) -- (required) The name or OCID of the target zone.
  • update_zone_details (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Zone

Return type:

Response

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.

Parameters:
  • zone_name_or_id (str) -- (required) The name or OCID of the target zone.
  • update_zone_records_details (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.
  • compartment_id (str) -- (optional) The OCID of the compartment the resource belongs to.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RecordCollection

Return type:

Response