プライベートネットワーク接続(監視・運用ゲートウェイ)

API情報
API種別メソッドURI対象名称実行
設定POST/:GisServiceCode/uom-gateway/private-networks.json監視・運用ゲートウェイプライベートネットワーク接続非同期
  • 運用監視ゲートウェイに指定したプライベートネットワークを接続します
  • プライベートネットワーク/Vを接続する前に、必ずIIJ統合運用管理サービスで監視対象の監視を停止してください。プライベートネットワーク/Vを接続することで監視・運用ゲートウェイが設定中の状態になり、IIJ統合運用管理サービス連携での監視が正常に行われず、監視対象に異常が発生したことになります


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
ボディServiceCode接続するネットワークのサービスコードivl########
 IPv4監視・運用ゲートウェイに割り当てるゲートウェイアドレス 
 IPv4.IpAddressゲートウェイアドレスIPv4アドレス
 IPv4.Netmaskゲートウェイのネットマスク長数字
レスポンス
フィールドタイプ意味
ResourceStatusString監視・運用ゲートウェイのステータス 
ServiceCodeString接続されているネットワークのサービスコードivl########
IPv4Object監視・運用ゲートウェイに割り当てられたゲートウェイアドレス 
IPv4.IpAddressStringゲートウェイアドレスIPv4アドレス
IPv4.NetmaskStringゲートウェイのネットマスク長数字
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

{
    "ServiceCode": "ivl#######1"
    "IPv4": {
        "IpAddress" : "192.168.0.11",
        "Netmask" : "24"
    }
}

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "ResourceStatus": "Configuring",
    "ServiceCode": "ivl#######1",
    "IPv4": {
        "IpAddress" : "192.168.0.11",
        "Netmask" : "24"
    }
}