GetDomainRecords
get
/20180115/zones/{zone_name_or_id}/records/{domain}
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.
Request
Supported Media Types
- application/json
Path Parameters
-
domain(required): string
The target fully-qualified domain name (FQDN) within the target zone.
-
zoneNameOrId(required): string
The name or OCID of the target zone.
Query Parameters
-
compartmentId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment the zone belongs to. Deprecated. Do not use. -
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
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.Allowed Values:
[ "GLOBAL", "PRIVATE" ]
-
sortBy: string
The field by which to sort records.Default Value:
rtype
Allowed Values:[ "rtype", "ttl" ]
-
sortOrder: string
The order to sort the resources.Default Value:
ASC
Allowed Values:[ "ASC", "DESC" ]
-
viewId: string
Minimum Length:
1
Maximum Length:255
The OCID of the view the resource is associated with. -
zoneVersion: string
The version of the zone for which data is requested.
Header Parameters
-
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 system returns the requested resource, with a 200 status, only if the resource has no etag matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the HTTP status code 304 (Not Modified). Example: example-etagDefault Value:
-
opc-request-id: string
Minimum Length:
1
Maximum Length:98
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Response
Supported Media Types
- application/json
200 Response
A collection of DNS resource record objects.
Headers
-
ETag: string
The current version of the resource, ending with a representation-specific suffix. This value may be used in If-Match and If-None-Match headers for later requests of the same resource.
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
-
opc-total-items: integer
The total number of items that match the query.
Nested Schema : Record
Type:
object
A DNS resource record.
Show Source
-
domain:
string
Minimum Length:
1
Maximum Length:254
The fully qualified domain name where the record can be located. -
isProtected:
boolean
A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
-
rdata:
string
The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input.
-
recordHash:
string
A unique identifier for the record within its zone.
-
rrsetVersion:
string
The latest version of the record's zone in which its RRSet differs from the preceding version.
-
rtype:
string
The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4).
-
ttl:
integer(int32)
Minimum Value:
0
Maximum Value:604800
The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload