Show a Recordset¶
Overview¶
Show a single recordset
Classification¶
Show
API Operation Object¶
Recordset
Synchronous / Asynchronous¶
Synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{api_endpoint}/v2/zones/{zone_id}/recordsets/{recordset_id}
HTTP Request Header¶
Format¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
HTTP Request Body¶
none
Request Parameter¶
name |
style |
format |
description |
required/optional |
default value |
action for invalid parameter |
response code for invalid parameter |
---|---|---|---|---|---|---|---|
token_id |
header |
authentication token string |
authentication token |
required |
- |
Terminate |
401 |
zone_id |
path |
uuid |
ID for the zone. |
required |
- |
Terminate |
400,404 |
recordset_id |
path |
uuid |
ID for the recordset. |
required |
- |
Terminate |
400,404 |
Response¶
HTTP Response Header¶
Response Code¶
response code |
status |
condition |
message |
---|---|---|---|
200 |
OK |
normal end |
|
400 |
Bad Request |
invalid value |
E2042 Zone id is required. |
404 |
Not Found |
not exists |
E2007 Specified zone is not found. |
Not Found |
not exists |
E2008 Specified recordset is not found. |
|
401 |
Unauthorized |
authentication failure |
E2001 Invalid token. |
500 |
Internal Server Error |
internal server error |
E9001 Internal Server Error. Request failed. |
Response Body¶
Format¶
{
"description": <description>,
"links": {
<links>
},
"updated_at": <updted_at>,
"records": <records> ,
"ttl": <ttl>,
"id": <id>,
"name": <name>,
"zone_id": <zone_id>,
"created_at": <created_at>,
"version": <version>,
"type": <type>,
"status": <status>
}
Response Parameter¶
item |
format |
Description |
---|---|---|
description |
string |
Description for this recordset. |
links |
links |
Links to the resource, and other related resources. When a response has been broken into pages, we will include a next link that should be followed to retrieve all results. |
updated_at |
datestamp |
Date / Time when resource last updated. |
records |
string list |
A list of data for this recordset. Each item will be a separate record in SDPF DNS These items should conform to the DNS spec for the record type - e.g. A records must be IPv4 addresses, CNAME records must be a hostname. |
ttl |
integer |
TTL (Time to Live) for the recordset. |
id |
uuid |
ID for the resource. |
name |
hostname |
DNS Name for the recordset. |
zone_id |
uuid |
ID for the zone that contains this recordset. |
created_at |
datestamp |
Date / Time when resource was created. |
version |
integer |
Version of the resource. This parameter is not currently supported. it always return 1. |
type |
string |
They RRTYPE of the recordset. |
status |
enum |
status of the resource. |
Sample Request and Response¶
Sample API Request¶
Request URL¶
GET /v2/zones/fbe8562b-66a5-4071-b4c2-250487d15a81/recordsets/95929ba7-f495-4d0b-8b88-09b58cd3e358
Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: e8c788fbaeb14964ae19759eb1df4ff1
Request Body¶
none
Sample API Response¶
Response Header¶
HTTP/1.1 200
Date: Mon, 24 Oct 2016 05:55:39 GMT
Content-Type: application/json
Content-Length: 431
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce15d66d987b9512cdb0c7b38493332b9fec0d7af905a3995bfcd3cf455e1a2212e; Path=/
Response Body¶
{
"id": "95929ba7-f495-4d0b-8b88-09b58cd3e358",
"name": "example.uk.",
"ttl": 60,
"description": null,
"records": [
"dns301-1.example.jp."
],
"type": "NS",
"version": 1,
"created_at": "2016-10-24T03:36:05",
"updated_at": "",
"zone_id": "fbe8562b-66a5-4071-b4c2-250487d15a81",
"status": "ACTIVE",
"links": {
"self": "https://endpoint.api.example.com/v2/zones/fbe8562b-66a5-4071-b4c2-250487d15a81/recordsets/95929ba7-f495-4d0b-8b88-09b58cd3e358"
}
}
Sample Error Response¶
Response¶
HTTP/1.1 404
Date: Mon, 24 Oct 2016 05:59:21 GMT
Content-Type: application/json
Content-Length: 94
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1d5c1d79e741f1fcf82bcca2e88f07da56d3dbec146eea355481276c9c503c1ca; Path=/
{"error":{"code":404,"title":"Not Found","message":"E2008 Specified recordset is not found."}}