List zone information (GET /v1.0/hostedzone)

Lists zone information.

You can use the URL parameters in the request to specify the first zone ID for which information is to be retrieved, and the maximum number of records to be retrieved.

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

Request Headers

n/a

Request Parameters

marker

Retrieval start zone ID.

If omitted, zone information will be retrieved from the beginning.

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:
The zone ID specified in "marker" does not exist, or the values specified in "maxitems" is outside the range of 1 to 100
Data type Cardinality
Int 1..1

Response elements (normal completion)

ListHostedZonesResponse

Envelope of the response.

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

Marker

IsTruncated

NextMarker

MaxItems

HostedZones

Envelope of the zone information list.

Data type Cardinality Parent element Child element
- 1..1 ListHostedZonesResponse HostedZone

HostedZone

Envelope of the zone information.

Data type Cardinality Parent element Child element
- 1..n HostedZones Id

Name

CallerReference

Config

ResourceRecordSetCount

Id

Zone ID. Same value as the zone name.

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

Name

Zone name. Normalized value.

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

CallerReference

Zone identifier. Same value as the zone name.

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

Config

Envelope of appended information.

Data type Cardinality Parent element Child element
- 1..1 HostedZone Comment

Comment

Comment.

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

ResourceRecordSetCount

Number of records registered in the host zone.

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

Marker

Retrieval start zone ID specified in the request.

Data type Cardinality Parent element Child element
xsd:string 0..1 ListHostedZonesResponse 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 ListHostedZonesResponse None

NextMarker

Retrieval start zone ID of zone information that has not been returned.

This is returned when IsTruncated is true.

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

MaxItems

Maximum number of records for retrieval specified in request.

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

Example of Request


GET /hostedzone 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"?>
< ListHostedZonesResponse xmlns="http://docs.cloudcommunity.global.fujitsu.com/dns/api/v1.0/">
  <HostedZones>
    <HostedZone>
      <Id>example.com</Id>
      <Name>example.com</Name>
      <CallerReference>example.com</CallerReference>
      <Config>
        <Comment>comment</Comment>
      </Config>
      <ResourceRecordSetCount>0</ResourceRecordSetCount>
    </HostedZone>
  <HostedZone>
. . .
  </HostedZone>
  </HostedZones>
  <IsTruncated>false</IsTruncated>
  <MaxItems>100</MaxItems>
</ListHostedZonesResponse>