records

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

Overview

Name	records
Type	Resource
Id	oci.dns.records

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
patch_zone_records	exec	zoneNameOrId, region	If-Match, If-Unmodified-Since, opc-request-id, scope, viewId, compartmentId	Updates a collection of records in the specified zone.<br /><br />You can update one record or all records for the specified zone depending on the changes provided in the<br />request body. You can also add or remove records using this function. When the zone name is provided as<br />a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is<br />required.<br />
patch_domain_records	exec	zoneNameOrId, domain, region	If-Match, If-Unmodified-Since, opc-request-id, scope, viewId, compartmentId	Updates records in the specified zone at a domain.<br /><br />You can update one record or all records for the specified zone depending on the changes provided in the<br />request body. You can also add or remove records using this function. When the zone name is provided as<br />a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is<br />required.<br />
patch_rr_set	exec	zoneNameOrId, domain, rtype, region	If-Match, If-Unmodified-Since, opc-request-id, scope, viewId, compartmentId	Updates records in the specified RRSet.<br /><br />When the zone name is provided as a path parameter and PRIVATE is used for the scope query<br />parameter then the viewId query parameter is required.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	The target fully-qualified domain name (FQDN) within the target zone.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
rtype	string	The type of the target RRSet within the target zone.
zoneNameOrId	string	The name or OCID of the target zone.
If-Match	string	The If-Match header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is *, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
If-Unmodified-Since	string	The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
compartmentId	string	The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted.
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
scope	string	Specifies to operate only on resources that have a matching DNS scope.
viewId	string	The OCID of the view the zone is associated with. Required when accessing a private zone by name.

Lifecycle Methods

patch_zone_records

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

EXEC oci.dns.records.patch_zone_records 
@zoneNameOrId='{{ zoneNameOrId }}' --required, 
@region='{{ region }}' --required, 
@If-Match='{{ If-Match }}', 
@If-Unmodified-Since='{{ If-Unmodified-Since }}', 
@opc-request-id='{{ opc-request-id }}', 
@scope='{{ scope }}', 
@viewId='{{ viewId }}', 
@compartmentId='{{ compartmentId }}' 
@@json=
'{
"items": "{{ items }}"
}'
;

patch_domain_records

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

EXEC oci.dns.records.patch_domain_records 
@zoneNameOrId='{{ zoneNameOrId }}' --required, 
@domain='{{ domain }}' --required, 
@region='{{ region }}' --required, 
@If-Match='{{ If-Match }}', 
@If-Unmodified-Since='{{ If-Unmodified-Since }}', 
@opc-request-id='{{ opc-request-id }}', 
@scope='{{ scope }}', 
@viewId='{{ viewId }}', 
@compartmentId='{{ compartmentId }}' 
@@json=
'{
"items": "{{ items }}"
}'
;

patch_rr_set

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

EXEC oci.dns.records.patch_rr_set 
@zoneNameOrId='{{ zoneNameOrId }}' --required, 
@domain='{{ domain }}' --required, 
@rtype='{{ rtype }}' --required, 
@region='{{ region }}' --required, 
@If-Match='{{ If-Match }}', 
@If-Unmodified-Since='{{ If-Unmodified-Since }}', 
@opc-request-id='{{ opc-request-id }}', 
@scope='{{ scope }}', 
@viewId='{{ viewId }}', 
@compartmentId='{{ compartmentId }}' 
@@json=
'{
"items": "{{ items }}"
}'
;