GET records

API情報

管理権限HTTPメソッドAPI名目的
不要GETrecordsレコード一覧取得
  • 指定したゾーンのレコード一覧を取得します。

個別パラメータ

URL
フィールドタイプ必須意味
ZoneNameString

操作対象のゾーン名 (例: example.jp, 192.0.2.0/24)

StyleString 

取得形式 (DETAIL, FULL, RELATIVE)

レコードID、編集ステータスを含む詳細情報をリスト形式で取得する場合は"DETAIL"

ゾーン名を付加した正記名を羅列したゾーンファイル形式で取得する場合は"FULL"

ゾーン名を省略した読みやすいゾーンファイル形式で取得する場合は"RELATIVE"

  • 省略時は"DETAIL"に設定されます。
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
  • ゾーン名に"/"を指定する場合は、URLエンコードして"%2F"を指定します。同様に":"を指定する場合は、URLエンコードして"%3A"を指定します。詳しくは、Signature生成時のURLエンコード方法を参照してください。
HTTPリクエストボディ
  • なし

レスポンス

フィールドタイプ意味
TextString

ゾーンファイル形式

  • Styleが"FULL"または"RELATIVE"の場合のみ取得できます。
RecordListArray

レコードのリスト

  • Styleが"DETAIL"の場合のみ取得できます。

RecordList.Id

String

レコードのID

RecordList.StatusStringレコードの編集ステータス (レコード編集ステータス)
RecordList.OwnerStringレコードの左辺 (例: @, www)
  • ゾーン名は付加されていない形式です。
RecordList.TTLStringレコードのTTL値 (単位:秒)
RecordList.RecordTypeString

レコードのレコードタイプ

値: NS, A, AAAA, MX, CNAME, SRV, TXT, CAA, TLSA, DS, PTR, APEX

RecordList.RDataString

レコードの右辺 (例: www.example.jp, 192.0.2.1)

  • ゾーン名は付加されている形式です。
  • 末尾の"."は付加されません。
StaticRecordListArray 

編集不可能な固定レコードのリスト

  • Styleが"DETAIL"の場合のみ取得できます。
StaticRecordList.OwnerString

編集不可能な固定レコードの左辺 (例: @, www)

  • ゾーン名は付加されていない形式です。
StaticRecordList.TTLString編集不可能な固定レコードのTTL値 (単位:秒)
StaticRecordList.RecordTypeString

編集不可能な固定レコードのレコードタイプ

値: NS, A, AAAA, MX, CNAME, SRV, TXT, CAA, TLSA, DS, PTR, APEX

StaticRecordList.RDataString

編集不可能な固定レコードの右辺 (例: www.example.jp, 192.0.2.1)

  • ゾーン名は付加されている形式です。
  • 末尾の"."は付加されません。
  • 共通のフィールドはレスポンスフィールドを参照してください。
  • 指定するパラメータによってレスポンスの形式が変化します。

エラーコード

エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメーターエラー200ParameterErrorThere are invalid parameters.

以下のパラメータの形式が不正

  • DoServiceCode
  • ZoneName
  • Style
 
RecordValidateErrorCan't operate according to specifications.仕様上不正なレコードがゾーン内に存在している
(※ エラーレスポンスの「JSON (RecordValidateError 発生時)」を参照してください)
 
リソースエラー200ResourceNotExistResource is not found.

以下のいずれかのリソースが存在しない

  • 契約情報
  • ゾーン
 

制限

  • 契約外のゾーン情報は取得できません。
  • コメントは取得できません。
  • Styleが"FULL"または"RELATIVE"の場合、取得できるレコード(ゾーンファイルの行)はレコードの編集ステータスが"UNCHANGED"または"DELETED"のレコードのみです。
    • レコードの編集ステータスが"DELETING"(削除予定)のレコードは、ゾーンファイルからまだ削除されていないため取得できません。
    • レコードの編集ステータスが"ADDING"(追加予定)のレコードは、ゾーンファイルにまだ追加されていないため取得できません。
  • Styleが"DETAIL"の場合、取得できるレコード(ゾーンファイルの行)はレコードの編集ステータスが"UNCHANGED"(コミット済み), "ADDING"(追加予定), "DELETING"(削除予定)のレコードのみです。
    • レコードの編集ステータスが"DELETED"(削除済み)のレコードは、取得できません。
  • StaticRecordList.IdとStaticRecordList.Statusは取得できません。

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(ZoneName)/records/(Style).json HTTP/1.1
Host: do.api.iij.jp
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

レスポンスボディ (Styleが"DETAIL"の場合)

JSON
{
	"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
	"RecordList": [
		{
			"Id": "12345",
			"Status": "UNCHANGED",
			"Owner": "www",
			"TTL": "43200",
			"RecordType": "A",
			"RData": "192.0.2.1"
		},
			.
			.
			.
		{
			"Id": "22345",
			"Status": "UNCHANGED",
			"Owner": "www2",
			"TTL": "43200",
			"RecordType": "A",
			"RData": "192.0.2.1"
		}
	],
	"StaticRecordList": [
		{
			"Owner": "@",
			"TTL": "43200",
			"RecordType": "SOA",
			"RData": "dns-b.iij.ad.jp dns-managers.iij.ad.jp  1397198596 3600 1800 3600000 900 "
		},
			.
			.
			.
		{
			"Owner": "@",
			"TTL": "43200",
			"RecordType": "NS",
			"RData": "dns-c.iij.ad.jp"
		}
	]
}

レスポンスボディ (Styleが"FULL"の場合)

JSON
{
	"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
	"Text": "example.jp.\t\t\t      28800 IN SOA\tdns-b.iij.ad.jp. dns-managers.iij.ad.jp. 1401370369 3600 1800 3600000 900\nexample.jp.\t\t\t      28800 IN NS\tdns-b.iij.ad.jp.\nexample.jp.\t\t\t      28800 IN NS\tdns-c.iij.ad.jp.\nlocalhost.example.jp.\t\t      28800 IN A\t127.0.0.1\ntest.example.jp.\t\t      28800 IN A\t1.2.3.4"
}

 レスポンスボディ (Styleが"RELATIVE"の場合)

JSON
{
	"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
	"Text": "$ORIGIN .\n$TTL 28800\t; 8 hours\nexample.jp\tIN SOA\tdns-b.iij.ad.jp. dns-managers.iij.ad.jp. (\n\t\t\t\t1401370369 ; serial\n\t\t\t\t3600       ; refresh (1 hour)\n\t\t\t\t1800       ; retry (30 minutes)\n\t\t\t\t3600000    ; expire (5 weeks 6 days 16 hours)\n\t\t\t\t900        ; minimum (15 minutes)\n\t\t\t\t)\n\t\t\tNS\tdns-b.iij.ad.jp.\n\t\t\tNS\tdns-c.iij.ad.jp.\n$ORIGIN example.jp.\nlocalhost\t\tA\t127.0.0.1\ntest\t\t\tA\t1.2.3.4"
}