PUT target/(monitoring)

API情報

管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要PUTtarget/(monitoring)監視の更新
  • 監視対象に紐づく監視を更新します。
  • 監視失敗回数 (FailCount) は 1 から 20 を設定可能です。
  • 監視間隔 (MonitoringInterval) は「30, 60, 120, 180, 240, 300, 360, 420, 480, 540, 600(単位/秒)」から設定可能です。
  • タイムアウト値は、「1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30 (単位/秒)」から設定可能です。

個別パラメータ

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

DNSアウトソースサービスのサービスコード

DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
GroupTypeStringグループ名 (ACTIVE / STANDBY)
TargetTypeString監視対象種別 (IPV4 / IPV6 / HOST)
TargetIdString監視対象のID
MonitoringTypeString監視種別 (PING / PORT / HTTP)
MonitoringIdString監視のID
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
・監視種別共通で指定可能なリクエスト
フィールド
タイプ
必須
意味
TimeoutString×タイムアウト値 (PINGとPORTのデフォルトは5、HTTPのデフォルトは2)
FailCountString×失敗回数 (デフォルトは3)
MonitoringIntervalString×監視間隔 (デフォルトは30)
・監視種別が"PORT"の場合に指定可能なリクエスト
フィールド
タイプ
必須
意味
PortStringポート番号
ProtocolStringプロトコル
・監視種別が"HTTP"の場合に指定可能なリクエスト
フィールド
タイプ
必須
意味
SecureStringSSLの有効/無効 (ENABLE / DISABLE)
HostString×ホストヘッダ (例: www.example.jp)
PathString×パス (例: index.html)
StatusCodeString×ステータスコード (例: 200)
ResponseKeyString×httpレスポンスボディに含まれる文字列

レスポンス

エラーコード

エラー
 
ErrorType
ErrorMessage
説明
備考
パラメータエラー200ParameterErrorThere are invalid parameters.

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

  • DoServiceCode
  • DowOptionCode
  • ZoneName
  • GroupType
  • TargetType
  • TargetId
  • MonitoringType
  • MonitoringId
  • 各監視パラメータ
 
リソースエラー 200 ResourceNotExistResource is not found.

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

  • 契約情報
  • オプション情報
  • ゾーン 
  • グループ
  • 監視対象
  • 監視

 

ResourceAlreadyExistResource is found.

以下リソースがすでに存在している

  • 監視
 
UnrelateErrorResource is unrelated to other resources.

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

  • 契約情報
  • オプション情報
  • ゾーン 
  • グループ
  • 監視対象
  • 監視
 
NoUpdateResource has not been updated.

パラメータが1つも変化していない

 
MonitoringFailed
Monitoring has failed.

監視が失敗しているため更新できない

(※ エラーレスポンスの「JSON (MonitoringFailed 発生時)」を参照してください)

 

制限

  • 契約外のゾーンに対する操作は実行できません。
  • 監視対象が有効の際に、監視を更新する場合、以下の制限があります。
    • 監視対象に紐づく監視が1つでも失敗している場合は、監視を更新できません。
    • 作成対象の監視が即時に1回実行され、失敗した場合は監視を更新できません。

サンプル

リクエスト

PUT /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/(GroupType)/target/(TargetType)/(TargetId)/monitoring/(MonitoringType)/(MonitoringId).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)

{
    "Timeout": "5",
    "FailCount": "2",
    "MonitoringInterval": "120"
}

レスポンスボディ

JSON
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
}