GET targets

API情報

管理権限HTTPメソッドAPI名目的
不要GETtargets監視対象一覧の取得
  • 指定したグループの全ての監視対象を取得します。

個別パラメータ

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

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

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

レスポンス

フィールドタイプ意味
MonitoringTargetListArray監視対象のリスト
MonitoringTargetList.TargetTypeString監視対象の種別 (IPV4 / IPV6 / HOST)
MonitoringTargetList.TargetIdString監視対象のID
MonitoringTargetList.EntityString監視対象 (IPv4アドレス / IPv6アドレス / ホスト名)
MonitoringTargetList.LabelString監視対象のラベル
MonitoringTargetList.MonitoringEnabledString

監視対象の有効/無効 (ENABLE / DISABLE)

エラーコード

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

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

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

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

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

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

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

制限

  • 契約外のゾーン情報は取得できません。
  • ラベルの登録がない場合は、MonitoringTargetList.Label は空文字となります。

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/(GroupType)/targets.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",
    "MonitoringTargetList": [
        {
            "TargetType": "IPV4",
            "TargetId": "12345",
            "Entity": "192.0.2.1",
            "Label": "関東 Web サーバ (IPv4)",
            "MonitoringEnabled": "ENABLE"
        },
        ・
        ・
        ・
    ]
}