List record information (GET /v1.0/hostedzone/{zoneId}/rrset)

Lists the record information.

Specify the URL request parameters to determine the name(domain), type, identification information of the record information where retrieval starts from, and the maximum number of records to be retrieved.

Records can be identified only by the identifer of the request, but if the specified record does not match the specified name and type, it is regarded as a specific failure.

For example, if you specify a name and a type with the URL parameter, record information is acquired by listing records with the specified name and type matching first.

In addition, when only identification information is specified, record information is acquired by listing records whose identification information matches first.

However, even if the identification information matches, if the specified name or type does not match, the record can not be specified.

*The zone ID is the same value as the zone name.

Request Headers

n/a

Request Parameter

name

Record name (domain). FQDN format.

Data type Cardinality
String 0..1

type

Record type.

NS, A, AAAA, CNAME, MX, TXT,PTR, LBR, SRV.

Data type Cardinality
String 0..1

identifier

Record identification information.

Random string created by the system during registration.

Data type Cardinality
String 0..1

maxitems

Maximum number of records to retrieve. Up to 100.

If omitted, 100 will be used.

Data type Cardinality
String 0..1

Request Elements

n/a

HTTP status

Status

The following error codes can be returned for the request.

One of the following values will be returned:
200:
Normal completion
400:
maxitems is outside the range of 1 to 100
404:
A zone with the specified ID does not exist
Data type Cardinality
Int 1..1

Response elements (normal completion)

ListResourceRecordSetsResponse

Envelope of the response.

Data type Cardinality Parent element Child element
- 1..1 None ResourceRecordSets

IsTruncated

MaxItems

NextRecordName

NextRecordType

NextRecordIdentifier

ResourceRecordSets

Envelope of the record information list.

Data type Cardinality Parent element Child element
- 1..1 ListResourceRecordSetsResponse ResourceRecordSet

ResourceRecordSet

Envelope of the record information.

Data type Cardinality Parent element Child element
- 1..n ResourceRecordSets Name

Type

SetIdentifier

Weight

XniftyDefaultHost

Failover

XniftyHealthCheckConfig

TTL

ResourceRecords

XniftyComment

Name

Record name.

Data type Cardinality Parent element Child element
xsd:string 1..1 ResourceRecordSet None

Type

Record type.

NS, A, AAAA, CNAME, MX, TXT,PTR, LBR, SRV.

Data type Cardinality Parent element Child element
xsd:string 1..1 ResourceRecordSet None

SetIdentifier

Record identification information.

Data type Cardinality Parent element Child element
xsd:string 1..1 ResourceRecordSet None

Weight

Weighting value.

Data type Cardinality Parent element Child element
xsd:string 0..1 ResourceRecordSet None

XniftyDefaultHost

Default host information.

Data type Cardinality Parent element Child element
xsd:string 0..1 ResourceRecordSet None

Failover

Failover type. PRIMARY or SECONDARY.

Data type Cardinality Parent element Child element
xsd:string 0..1 ResourceRecordSet None

XniftyHealthCheckConfig

Envelope of health check information.

Data type Cardinality Parent element Child element
- 0..1 ResourceRecordSet IPAddress

Port

Protocol

ResourcePath

FullyQualifiedDomainName

IPAddress

Health check destination IP address.

Data type Cardinality Parent element Child element
xsd:string 1..1 XniftyHealthCheckConfig None

Port

Health check destination port.

Data type Cardinality Parent element Child element
xsd:string 1..1 XniftyHealthCheckConfig None

Protocol

Health check type.

HTTP, HTTPS, TCP.

Data type Cardinality Parent element Child element
xsd:string 1..1 XniftyHealthCheckConfig None

ResourcePath

Health check destination path.

Data type Cardinality Parent element Child element
xsd:string 0..1 XniftyHealthCheckConfig None

FullyQualifiedDomainName

Health check destination domain name.

Data type Cardinality Parent element Child element
xsd:string 0..1 XniftyHealthCheckConfig None

TTL

TTL value.

Data type Cardinality Parent element Child element
xsd:string 1..1 ResourceRecordSet None

ResourceRecords

Envelope of the record response information list.

Data type Cardinality Parent element Child element
- 1..1 ResourceRecordSet ResourceRecord

ResourceRecord

Envelope of record response information.

Data type Cardinality Parent element Child element
- 1..n ResourceRecords Value

Value

Record response value.

Data type Cardinality Parent element Child element
xsd:string 1..1 ResourceRecord None

XniftyComment

Comment.

Data type Cardinality Parent element Child element
xsd:string 0..1 ResourceRecordSet None

IsTruncated

Indicates whether there is zone information that has not been returned. true or false.

Data type Cardinality Parent element Child element
xsd:string 1..1 ListResourceRecordSetsResponse None

MaxItems

Maximum number of records for retrieval specified in request.

Data type Cardinality Parent element Child element
xsd:string 1..1 ListResourceRecordSetsResponse None

NextRecordName

Retrieval start record name of record information that has not been returned.

This is returned when IsTruncated is true.

Data type Cardinality Parent element Child element
xsd:string 0..1 ListResourceRecordSetsResponse None

NextRecordType

Retrieval start record name of record information that has not been returned.

This is returned when IsTruncated is true.

Data type Cardinality Parent element Child element
xsd:string 0..1 ListResourceRecordSetsResponse None

NextRecordIdentifier

Retrieval start record name of record information that has not been returned.

This is returned when IsTruncated is true.

Data type Cardinality Parent element Child element
xsd:string 0..1 ListResourceRecordSetsResponse None

Example of Request


GET /hostedzone/example.com/rrset HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 GMT
Content-Length: . . .
Host: dns.gls.cloud.global.fujitsu.com
Accept: application/xml
X-Auth-Token: MIIFvgY. . .     
     

Example of response


HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: . . .
Content-Type: application/xml
x-fj-request-id: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< ListResourceRecordSetsResponse xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/">
  <ResourceRecordSets>
    <ResourceRecordSet>
      <Name>example.com</Name>
      <Type>MX</Type>
      <SetIdentifier>uLrNgSC4yzg=</SetIdentifier>
      <TTL>60</TTL>
      <ResourceRecords>
        <ResourceRecord>
          <Value>10 mail.example.com</Value>
        </ResourceRecord>
      </ResourceRecords>
    </ResourceRecordSet>
    <ResourceRecordSet>
    . . .
    </ResourceRecordSet>
  </ResourceRecordSets>
  <IsTruncated>false</IsTruncated>
  <MaxItems>100</MaxItems>
</ListResourceRecordSetsResponse>