List record information#
レコードの情報を一覧で取得します。
リクエスト内のURLパラメーターにより、取得を開始するレコード情報の名前(ドメイン)、種別、識別情報と、最大取得件数を指定できます。
リクエストのidentiferだけでレコード特定できますが、特定したレコードと指定したname、type一致しない場合、特定失敗とみなします。
例えば、URLパラメーターで名前(name)と種別(type)を指定した場合には、指定した名前と種別が一致するレコードを先頭にしてレコード情報が一覧取得されます。
また、識別情報だけを指定した場合には、識別情報が一致するレコードを先頭にしてレコード情報が一覧取得されます。
ただし、識別情報が一致する場合でも、指定した名前や種別が一致しない場合には、レコードが特定できません。
※ゾーンIDはゾーン名と同じ値です。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://dns.gls.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://dns.gls.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v1.0/hostedzone/{ゾーンID}/rrset
HTTPステータスコード#
正常時:200
エラー時:400, 404
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| name | body | string | 任意 | レコード名(ドメイン) FQDN形式です。 |
| type | body | string | 任意 | レコード種別 NS、A、AAAA、CNAME、MX、TXT、PTR、SRV |
| identifer | body | string | 任意 | レコード識別情報 登録時にシステムが作成したランダム文字列です。 |
| maxitems | body | string | 任意 | 取得レコード最大件数 最大は100です。 省略時は100です。 |
レスポンスボディ(正常系)の説明#
| 名前 | Type | Description |
|---|---|---|
| ListResourceRecordSetsResponseListResourceRecordSets Response | - | レスポンスのエンベロープ |
| ResourceRecordSets | - | レコード情報リストのエンベロープ |
| ResourceRecordSet | - | レコード情報のエンベロープ |
| Name | string | レコード名 |
| Type | string | レコード種別 NS、A、AAAA、CNAME、MX、TXT、PTR、SRV |
| SetIdentifier | string | レコード識別情報 |
| Weight | string | 重み付け値 |
| Failover | string | フェイルオーバー種別 PRIMARYまたはSECONDARY |
| XniftyHealthCheckConfig | - | ヘルスチェック情報のエンベロープ |
| IPAddress | string | ヘルスチェック先IPアドレス |
| Port | string | ヘルスチェック先ポート |
| Protocol | string | ヘルスチェック種別 HTTP、HTTPS、TCP |
| ResourcePath | string | ヘルスチェック先パス |
| FullyQualifiedDomainName | string | ヘルスチェック先ドメイン名 |
| TTL | string | TTL値 |
| ResourceRecords | - | レコードの応答情報リストのエンベロープ |
| ResourceRecord | - | レコードの応答情報のエンベロープ |
| Value | string | レコード応答値 |
| XniftyComment | string | コメント |
| IsTruncated | string | 取得していないレコード情報がまだ存在しているかどうかを表します。trueまたはfalse |
| MaxItems | string | リクエストで指定した取得レコード最大件数 |
| NextRecordName | string | 取得していないレコード情報の取得開始レコード名 IsTruncatedがtrueの場合に設定されます。 |
| NextRecordType | string | 取得していないレコード情報の取得開始レコード名 IsTruncatedがtrueの場合に設定されます。 |
| NextRecordIdentifier | string | 取得していないレコード情報の取得開始レコード名 IsTruncatedがtrueの場合に設定されます。 |
リクエスト例#
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…
レスポンス例#
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>