POST target

API情報

管理権限HTTPメソッドAPI名目的
不要POSTtarget監視対象の作成
  • 監視対象の種別を指定して、監視対象を作成します。
  • 同一グループにホスト名とIPアドレスを共存して登録することはできません。

個別パラメータ

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

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

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

 

LabelString×監視対象に設定されているラベル

 

 

レスポンス

フィールドタイプ意味
MonitoringTargetHash新規作成された監視対象のハッシュ
MonitoringTarget.TargetTypeString新規作成された監視対象の種別 (IPV4 / IPV6 / HOST)
MonitoringTarget.TargetIdString新規作成された監視対象のID
MonitoringTarget.EntityString新規作成された監視対象 (IPv4アドレス / IPv6アドレス / ホスト名)
MonitoringTarget.LabelString新規作成された監視対象のラベル
MonitoringTarget.MonitoringEnabledString

新規作成された監視対象の状態(新規作成時は DISABLE )

エラーコード

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

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

  • DoServiceCode
  • DowOptionCode
  • ZoneName
  • GroupType
  • TargetType
  • Entity
  • Label
 
リソースエラー  200  ForbiddenResourceOperate to the specified resource has been forbidden.許可していない組み合わせの監視対象をグループ内に登録しようとした 
ResourceNotExistResource is not found.

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

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

 

ResourceAlreadyExistResource is found.

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

  • 監視対象
 
UnrelateErrorResource is unrelated to other resources.

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

  • 契約情報
  • オプション情報
  • ゾーン
  • グループ
 
UpperLimitErrorAn upper limit value exists.

以下のリソースが上限数存在している

  • 監視対象
 

制限

  • 契約外のゾーンに対する操作は実行できません。
  • 作成した監視対象を更新することはできません。(ラベルを除く)

サンプル

リクエスト

POST /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/(GroupType)/target/(TargetType).json HTTP/1.1
Host: do.api.iij.jp
Content-Type: application/json
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)
 
{
    "Entity": "192.0.2.1",
    "Label": "関東 Web サーバ (IPv4)"
}

レスポンスボディ

JSON
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "MonitoringTarget": {
        "TargetType": "IPV4",
        "TargetId": "12345",
        "Entity": "192.0.2.1",
        "Label": "関東 Web サーバ (IPv4)",
        "MonitoringEnabled": "DISABLE"
    }
}