ニフクラAPI (DNS: ListResourceRecordSets)

ListResourceRecordSets

処理概要

レコードの情報を一覧で取得します。

リクエスト内のURLパラメーターにより、取得を開始するレコード情報の名前（ドメイン）、種別、識別情報と、最大取得件数を指定できます。

リクエストのidentiferはユーザー登録した情報ではなく、システムが生成したランダム文字列です。

リクエストのidentiferだけでレコード特定できますが、特定したレコードと指定したname、type一致しない場合、特定失敗とみなします。

リクエストURL

GET https://dns.api.nifcloud.com/2012-12-12N2013-12-16/hostedzone/{ZoneID}/rrset

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
ZoneID	string	ゾーンID	○

クエリパラメーター

パラメーター	型	説明
name	string	レコード名（ドメイン）使用可能文字: ドメイン
type	string	レコード種別値: NS A AAAA CNAME MX TXT PTR LBR
identifier	string	レコード識別情報
maxitems	integer	取得するレコード情報の最大件数 Default: 100 使用可能文字: 1～100

応答フィールド

フィールド (項目)	型	説明
ListResourceRecordSetsResponse	structure	ルート
␣ResourceRecordSets	list	レコード情報のリスト
␣␣ResourceRecordSet	structure	更新リクエスト情報
␣␣␣Name	string	ゾーンID
␣␣␣Type	string	レコード種別値: NS A AAAA CNAME MX TXT PTR LBR
␣␣␣SetIdentifier	string	レコード識別情報
␣␣␣Weight	integer	重み付け値備考: WRR利用時のみ設定
␣␣␣Region	string	リージョン情報備考: 登録時無視/表示時空
␣␣␣XniftyDefaultHost	string	デフォルトホスト情報備考: LBR利用時のみ設定、空可
␣␣␣Failover	string	フェイルオーバー種別値: PRIMARY SECONDARY 備考: Failover利用時のみ設定
␣␣␣XniftyHealthCheckConfig	structure	ヘルスチェック情報備考: Failover利用時のみ設定
␣␣␣␣IPAddress	string	ヘルスチェック先IPアドレス
␣␣␣␣Port	integer	ヘルスチェック先ポート
␣␣␣␣Protocol	string	ヘルスチェック種別値: HTTP HTTPS TCP
␣␣␣␣ResourcePath	string	ヘルスチェック先パス備考: ProtocalがHTTPの場合のみ
␣␣␣␣FullyQualifiedDomainName	string	ヘルスチェック先ドメイン備考: ProtocalがHTTPの場合のみ
␣␣␣TTL	integer	TTL値備考: LBRの場合不要
␣␣␣ResourceRecords	list	レコードの応答情報のリスト
␣␣␣␣ResourceRecord	structure	レコードの応答情報
␣␣␣␣␣Value	string	レコードの応答値
␣␣␣XniftyComment	string	コメント
␣IsTruncated	boolean	未表示レコード情報の有無
␣MaxItems	integer	最大取得件数備考: リクエストで指定した値
␣NextRecordName	string	未表示先頭レコード名（ドメイン）備考: IsTruncatedがtrueの場合のみ
␣NextRecordType	string	未表示先頭レコード種別備考: IsTruncatedがtrueの場合のみ
␣NextRecordIdentifier	string	未表示先頭レコード識別情報備考: IsTruncatedがtrueの場合のみ

エラー

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

リクエストサンプル

    GET /2012-12-12N2013-12-16/hostedzone/example.com/rrset 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"?>
<ListResourceRecordSetsResponse xmlns="https://route53.amazonaws.com/doc/2012-12-12/">
  <ResourceRecordSets>
    <ResourceRecordSet>
      <Name>a.example.com</Name>
      <Type>A</Type>
      <SetIdentifier>kwQix0gfLLg=</SetIdentifier>
      <Weight>100</Weight>
      <TTL>60</TTL>
      <ResourceRecords>
        <ResourceRecord>
          <Value>1.1.1.1</Value>
        </ResourceRecord>
      </ResourceRecords>
    </ResourceRecordSet>
  </ResourceRecordSets>
  <IsTruncated>false</IsTruncated>
  <MaxItems>100</MaxItems>
</ListResourceRecordSetsResponse>