本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>DNS>共通フォーマット

DNS:共通フォーマット

ヘッダー

リクエストヘッダー
要素名 説明 備考
Host 呼び出し先のホスト名。
値は、一律で「dns.api.cloud.nifty.com」となる。
文字列  
Content-Length リクエストボディのサイズ。 数値 POSTリクエストのみ
Content-Type リクエストボディの種別。
値は、一律で「text/xml」となる。
文字列 POSTリクエストのみ
レスポンスヘッダー
要素名 説明 備考
X-Nifty-RequestId この操作にシステムが一意に割り振ったID。
ユーザーからの問い合わせで、操作の特定を行う際などに利用する。
文字列  
Content-Length レスポンスボディのサイズ。 数値  
Content-Type レスポンスボディの種別。
値は、一律で「text/xml」となる。
文字列  
Date レスポンスが返された日時。 文字列  

エラーレスポンス

XML

API呼び出し前のエラー

APIのパスが間違っているなどでAPIが呼び出される前にエラーとなった場合、レスポンスは一律で下記となります。

要素名 説明 備考
AccessDeniedException ルート  
Message Unable to determine service/operation name to be authorized 文字列  
API実行時のエラー

API内部にてエラーが発生した場合、レスポンスは下記のフォーマットとなります。

要素名 説明 備考
ErrorResponse ルート  
Error エラーの内容  
Type エラー種別 文字列  
Code エラーコード 文字列  
Message エラーメッセージ 文字列  
RequestId 操作ID 文字列  
共通エラー一覧
コード メッセージ HTTPステータスコード
MalformedXML The request xml is malformed 400
InappropriateXML Inappropriate XML 400
InvalidInput The specified marker is not valid
maxitems must be a positive integer
The specified %item% is not valid
The specified Action is not valid [host_name: %host_name%, type: %type%, content: %content%]
The specified Failover is not valid [host_name: %host_name%, type: %type%, content: %content%]
The specified Value is not valid [host_name: %host_name%, type: %type%, content: %content%]
The number of Change is over
CONTRACT DOMAIN OVER
CONTRACT LBR OVER
CONTRACT RECORD OVER
CONTRACT ZONE OVER
INVALID DNS POLICY
INVALID LBR RECORD
INVALID LTR RECORD CONTENT
INVALID PARAMETER
INVALID PARAMETER
INVALID POLICY
INVALID PTR RECORD CONTENT
INVALID PTR RECORD HOST NAME
INVALID PTR RECORD LOOKUP
INVALID RECORD CNAME CONTENT
INVALID RECORD CNAME HOST
INVALID RECORD FORMAT
INVALID RECORD LBR HOST
INVALID RECORD MX CONTENT
INVALID RECORD NS CONTENT
INVALID RECORD ROOT CNAME
INVALID RECORD ROOT NS
INVALID RECORD STATUS
INVALID RESERVE LIST
INVALID USER IP
INVALID ZONE NAME
NO SUCH LBR EXIST
NO SUCH RECORD EXIST
NO SUCH RECORD EXIST
NOT MODIFIED
REGISTERED LBR
REGISTERED PRIMARY RECORD
REGISTERED RECORD
UNABLE TO USE WILD CARD
400
AuthFailed Invalid Parameter, %parameter%(%value%).
Invalid Parameter, %parameter1%、%parameter2%.
Invalid Header, %header1%、%header2%.
Invalid Header and Parameter, %Header% ,%parameter%.
Invalid Header, %Header%(%value%).
%parameter% for the %Header% Header is invalid.
Authentication method does not match.
400
InvalidURI Invalid URI 400
AccessDenied Invalid Access Key Id.
Signature does not match.
Account is inactive.
Can not use this service.
Invalid User ID
PERMISSION DENIED
403
InternalError System error 500
NotImplemented Not implemented 503
ServiceUnavailable Service unavailable 503

共通データ形式

ゾーン情報
要素名 説明 備考
HostedZone ルート  
Id ゾーンID 文字列 正規化したゾーン名
Name ゾーン名(ドメイン) 文字列 正規化したゾーン名
CallerReference ゾーン識別子 文字列 正規化したゾーン名
Config ゾーンの付加情報  
Comment コメント(ゾーン) 文字列 リクエストで指定した値
ResourceRecordSetCount レコード設定数 数値  
ネームサーバー情報
要素名 説明 備考
DelegationSet ルート  
NameServers NSドメインのリスト  
NameServer NSドメイン 文字列  
レコード情報
要素名 説明 備考
ResourceRecordSet ルート  
Name ゾーンID 文字列  
Type レコード種別
値:NS | A | AAAA | CNAME | MX | TXT | PTR | LBR
文字列  
SetIdentifier レコード識別情報 文字列  
Weight 重み付け値 数値 WRR利用時のみ設定
Region リージョン情報 文字列 登録時無視/表示時空
XniftyDefaultHost デフォルトホスト情報 文字列 LBR利用時のみ設定、空可
Failover フェイルオーバー種別
値:PRIMARY | SECONDARY
文字列 Failover利用時のみ設定
XniftyHealthCheckConfig ヘルスチェック情報 Failover利用時のみ設定
IPAddress ヘルスチェック先IPアドレス 文字列  
Port ヘルスチェック先ポート 数値  
Protocol ヘスルチェック種別
値:HTTP | HTTPS | TCP
文字列  
ResourcePath ヘルスチェック先パス 文字列 ProtocalがHTTPの場合のみ
FullyQualifiedDomainName ヘルスチェック先ドメイン 文字列 ProtocalがHTTPの場合のみ
TTL TTL値 数値 LBRの場合不要
ResourceRecords レコードの応答情報のリスト  
ResourceRecord レコードの応答情報  
Value レコード応答値 文字列  
XniftyComment コメント 文字列  
更新リクエスト情報
要素名 説明 備考
ChangeInfo ルート  
Id 更新リクエストID 文字列  
Status 反映ステータス
値:PENDING | INSYNC
文字列  
SubmittedAt 更新リクエスト発行日時
値:yyyy-mm-ddThh:mm:ss.mmmZ
文字列  

推奨画面サイズ 1024×768 以上