GET target/(monitorings)

API情報

管理権限HTTPメソッドAPI名/(サブAPI名)目的
不要GETtarget/(monitorings)監視対象に紐付く監視一覧取得
  • 監視対象の種別とIDを指定して、監視対象に紐づく監視一覧を取得します。
  • 監視の設定値が空である場合、その監視のフィールドはレスポンスに含まれません。
    (例:MonitoringList.Host が設定されていない場合は、レスポンスに MonitoringList.Host は含まれません)

個別パラメータ

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

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

DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
GroupTypeStringグループ名 (ACTIVE / STANDBY)
TargetTypeString監視対象種別 (IPV4 / IPV6 / HOST)
TargetIdString監視対象のID
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
  • なし

レスポンス

監視種別共通のレスポンス
フィールドタイプ意味
MonitoringListArray監視のリスト
MonitoringList.MonitoringTypeString監視種別 (PING / PORT / HTTP)
MonitoringList.MonitoringIdString監視のID
MonitoringList.StatusString監視ステータス (OK / NG / PENDING)
MonitoringList.TimeoutStringタイムアウト値
MonitoringList.FailCountString失敗回数
MonitoringList.MonitoringIntervalString監視間隔
監視種別が"PORT"の場合のみ返されるレスポンス
フィールドタイプ意味
MonitoringList.PortStringポート番号
MonitoringList.ProtocolStringプロトコル
監視種別が"HTTP"の場合のみ返されるレスポンス
フィールドタイプ意味
MonitoringList.SecureString

SSLの有効/無効 (ENABLE / DISABLE) 

MonitoringList.HostStringホストヘッダ (例: www.example.jp)
MonitoringList.PathStringパス (例: index.html)
MonitoringList.StatusCodeStringステータスコード (例: 200)

MonitoringList.ResponseKey

String

httpレスポンスボディに含まれる文字列

エラーコード

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

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

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

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

  • 契約情報
  • オプション情報
  • ゾーン 
  • グループ
  • 監視対象
 
UnrelateErrorResource is unrelated to other resources.

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

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

制限

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

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/(GroupType)/target/(TargetType)/(TargetId)/monitorings.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",
    "MonitoringList": [
        {
            "MonitoringType": "PORT",
            "MonitoringId": "12345",
            "Status": "OK",
            "Timeout": "5",
            "FailCount": "3",
            "MonitoringInterval": "180",
            "Port": "80",
            "Protocol": "TCP"
        },
        {
            "MonitoringType": "PING",
            "MonitoringId": "12345",
            "Status": "NG",
            "Timeout": "5",
            "FailCount": "1",
            "MonitoringInterval": "30",
        },
        ・
        ・
        ・ 
        {
            "MonitoringType": "HTTP",
            "MonitoringId": "12345",
            "Status": "OK",
            "Timeout": "2",
            "FailCount": "20",
            "MonitoringInterval": "60",
            "Secure": "ENABLE",
            "Path": "/index.html",
            "ResponseKey": "sample"
        }     
    ]
}