プライベートネットワーク/V情報一覧取得

API情報
API種別メソッドURI対象名称実行
契約、設定GET/:GisServiceCode/private-networks.json?StartIndex=N&Count=Mプライベートネットワーク/Vプライベートネットワーク/V情報一覧取得同期
  • 指定したP2契約GisServiceCodeに所属するプライベートネットワーク/Vの情報一覧を取得します


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########
クエリストリングStartIndex StartIndexだけスキップした位置から情報を取得する数値
 Count 取得する情報の最大数数値
レスポンス
フィールドタイプ意味
PrivateNetworkListArrayプライベートネットワーク/V情報 
ServiceCodeStringプライベートネットワーク/Vのサービスコードivl########
LabelStringラベル文字列
ContractStatusString契約状態 
StartDateString利用開始日YYYYMMDD
StopDateString解約予定日YYYYMMDD
NetworkAddressStringプライベートネットワーク/Vで利用されているネットワークアドレスIPv4アドレス/ネットマスク長
AttachedVirtualServerListArrayプライベートネットワーク/Vに接続された仮想サーバ一覧オブジェクトの配列
AttachedVirtualServerList.ServiceCodeStringサービスコードivm########, ivd########, ifl########
AttachedVirtualServerList.URIString情報へアクセスするためのURIURI
AttachedVirtualServerList.TypeString仮想サーバ品目 
AttachedVirtualServerList.OSTypeStringOS種別"Linux", "Windows"
AttachedVirtualServerList.MacAddressString接続されたネットワークインターフェイスのMACアドレスxx-xx-xx-xx-xx-xx
AttachedFwLbListArrayプライベートネットワーク/Vに接続されたFW+LB一覧オブジェクトの配列
AttachedFwLbList.ServiceCodeStringサービスコードifl########
AttachedFwLbList.URIString情報へアクセスするためのURIURI
AttachedFwLbList.NetworkInterfaceStringインターナルか、エクスターナルか

"Internal", "External" 

AttachedFwLbList.IpAddressStringIPアドレスIPv4アドレス
AttachedUomGatewayObjectプライベートネットワーク/Vが接続された監視・運用ゲートウェイ
AttachedUomGateway.ServiceCodeStringIIJ GIO統合運用管理サービスのサービスコードuom########
AttachedUomGateway.IPv4.IpAddressString監視・運用ゲートウェイに設定されたゲートウェイアドレスIPv4アドレス
AttachedBestEffortFwLbListArrayプライベートネットワーク/Vに接続されたFW+LBベストエフォートタイプ一覧オブジェクトの配列
AttachedBestEffortFwLbList.ServiceCodeStringサービスコードilb########
AttachedBestEffortFwLbList.URIString

情報へアクセスするためのURI


URI
AttachedBestEffortFwLbList.NetworkInterfaceStringインターナルか、エクスターナルか"Internal" "External"
AttachedBestEffortFwLbList.IpAddressStringIPアドレスIPアドレス
AttachedFirewallListArrayプライベートネットワーク/Vに接続されたファイアウォール一覧オブジェクトの配列
AttachedFirewallList.ServiceCodeStringサービスコードifw########
AttachedFirewallList.URIString情報へアクセスするためのURIURI
AttachedFirewallList.NetworkInterfaceStringインターナルか、エクスターナルか"Internal" "External"
AttachedFirewallList.IpAddressStringIPアドレスIPアドレス
MonitoringIpAddressListArrayプライベートネットワーク/V上で登録された監視用IPアドレスオブジェクトの配列
MonitoringIpAddressList.MonitoringTargetServiceCodeString監視対象となるホストのサービスコードivm########, ivd######## ,ifl########
MonitoringIpAddressList.HostIpAddressString監視対象のホストIPアドレスIPv4アドレス
MonitoringIpAddressList.MonitoringIpAddressString監視用IPアドレスIPv4アドレス
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

無し

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "PrivateNetworkList": [
        {
            "ServiceCode": "ivl#######1",
            (略)プライベートネットワーク/V情報取得と同じ
        },
        {
            "ServiceCode": "ivl#######2",
            (略)プライベートネットワーク/V情報取得と同じ
        },
        {
            "ServiceCode": "ivl#######3",
            (略)プライベートネットワーク/V情報取得と同じ
        }
    ]
}