ニフクラAPI (DNS: ListHostedZones)

ListHostedZones

処理概要

ゾーンの情報を一覧で取得します。

リクエスト内のURLパラメーターにより、取得する一覧の先頭のゾーンID、取得する一覧の最大件数を指定することができます。

取得される情報は、ゾーン情報のみで、ネームサーバー情報は取得されません。

リクエストURL

GET https://dns.api.nifcloud.com/2012-12-12N2013-12-16/hostedzone

指定するパラメーター

クエリパラメーター

パラメーター	型	説明	必須
marker	string	取得開始ゾーンID 使用可能文字: ドメイン 備考: 未指定の場合はゾーン情報の全リストの先頭からの情報を取得
maxitems	integer	取得するレコード情報の最大件数 Default: 100 使用可能文字: 1～100

応答フィールド

レスポンスボディ

フィールド (項目)	型	説明
ListHostedZonesResponse	structure	ルート
␣HostedZones	list	ゾーン情報のリスト
␣␣HostedZone	structure	ゾーン情報
␣␣␣Id	string	ゾーンID 備考: 正規化したゾーン名
␣␣␣Name	string	ゾーン名（ドメイン） 備考: 正規化したゾーン名
␣␣␣CallerReference	string	ゾーン識別子 備考: 正規化したゾーン名
␣␣␣Config	structure	ゾーンの付加情報
␣␣␣␣Comment	string	コメント（ゾーン） 備考: リクエストで指定した値
␣␣␣ResourceRecordSetCount	integer	レコード設定数
␣Marker	string	取得開始ゾーンID 備考: リクエストで指定した値
␣IsTruncated	boolean	未表示ゾーン情報の有無
␣NextMarker	string	未表示先頭ゾーンID 備考: IsTruncatedがtrueの場合のみ
␣MaxItems	integer	最大取得件数 備考: リクエストで指定した値

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
InvalidInput	The specified marker is not valid.	Sender	400	URLパラメーター「marker」で指定されたゾーンIDが存在しない
InvalidInput	maxitems must be a positive integer.	Sender	400	URLパラメーター「maxitems」で指定された値が不正（1〜100以外）

リクエストサンプル

    GET /2012-12-12N2013-12-16/hostedzone HTTP/1.1
Host: dns.api.nifcloud.com
Date: Thu, 17 Jun 2021 08:53:44 GMT
X-Nifty-Authorization: NIFTY3-HTTPS NiftyAccessKeyId=<Nifty Cloud Access Key>,Algorithm=<HmacSHA1|HmacSHA256>,Signature=<Signature>

  

応答サンプル

    <?xml version="1.0" encoding="UTF-8"?>
<ListHostedZonesResponse xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
  <HostedZones>
    <HostedZone>
      <Id>/hostedzone/example.com</Id>
      <Name>example.com</Name>
      <CallerReference>example.com</CallerReference>
      <Config>
      </Config>
      <ResourceRecordSetCount>10</ResourceRecordSetCount>
    </HostedZone>
    <HostedZone>
      <Id>/hostedzone/example.net</Id>
      <Name>example.net</Name>
      <CallerReference>example.net</CallerReference>
      <Config>
      </Config>
      <ResourceRecordSetCount>20</ResourceRecordSetCount>
    </HostedZone>
  </HostedZones>
  <IsTruncated>false</IsTruncated>
  <MaxItems>100</MaxItems>
</ListHostedZonesResponse>