domain_records
Creates, updates, deletes, gets or lists a domain_records resource.
Overview​
| Name | domain_records |
| Type | Resource |
| Id | oci.dns.domain_records |
Fields​
The following fields are returned by SELECT queries:
- get
A collection of DNS resource record objects.
| Name | Datatype | Description |
|---|---|---|
items | array |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | zoneNameOrId, domain, region | If-None-Match, If-Modified-Since, opc-request-id, limit, page, zoneVersion, rtype, scope, viewId, sortBy, sortOrder, compartmentId | Gets a list of all records at the specified zone and domain.<br /><br />The results are sorted by rtype in alphabetical order by default. You can optionally filter and/or sort<br />the results using the listed parameters. When the zone name is provided as a path parameter and PRIVATE<br />is used for the scope query parameter then the viewId query parameter is required.<br /> |
update | update | zoneNameOrId, domain, region | If-Match, If-Unmodified-Since, opc-request-id, scope, viewId, compartmentId | Replaces records in the specified zone at a domain with the records specified in the request body.<br /><br />If a specified record does not exist, it will be created. If the record exists, then it will be updated to<br />represent the record in the body of the request. If a record in the zone does not exist in the request body,<br />the record will be removed from the zone. When the zone name is provided as a path parameter and PRIVATE<br />is used for the scope query parameter then the viewId query parameter is required.<br /> |
delete | delete | zoneNameOrId, domain, region | If-Match, If-Unmodified-Since, opc-request-id, scope, viewId, compartmentId | Deletes all records at the specified zone and domain.<br /><br />When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter<br />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) |
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-Modified-Since | string | The If-Modified-Since header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed. |
If-None-Match | string | The If-None-Match header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is *, or having a selected representation with an entity-tag that does not match any of those listed in the field-value. |
If-Unmodified-Since | string | The If-Unmodified-Since header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation. |
compartmentId | string | The OCID of the compartment the zone belongs to. This parameter is deprecated and should be omitted. |
limit | integer (int64) | The maximum number of items to return in a page of the collection. |
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. |
page | string | The value of the opc-next-page response header from the previous "List" call. |
rtype | string | Search by record type. Will match any record whose [type](https:​//www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. |
scope | string | Specifies to operate only on resources that have a matching DNS scope. |
sortBy | string | The field by which to sort records. |
sortOrder | string | The order to sort the resources. |
viewId | string | The OCID of the view the zone is associated with. Required when accessing a private zone by name. |
zoneVersion | string | The version of the zone for which data is requested. |
SELECT examples​
- get
Gets a list of all records at the specified zone and domain.<br /><br />The results are sorted by rtype in alphabetical order by default. You can optionally filter and/or sort<br />the results using the listed parameters. When the zone name is provided as a path parameter and PRIVATE<br />is used for the scope query parameter then the viewId query parameter is required.<br />
SELECT
items
FROM oci.dns.domain_records
WHERE zoneNameOrId = '{{ zoneNameOrId }}' -- required
AND domain = '{{ domain }}' -- required
AND region = '{{ region }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
AND If-Modified-Since = '{{ If-Modified-Since }}'
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND zoneVersion = '{{ zoneVersion }}'
AND rtype = '{{ rtype }}'
AND scope = '{{ scope }}'
AND viewId = '{{ viewId }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND compartmentId = '{{ compartmentId }}'
;
UPDATE examples​
- update
Replaces records in the specified zone at a domain with the records specified in the request body.<br /><br />If a specified record does not exist, it will be created. If the record exists, then it will be updated to<br />represent the record in the body of the request. If a record in the zone does not exist in the request body,<br />the record will be removed from the zone. When the zone name is provided as a path parameter and PRIVATE<br />is used for the scope query parameter then the viewId query parameter is required.<br />
UPDATE oci.dns.domain_records
SET
items = '{{ items }}'
WHERE
zoneNameOrId = '{{ zoneNameOrId }}' --required
AND domain = '{{ domain }}' --required
AND region = '{{ region }}' --required
AND If-Match = '{{ If-Match}}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since}}'
AND opc-request-id = '{{ opc-request-id}}'
AND scope = '{{ scope}}'
AND viewId = '{{ viewId}}'
AND compartmentId = '{{ compartmentId}}'
RETURNING
items;
DELETE examples​
- delete
Deletes all records at the specified zone and domain.<br /><br />When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter<br />then the viewId query parameter is required.<br />
DELETE FROM oci.dns.domain_records
WHERE zoneNameOrId = '{{ zoneNameOrId }}' --required
AND domain = '{{ domain }}' --required
AND region = '{{ region }}' --required
AND If-Match = '{{ If-Match }}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since }}'
AND opc-request-id = '{{ opc-request-id }}'
AND scope = '{{ scope }}'
AND viewId = '{{ viewId }}'
AND compartmentId = '{{ compartmentId }}'
;