GET recipient/(mail)

API情報

管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETrecipient/(mail)通知先メール情報の取得
  • 指定した通知先メールアドレスを取得します。

個別パラメータ

URL
フィールドタイプ必須意味
DoServiceCodeStringDNSアウトソースサービスのサービスコード
DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
MailRecipientIdString通知先メール情報のID
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
  • なし

 

 

レスポンス

フィールドタイプ意味
MailRecipientHash通知先メール情報のハッシュ
MailRecipient.MailRecipientIdString通知先メール情報のID
MailRecipient.MailAddressString通知先メールアドレス

エラーコード

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

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

  • DoServiceCode
  • DowOptionCode
  • ZoneName
 
リソースエラー200ResourceNotExistResource is not found.

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

  • 契約情報
  • オプション情報
  • ゾーン 
  • 通知先メール情報

 

UnrelateErrorResource is unrelated to other resources.

以下それぞれのリソースの組み合わせが正しくない

  • 契約情報
  • オプション情報
  • ゾーン 
 

制限

  • 契約外のゾーン情報は取得できません。

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/recipient/mail/(MailRecipientId).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)

レスポンスボディ

JSON
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "MailRecipient": {
        "MailRecipientId": "12",
        "MailAddress": "aaaa@example.com"
    }
}