脆弱性見える化ソリューションAPI

Overview

本APIは、NTT ComのWide Angle 脆弱性見える化ソリューションのシステム情報、ホスト情報、対策ステイタス等の情報の登録、参照、変更、削除を可能とするAPIです。

Resource URL

https://api.ntt.com/v1/vvsapi/

Resource Information

Key Value
リクエストフォーマット JSON
レスポンスフォーマット JSON
認証(OAuth) Yes

API一覧

用語集

Name Description
agentId ホストを一意に定める脆弱性見える化ソリューション内部の管理ID

システム情報全般(概要検索)

システム情報の概要を参照するAPIです。
各種APIを利用する対象システムの絞り込みにご利用ください。

POST /v1/vvsapi/global-search

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
offset オフセット値 String
limit (#1) 返却数上限値 String
orgName (#2) 組織名 String
sysId (#2) システムID String
sysName (#2) システム名 String
systemRegStatuses (#3) システム情報登録ステイタスリスト String array or Int array
intOpenFlg (#4) インターネット公開有無(システム詳細情報) String or Int
useSoftwares (#5) 利用ソフトウェア Object array
sidfmApplicationName (#6) ソフトウェア名 String Yes
sidfmApplicationVersion バージョン String
  • #1 指定しない場合、最大50件が返却される
  • #2 部分一致で検索する
  • #3 <候補値>
    0:未完了
    10:システム責任者登録(未完了)
    20:システム担当者登録(未完了)
    30:システム情報登録(未完了)
    40:システム情報登録(完了)※IPアドレス・ホスト情報登録(いずれも未完了)
    41:IPアドレス情報登録(未完了)
    42:ホスト情報登録(未完了)
    50:完了
  • #4 <候補値>
    0:無、1:有(システム詳細情報で登録した情報を検索対象とする)
  • #5 3つまで設定可。
    ソフトウェア名とバージョンはそれぞれ部分一致で検索
    (複数件指定時はAND検索として検索)
  • #6 利用ソフトウェアを検索条件に指定する場合は必須

Example Request

{
  "orgName": "サンプル組織",
  "sysId": "SAMPLE0001",
  "sysName": "サンプルシステム",
  "systemRegStatuses": [
    "41",
    "42"
  ],
  "intOpenFlg": "1",
  "useSoftwares": [
    {
      "sidfmApplicationName":"sample-os",
      "sidfmApplicationVersion":"1.0"
    },
    {
      "sidfmApplicationName":"sample-ap",
      "sidfmApplicationVersion":"2.0"
    }
  ]
}

Response Parameters

Name Description Type
systems システム情報 Object array
sysId システムID String
sysName システム名 String
orgName 組織名 String
systemAdministrator システム責任者 String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "result": {
    "systems": [
      {
        "sysId": "SAMPLE0001",
        "sysName": "サンプルシステム",
        "orgName": "サンプル組織",
        "systemAdministrator": "システム責任者"
      },
      {
        "sysId": "SAMPLE0002",
        "sysName": "サンプルシステム2",
        "orgName": "サンプル組織",
        "systemAdministrator": "システム責任者"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

システム情報全般(詳細検索)

本APIは、指定したシステムIDのシステム情報を参照するAPIです。

GET /v1/vvsapi/system-all?sysId={sysId}&offset={offset}&limit={limit}

Request Parameters

Name Description Type Mandatoty
sysId システムID String Yes
offset オフセット値 String
limit (#1) 返却数上限値 String
  • #1 指定しない場合、最大50件が返却される

Response Parameters

Name(Nest1) Name(Nest2) Name(Nest3) Description Type
sysId システムID String
sysName システム名 String
orgName 組織名 String
systemAdministrator システム責任者 String
systemServiceNames サービス責任者リスト String array
systemPersons システム担当者リスト String array
notes1 備考1(システム基本情報) String
notes2 備考2(システム基本情報) String
notes3 備考3(システム基本情報) String
notes4 備考4(システム基本情報) String
notes5 備考5(システム基本情報) String
adminNotes1 管理者用備考1(システム基本情報) String
adminNotes2 管理者用備考2(システム基本情報) String
adminNotes3 管理者用備考3(システム基本情報) String
systemStartDate 運用開始時期(yyyy-mm形式) String
siteAddr 設置場所住所 String
buildingDatacenterName ビル/データセンター名 String
domainName ドメイン名 String
cooperationSysName 連携システム名 String
serverNum サーバ台数 Int
usrClassificationCodes (#1) 利用者分類情報リスト Int array
usrClassification 利用者分類情報(その他) String
usageCode (#2) 使用目的(システム情報) Int
usage 使用目的(その他)(システム情報) String
useStatus (#3) 使用状況(システム情報) Int
intOpenFlg (#4) インターネット公開有無(システム情報) Int
accessEnvironmentLevels (#5) 利用者アクセス環境リスト(システム情報) Int array
piTypeCode (#4) 個人情報有無(システム情報) Int
handlingInfoLevels (#6) 取扱利用者情報リスト(システム情報) Int array
ideTypeCode (#4) IDS導入有無(システム情報) Int
ideProductName IDS製品名/サービス名(システム情報) String
ipsTypeCode (#4) IPS導入有無(システム情報) Int
ipsProductName IPS製品名/サービス名(システム情報) String
antiSpamTypeCode (#4) アンチスパム導入有無(システム情報) Int
antiSpamProductName アンチスパム製品名/サービス名(システム情報) String
antiVirusTypeCode (#4) アンチウイルス導入有無(システム情報) Int
antiVirusProductName アンチウィルス製品名/サービス名(システム情報) String
wafTypeCode (#4) WAF導入有無(システム情報) Int
wafProductName WAF製品名/サービス名(システム情報) String
nwDiag (#7,#8) ネットワーク診断可否(システム情報) Int
nwDiagHoursCode (#7,#9) ネットワーク診断希望時間帯 Int
nwDiagOffReasonCode (#7,#10) ネットワーク診断不可理由(システム情報) Int
nwDiagOffReason (#7) ネットワーク診断不可理由詳細(システム情報) String
nwDiagAvailabilityRedistrateTime (#7,#11) ネットワーク診断可否登録日時(システム情報) String
nwDiagAvailabilityRedistratedBy (#7) ネットワーク診断可否登録者(システム情報) String
nwDiagOffApprovalOrRejectTime (#7,#11) ネットワーク診断不可承認/否認日時(システム情報) String
nwDiagOffApprovedOrRejectedBy (#7) ネットワーク診断不可承認/否認者(システム情報) String
nwDiagOffAprStatusCode (#7,#12) ネットワーク診断不可承認/否認(システム情報) Int
nwDiagOffAppReason (#7) ネットワーク診断不可承認理由(システム情報) String
nwDiagOffRejReasonCode (#7,#13) ネットワーク診断不可否認種別(システム情報) Int
nwDiagOffRejReason (#7) ネットワーク診断不可否認理由(システム情報) String
detailNotes1 備考1(システム詳細情報) String
detailNotes2 備考2(システム詳細情報) String
detailNotes3 備考3(システム詳細情報) String
detailNotes4 備考4(システム詳細情報) String
detailNotes5 備考5(システム詳細情報) String
detailNotes6 備考6(システム詳細情報) String
detailNotes7 備考7(システム詳細情報) String
detailNotes8 備考8(システム詳細情報) String
detailNotes9 備考9(システム詳細情報) String
detailNotes10 備考10(システム詳細情報) String
systemLastUpdateTime (#11) 最終更新日時(システム情報) String
systemLastUpdatedBy 最終更新者(システム情報) String
systemNetworks ネットワーク情報 Object array
sysNwSeqNo システムネットワーク通番 Int
ipAddrStart 開始IPアドレス String
ipAddrEnd 終了IPアドレス String
isGlobal (#14) ネットワーク種別 Int
comLineCntrCode (#15) 通信回線 Int
comLineCntrText 通信回線(その他) String
comLineId 通信回線ID String
note1 備考1(ネットワーク情報) String
note2 備考2(ネットワーク情報) String
note3 備考3(ネットワーク情報) String
systemNetworkLastUpdateTime (#11) 最終更新日時(ネットワーク情報) String
systemNetworkLastUpdatedBy 最終更新者(ネットワーク情報) String
ipAddressInfos IPアドレス情報 Object array
devId 機器ID Int
sysNwSeqNo システムネットワーク通番 Int
ipAddr IPアドレス String
isGlobal (#14) IP種別(ネットワーク種別と同じ値) Int
devName IP識別名 String
devFound (#4) ホスト接続有無 Int
useStatusCode (#16) 使用状況(IPアドレス情報) Int
nwDiag (#7,#8) ネットワーク診断可否(IPアドレス情報) Int
nwDiagOffReasonCode (#7,#10) ネットワーク診断不可理由(IPアドレス情報) Int
nwDiagOffReason (#7) ネットワーク診断不可理由詳細(IPアドレス情報) String
nwDiagAvailabilityRedistrateTime (#7,#11) ネットワーク診断可否登録日時(IPアドレス情報) String
nwDiagAvailabilityRedistratedBy (#7) ネットワーク診断可否登録者(IPアドレス情報) String
nwDiagOffApprovalOrRejectTime (#7,#11) ネットワーク診断不可承認/否認日時(IPアドレス情報) String
nwDiagOffApprovedOrRejectedBy (#7) ネットワーク診断不可承認/否認者(IPアドレス情報) String
nwDiagOffAprStatusCode (#7,#12) ネットワーク診断不可承認/否認(IPアドレス情報) Int
nwDiagOffAppReason (#7) ネットワーク診断不可承認理由(IPアドレス情報) String
nwDiagOffRejReasonCode (#7,#13) ネットワーク診断不可否認種別(IPアドレス情報) Int
nwDiagOffRejReason (#7) ネットワーク診断不可否認理由(IPアドレス情報) String
notes1 備考1(IPアドレス情報) String
notes2 備考2(IPアドレス情報) String
notes3 備考3(IPアドレス情報) String
adminNotes1 管理者用備考1(IPアドレス情報) String
adminNotes2 管理者用備考2(IPアドレス情報) String
adminNotes3 管理者用備考3(IPアドレス情報) String
ipLastUpdateTime (#11) 最終更新日時(IPアドレス情報) String
ipLastUpdatedBy 最終更新者(IPアドレス情報) String
hostInfos ホスト情報 Object array
agentId エージェントID Int
hostName ホスト名 String
hostIpAddresses IPアドレスリスト Object array
sysNwSeqNo システムネットワーク通番 Int
ipAddr IPアドレス String
usageCodes (#17) 使用目的リスト(ホスト情報) Int array
usageText 使用目的(その他)(ホスト情報) String
intOpenFlg (#4) インターネット公開有無(ホスト情報) Int
accessEnvironmentLevels (#5) 利用者アクセス環境リスト(ホスト情報) Int array
piTypeCode (#4) 個人情報有無(ホスト情報) Int
handlingInfoLevels (#6) 取扱利用者情報リスト(ホスト情報) Int array
useSoftwares 利用ソフトウェア(プロダクト) Object array
sidfmApplicationName ソフトウェア String
sidfmApplicationVersion バージョン String
osApTypeCode (#18) 種別情報 Int
supplementaryInfo 補足情報(バージョン等) String
excludedSoftwares マッチング除外ソフトウェアリスト String array
antiVirusTypeCode (#4) アンチウイルス導入有無(ホスト情報) Int
antiVirusProductName アンチウィルス製品名/サービス名(ホスト情報) String
virtualPatchTypeCode (#4) 仮想パッチ/IDS/IPS導入有無(ホスト情報) Int
virtualPatchProductName 仮想パッチ/IDS/IPS製品名/サービス名(ホスト情報) String
wafTypeCode (#4) WAF導入有無(ホスト情報) Int
wafProductName WAF製品名/サービス名(ホスト情報) String
notes1 備考1(ホスト情報) String
notes2 備考2(ホスト情報) String
notes3 備考3(ホスト情報) String
adminNotes1 管理者用備考1(ホスト情報) String
adminNotes2 管理者用備考2(ホスト情報) String
adminNotes3 管理者用備考3(ホスト情報) String
hostLastUpdateTime (#11) 最終更新日時(ホスト情報) String
hostLastUpdatedBy 最終更新者(ホスト情報) String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    1:法人(一般), 2:法人(特定), 3:個人(一般)
    4:個人(特定), 5:法人及び個人(一般), 6:法人及び個人(特定)
    7:社内(一般), 8:社内(特定), 99:その他
  • #2 <候補値>
    1:社内用ITシステム, 2:インターネット経由の監視/保守用
    3:開発/検証/デモ用, 4:プロダクト提供用(お客様貸し出し用含む)
    5:お客様システム(開発/保守受託)
    6:委託先システムを利用したサービスの提供
    7:委託先システムの自社利用,99:その他
  • #3 <候補値>
    0:未使用(サービス準備中), 1:使用(サービス提供中)
    2:使用(廃止予定), 3:廃止(除却前), 4:廃止(除却済)
    5:廃止(資産なし), 6:取消(開発中止), 7:取消(誤登録)
    8:未使用(サービス廃止)
  • #4 <候補値>
    0:無, 1:有
  • #5 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限)
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限)
    5:その他, 99:不明
  • #6 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #7 ネットワーク診断利用契約を締結していない場合にはnullが出力されます。
  • #8 <候補値>
    0:診断不可, 1:診断可
  • #9 <候補値>
    0: 00:00~24:00(希望設定なし), 1: 00:00~09:59, 2: 10:00~13:59,
    3: 14:00~17:59, 4: 18:00~23:59
  • #10 <候補値>
    1:独自で実施している, 2:お客様システムのため,
    3:委託先システムのため, 99:その他
  • #11 yyyy-mm-ddThh:mm:ss±hh:mm形式
  • #12 <候補値>
    10:ネットワーク診断不可承認不要, 20:不可承認待ち,
    30:不可承認メール送信待ち, 40:不可否認, 50:不可承認
  • #13 <候補値>
    1:ネットワーク診断不可理由コード選択が不適切, 2:ネットワーク診断不可理由が不適切,
    3:ネットワーク診断不可の対象外(診断可へ変更要),99:その他
  • #14 <候補値>
    0:プライベート, 1:グローバル
  • #15 <候補値>
    1:インターネット回線, 2:VPN回線, 3:専用線,
    4:契約なし(ローカルのみ), 99:その他
  • #16 <候補値>
    1:ネットワークアドレス, 2:ブロードキャストアドレス,
    3:ホストアドレス(サーバ), 4:ホストアドレス(クライアント),
    5:ホストアドレス(ネットワーク機器), 99:その他
  • #17 <候補値>
    1:WEB, 2:DNS, 3:Mail, 4:Firewall, 5:ルータ, 99:その他
  • #18 <候補値>
    1:OS, 2:AP, 3:その他, 4:未選択

Example Response

    {
      "result": {
        "sysId": "SAMPLE0001",
        "sysName": "サンプルシステム",
        "orgName": "サンプル組織",
        "systemAdministrator": "システム責任者",
        "systemServiceNames": [
          "サービス責任者"
        ],
        "systemPersons": [
          "システム担当者"
        ],
        "notes1": "サンプル:システム基本情報備考1",
        "notes2": "",
        "notes3": "",
        "notes4": "",
        "notes5": "",
        "adminNotes1": "サンプル:システム基本情報管理者用備考1",
        "adminNotes2": "",
        "adminNotes3": "",
        "systemStartDate": "2018-07",
        "siteAddr": "設置場所住所",
        "buildingDatacenterName": "ビル/データセンター名",
        "domainName": "ドメイン名",
        "cooperationSysName": "連携システム名",
        "serverNum": 10,
        "usrClassificationCodes": [
          1,
          99
        ],
        "usrClassification": "その他の利用者分類情報",
        "usageCode": 99,
        "usage": "その他の利用目的",
        "useStatus": 1,
        "intOpenFlg": 1,
        "accessEnvironmentLevels": [
          2,
          3
        ],
        "piTypeCode": 1,
        "handlingInfoLevels": [
          2,
          4
        ],
        "ideTypeCode": 1,
        "ideProductName": "IDS製品名/サービス名",
        "ipsTypeCode": 1,
        "ipsProductName": "IPS製品名/サービス名",
        "antiSpamTypeCode": 1,
        "antiSpamProductName": "アンチスパム製品名/サービス名",
        "antiVirusTypeCode": 1,
        "antiVirusProductName": "アンチウィルス製品名/サービス名",
        "wafTypeCode": 1,
        "wafProductName": "WAF製品名/サービス名",
        "nwDiag": 1,
        "nwDiagHoursCode": 0,
        "nwDiagOffReasonCode": null,
        "nwDiagOffReason": null,
        "nwDiagAvailabilityRedistrateTime": "2018-07-01T10:05:30+09:00",
        "nwDiagAvailabilityRedistratedBy": "ネットワーク診断可否登録者",
        "nwDiagOffApprovalOrRejectTime": null,
        "nwDiagOffApprovedOrRejectedBy": null,
        "nwDiagOffAprStatusCode": 10,
        "nwDiagOffAppReason": null,
        "nwDiagOffRejReasonCode": null,
        "nwDiagOffRejReason": null,
        "detailNotes1": "サンプル:システム詳細情報備考1",
        "detailNotes2": "",
        "detailNotes3": "",
        "detailNotes4": "",
        "detailNotes5": "",
        "detailNotes6": "",
        "detailNotes7": "",
        "detailNotes8": "",
        "detailNotes9": "",
        "detailNotes10": "",
        "systemLastUpdateTime": "2018-07-01T12:10:24+09:00",
        "systemLastUpdatedBy": "システム情報最終更新者",
        "systemNetworks": [
          {
            "sysNwSeqNo": 2,
            "ipAddrStart": "1.2.3.4",
            "ipAddrEnd": "1.2.3.4",
            "isGlobal": 1,
            "comLineCntrCode": 99,
            "comLineCntrText": "その他の通信回線",
            "comLineId": "通信回線ID",
            "note1": "サンプル:ネットワーク情報備考1",
            "note2": "",
            "note3": "",
            "systemNetworkLastUpdateTime": "2018-07-01T09:17:06+09:00",
            "systemNetworkLastUpdatedBy": "ネットワーク情報最終更新者"
          },
          {
            "sysNwSeqNo": 1,
            "ipAddrStart": "192.168.0.2",
            "ipAddrEnd": "192.168.0.5",
            "isGlobal": 0,
            "comLineCntrCode": 4,
            "comLineCntrText": null,
            "comLineId": "",
            "note1": "",
            "note2": "",
            "note3": "",
            "systemNetworkLastUpdateTime": "2018-07-01T19:17:06+09:00",
            "systemNetworkLastUpdatedBy": "ネットワーク情報最終更新者"
          }
        ],
        "ipAddressInfos": [
          {
            "devId": 100000,
            "sysNwSeqNo": 2,
            "ipAddr": "1.2.3.4",
            "isGlobal": 1,
            "devName": "サンプル:IP識別名",
            "devFound": 1,
            "useStatusCode": 3,
            "nwDiag": 1,
            "nwDiagOffReasonCode": null,
            "nwDiagOffReason": null,
            "nwDiagAvailabilityRedistrateTime": "2018-07-01T15:19:49+09:00",
            "nwDiagAvailabilityRedistratedBy": "IP単位ネットワーク診断可否登録者",
            "nwDiagOffApprovalOrRejectTime": null,
            "nwDiagOffApprovedOrRejectedBy": null,
            "nwDiagOffAprStatusCode": 10,
            "nwDiagOffAppReason": null,
            "nwDiagOffRejReasonCode": null,
            "nwDiagOffRejReason": null,
            "notes1": "サンプル:IPアドレス情報備考1",
            "notes2": "",
            "notes3": "",
            "adminNotes1": "サンプル:IPアドレス情報管理者用備考1",
            "adminNotes2": "",
            "adminNotes3": "",
            "ipLastUpdateTime": "2018-07-01T15:30:49+09:00",
            "ipLastUpdatedBy": "IPアドレス情報最終更新者"
          }
        ],
        "hostInfos": [
          {
            "agentId": 200000001,
            "hostName": "サンプル:ホスト名",
            "hostIpAddresses": [
              {
                "sysNwSeqNo": 1,
                "ipAddr": "192.168.0.2"
              },
              {
                "sysNwSeqNo": 2,
                "ipAddr": "1.2.3.4"
              }
            ],
            "usageCodes": [
              1,
              99
            ],
            "usageText": "その他の使用目的",
            "intOpenFlg": 1,
            "accessEnvironmentLevels": [
              2,
              3
            ],
            "piTypeCode": 1,
            "handlingInfoLevels": [
              2,
              4
            ],
            "useSoftwares": [
              {
                "sidfmApplicationName": "sample-os",
                "sidfmApplicationVersion": "1.0",
                "osApTypeCode": 1,
                "supplementaryInfo": "補足情報"
              },
              {
                "sidfmApplicationName": "sample-ap",
                "sidfmApplicationVersion": "2.0",
                "osApTypeCode": 2,
                "supplementaryInfo": ""
              }
            ],
            "excludedSoftwares": [
              "sample-ap"
            ],
            "antiVirusTypeCode": 1,
            "antiVirusProductName": "アンチウィルス製品名/サービス名",
            "virtualPatchTypeCode": 1,
            "virtualPatchProductName": "仮想パッチ/IDS/IPS製品名/サービス名",
            "wafTypeCode": 1,
            "wafProductName": "WAF製品名/サービス名",
            "notes1": "サンプル:ホスト情報備考1",
            "notes2": "",
            "notes3": "",
            "adminNotes1": "サンプル:ホスト情報管理者用備考1",
            "adminNotes2": "",
            "adminNotes3": "",
            "hostLastUpdateTime": "2018-07-01T16:18:57+09:00",
            "hostLastUpdatedBy": "ホスト情報最終更新者"
          }
        ]
      },
      "statusCode": "200",
      "statusDispNm": "OK"
    }

該当0件の場合(システムIDの指定誤り)

    {
      "statusCode": "200",
      "statusDispNm": "OK"
    }

システム基本情報検索

指定したシステムIDのシステム情報(基本情報、ネットワーク情報、詳細情報)を取得します。

GET /v1/vvsapi/basics?sysId={sysId}&offset={offset}&limit={limit}

Request Parameters

Name Description Type Mandatoty
sysId システムID String Yes
offset オフセット値 String
limit (#1) 返却数上限値 String
  • #1 指定しない場合、最大50件が返却される

Response Parameters

Name(Nest1) Name(Nest2) Description Type
sysId システムID String
sysName システム名 String
orgName 組織名 String
systemAdministrator システム責任者 String
systemServiceNames サービス責任者リスト Stringarray
systemPersons システム担当者リスト Stringarray
notes1 備考1(システム基本情報) String
notes2 備考2(システム基本情報) String
notes3 備考3(システム基本情報) String
notes4 備考4(システム基本情報) String
notes5 備考5(システム基本情報) String
adminNotes1 管理者用備考1(システム基本情報) String
adminNotes2 管理者用備考2(システム基本情報) String
adminNotes3 管理者用備考3(システム基本情報) String
systemStartDate 運用開始時期(yyyy-mm形式) String
siteAddr 設置場所住所 String
buildingDatacenterName ビル/データセンター名 String
domainName ドメイン名 String
cooperationSysName 連携システム名 String
serverNum サーバ台数 Int
usrClassificationCodes (#1) 利用者分類情報リスト Intarray
usrClassification 利用者分類情報(その他) String
usageCode (#2) 使用目的(システム情報) Int
usage 使用目的(その他)(システム情報) String
useStatus(#3) 使用状況(システム情報) Int
intOpenFlg (#4) インターネット公開有無(システム情報) Int
accessEnvironmentLevels (#5) 利用者アクセス環境リスト(システム情報) Intarray
piTypeCode (#4) 個人情報有無(システム情報) Int
handlingInfoLevels(#1) 取扱利用者情報リスト(システム情報) Intarray
ideTypeCode (#4) IDS導入有無(システム情報) Int
ideProductName IDS製品名/サービス名(システム情報) String
ipsTypeCode (#4) IPS導入有無(システム情報) Int
ipsProductName IPS製品名/サービス名(システム情報) String
antiSpamTypeCode (#4) アンチスパム導入有無(システム情報) Int
antiSpamProductName アンチスパム製品名/サービス名(システム情報) String
antiVirusTypeCode (#4) アンチウイルス導入有無(システム情報) Int
antiVirusProductName アンチウィルス製品名/サービス名(システム情報) String
wafTypeCode (#4) WAF導入有無(システム情報) Int
wafProductName WAF製品名/サービス名(システム情報) String
nwDiag (#7,#8) ネットワーク診断可否(システム情報) Int
nwDiagHoursCode (#7,#9) ネットワーク診断希望時間帯 Int
nwDiagOffReasonCode (#7,#10) ネットワーク診断不可理由(システム情報) Int
nwDiagOffReason (#7) ネットワーク診断不可理由詳細(システム情報) String
nwDiagAvailabilityRedistrateTime (#7,#11) ネットワーク診断可否登録日時(システム情報) String
nwDiagAvailabilityRedistratedBy (#7) ネットワーク診断可否登録者(システム情報) String
nwDiagOffApprovalOrRejectTime (#7,#11) ネットワーク診断不可承認/否認日時(システム情報) String
nwDiagOffApprovedOrRejectedBy (#7) ネットワーク診断不可承認/否認者(システム情報) String
nwDiagOffAprStatusCode (#7,#12) ネットワーク診断不可承認/否認(システム情報) Int
nwDiagOffAppReason (#7) ネットワーク診断不可承認理由(システム情報) String
nwDiagOffRejReasonCode (#7,#13) ネットワーク診断不可否認種別(システム情報) Int
nwDiagOffRejReason (#7) ネットワーク診断不可否認理由(システム情報) String
detailNotes1 備考1(システム詳細情報) String
detailNotes2 備考2(システム詳細情報) String
detailNotes3 備考3(システム詳細情報) String
detailNotes4 備考4(システム詳細情報) String
detailNotes5 備考5(システム詳細情報) String
detailNotes6 備考6(システム詳細情報) String
detailNotes7 備考7(システム詳細情報) String
detailNotes8 備考8(システム詳細情報) String
detailNotes9 備考9(システム詳細情報) String
detailNotes10 備考10(システム詳細情報) String
systemLastUpdateTime (#11) 最終更新日時(システム情報) String
systemLastUpdatedBy 最終更新者(システム情報) String
systemNetworks ネットワーク情報 Object array
sysNwSeqNo システムネットワーク通番 Int
ipAddrStart 開始IPアドレス String
ipAddrEnd 終了IPアドレス String
isGlobal (#14) ネットワーク種別 Int
comLineCntrCode (#15) 通信回線 Int
comLineCntrText 通信回線(その他) String
comLineId 通信回線ID String
note1 備考1(ネットワーク情報) String
note2 備考2(ネットワーク情報) String
note3 備考3(ネットワーク情報) String
systemNetworkLastUpdateTime (#11) 最終更新日時(ネットワーク情報) String
systemNetworkLastUpdatedBy 最終更新者(ネットワーク情報) String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    1:法人(一般), 2:法人(特定), 3:個人(一般),
    4:個人(特定), 5:法人及び個人(一般), 6:法人及び個人(特定),
    7:社内(一般), 8:社内(特定), 99:その他
  • #2 <候補値>
    1:社内用ITシステム, 2:インターネット経由の監視/保守用,
    3:開発/検証/デモ用, 4:プロダクト提供用(お客様貸し出し用含む),
    5:お客様システム(開発/保守受託),
    6:委託先システムを利用したサービスの提供,
    7:委託先システムの自社利用,99:その他
  • #3 <候補値>
    0:未使用(サービス準備中), 1:使用(サービス提供中),
    2:使用(廃止予定), 3:廃止(除却前), 4:廃止(除却済),
    5:廃止(資産なし), 6:取消(開発中止), 7:取消(誤登録),
    8:未使用(サービス廃止)
  • #4 <候補値>
    0:無, 1:有
  • #5 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限),
    5:その他, 99:不明
  • #6 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #7 ネットワーク診断利用契約を締結していない場合にはnullが出力されます。
  • #8 <候補値>
    0:診断不可, 1:診断可
  • #9 <候補値>
    0: 00:00~24:00(希望設定なし), 1: 00:00~09:59, 2: 10:00~13:59,
    3: 14:00~17:59, 4: 18:00~23:59
  • #10 <候補値>
    1:独自で実施している, 2:お客様システムのため,--
    3:委託先システムのため, 99:その他
  • #11 yyyy-mm-ddThh:mm:ss±hh:mm形式
  • #12 <候補値>
    10:ネットワーク診断不可承認不要, 20:不可承認待ち,
    30:不可承認メール送信待ち, 40:不可否認, 50:不可承認
  • #13 <候補値>
    1:ネットワーク診断不可理由コード選択が不適切, 2:ネットワーク診断不可理由が不適切,
    3:ネットワーク診断不可の対象外(診断可へ変更要),99:その他
  • #14 <候補値>
    0:プライベート, 1:グローバル
  • #15 <候補値>
    1:インターネット回線, 2:VPN回線, 3:専用線,
    4:契約なし(ローカルのみ), 99:その他

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "sysName": "サンプルシステム",
    "orgName": "サンプル組織",
    "systemAdministrator": "システム責任者",
    "systemServiceNames": [
      "サービス責任者"
    ],
    "systemPersons": [
      "システム担当者"
    ],
    "notes1": "サンプル:システム基本情報備考1",
    "notes2": "",
    "notes3": "",
    "notes4": "",
    "notes5": "",
    "adminNotes1": "サンプル:システム基本情報管理者用備考1",
    "adminNotes2": "",
    "adminNotes3": "",
    "systemStartDate": "2018-07",
    "siteAddr": "設置場所住所",
    "buildingDatacenterName": "ビル/データセンター名",
    "domainName": "ドメイン名",
    "cooperationSysName": "連携システム名",
    "serverNum": 10,
    "usrClassificationCodes": [
      1,
      99
    ],
    "usrClassification": "その他の利用者分類情報",
    "usageCode": 99,
    "usage": "その他の利用目的",
    "useStatus": 1,
    "intOpenFlg": 1,
    "accessEnvironmentLevels": [
      2,
      3
    ],
    "piTypeCode": 1,
    "handlingInfoLevels": [
      2,
      4
    ],
    "ideTypeCode": 1,
    "ideProductName": "IDS製品名/サービス名",
    "ipsTypeCode": 1,
    "ipsProductName": "IPS製品名/サービス名",
    "antiSpamTypeCode": 1,
    "antiSpamProductName": "アンチスパム製品名/サービス名",
    "antiVirusTypeCode": 1,
    "antiVirusProductName": "アンチウィルス製品名/サービス名",
    "wafTypeCode": 1,
    "wafProductName": "WAF製品名/サービス名",
    "nwDiag": 1,
    "nwDiagHoursCode": 0,
    "nwDiagOffReasonCode": null,
    "nwDiagOffReason": null,
    "nwDiagAvailabilityRedistrateTime": "2018-07-01T10:05:30+09:00",
    "nwDiagAvailabilityRedistratedBy": "ネットワーク診断可否登録者",
    "nwDiagOffApprovalOrRejectTime": null,
    "nwDiagOffApprovedOrRejectedBy": null,
    "nwDiagOffAprStatusCode": 10,
    "nwDiagOffAppReason": null,
    "nwDiagOffRejReasonCode": null,
    "nwDiagOffRejReason": null,
    "detailNotes1": "サンプル:システム詳細情報備考1",
    "detailNotes2": "",
    "detailNotes3": "",
    "detailNotes4": "",
    "detailNotes5": "",
    "detailNotes6": "",
    "detailNotes7": "",
    "detailNotes8": "",
    "detailNotes9": "",
    "detailNotes10": "",
    "systemLastUpdateTime": "2018-07-01T12:10:24+09:00",
    "systemLastUpdatedBy": "システム情報最終更新者",
    "systemNetworks": [
      {
        "sysNwSeqNo": 2,
        "ipAddrStart": "1.2.3.4",
        "ipAddrEnd": "1.2.3.4",
        "isGlobal": 1,
        "comLineCntrCode": 99,
        "comLineCntrText": "その他の通信回線",
        "comLineId": "通信回線ID",
        "note1": "サンプル:ネットワーク情報備考1",
        "note2": "",
        "note3": "",
        "systemNetworkLastUpdateTime": "2018-07-01T09:17:06+09:00",
        "systemNetworkLastUpdatedBy": "ネットワーク情報最終更新者"
      },
      {
        "sysNwSeqNo": 1,
        "ipAddrStart": "192.168.0.2",
        "ipAddrEnd": "192.168.0.5",
        "isGlobal": 0,
        "comLineCntrCode": 4,
        "comLineCntrText": null,
        "comLineId": "",
        "note1": "",
        "note2": "",
        "note3": "",
        "systemNetworkLastUpdateTime": "2018-07-01T19:17:06+09:00",
        "systemNetworkLastUpdatedBy": "ネットワーク情報最終更新者"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合(システムIDの指定誤り)

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

システム基本情報登録

システム情報(基本情報、ネットワーク情報)を新規に登録します。

POST /v1/vvsapi/basics

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId(#1) システムID String
sysName(#2) システム名 String Yes
orgName(#3) 組織名 String Yes
notes1(#4) 備考1(システム基本情報) String
notes2(#4) 備考2(システム基本情報) String
notes3(#4) 備考3(システム基本情報) String
notes4(#4) 備考4(システム基本情報) String
notes5(#4) 備考5(システム基本情報) String
adminNotes1 管理者用備考1(システム基本情報) String
adminNotes2 管理者用備考2(システム基本情報) String
adminNotes3 管理者用備考3(システム基本情報) String
systemNetworks(#5) ネットワーク情報 Object array Yes
ipAddrStart(#6) 開始IPアドレス String Yes
ipAddrEnd(#6) 終了IPアドレス(第四オクテット部のみ指定) String
isGlobal(#7) ネットワーク種別 String or Int Yes
comLineCntrCode(#8) 通信回線 String or Int Yes
comLineCntrText(#9) 通信回線(その他) String
comLineId 通信回線ID String
note1(#4) 備考1(ネットワーク情報) String
note2(#4) 備考2(ネットワーク情報) String
note3(#4) 備考3(ネットワーク情報) String
loginId(#10) システム責任者(ログインIDを指定) String
  • #1 システムIDを指定する場合は入力必須です。
    項目なしでリクエストした場合はシステムIDを自動で採番します。
  • #2 同一のシステム名は登録できません。
  • #3 登録されている組織名と一致しない場合にはエラーとなります。
  • #4 契約にて入力必須と設定依頼されている場合は入力必須です。
  • #5 ネットワーク情報は1件以上必須です。
  • #6 ネットワーク種別が「1:グローバル」の場合はIPアドレス範囲を重複して登録することはできません。
    「0:プライベート」の場合はワーニングが表示されますが、登録は正常に行われています。
  • #7 <候補値>
    0:プライベート, 1:グローバル
  • #8 <候補値>
    1:インターネット回線, 2:VPN回線, 3:専用線,
    4:契約なし(ローカルのみ), 99:その他
  • #9 通信回線「99:その他」選択時は入力必須です。
  • #10 組織責任者を設定していない組織の場合には入力必須です。
    ※組織責任者を設定済の組織を指定した場合には任意ですが、指定した場合にはシステム責任者として登録されます。

Example Request

{
  "sysId": "SAMPLE0001",
  "sysName": "サンプルシステム",
  "orgName": "サンプル組織(組織責任者なし)",
  "notes1": "サンプル:システム基本情報備考1",
  "notes2": "サンプル:システム基本情報備考2",
  "notes3": "サンプル:システム基本情報備考3",
  "notes4": "サンプル:システム基本情報備考4",
  "notes5": "サンプル:システム基本情報備考5",
  "adminNotes1": "サンプル:システム基本情報管理者用備考1",
  "adminNotes2": "サンプル:システム基本情報管理者用備考2",
  "adminNotes3": "サンプル:システム基本情報管理者用備考3",
  "systemNetworks": [
    {
      "ipAddrStart": "1.2.3.4",
      "isGlobal": 1,
      "comLineCntrCode": 99,
      "comLineCntrText": "その他の通信回線",
      "comLineId": "通信回線ID",
      "note1": "サンプル:ネットワーク情報備考1",
      "note2": "サンプル:ネットワーク情報備考2",
      "note3": "サンプル:ネットワーク情報備考3"
    },
    {
      "ipAddrStart": "192.168.0.2",
      "ipAddrEnd": "5",
      "isGlobal": 0,
      "comLineCntrCode": 4
    }
  ],
  "loginId": "sample_sysadmin"
}

Response Parameters

Name Description Type
sysId 自動採番された、もしくは指定したシステムID String
systemNetworks 採番されたシステムネットワーク通番リスト Int array
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "systemNetworks": [
      1,
      2
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK",
  "warningInfos": [
    {
      "warningCode": "WAA0000B0001",
      "warningMessage": "入力したプライベートIPアドレスは既に登録されております。
\r\n入力内容に誤りがなければこのまま登録を実施してください。
\r\n(プライベートIPアドレスの重複登録は問題ございません。)"
    }
  ]
}

システム基本情報更新

システム情報(基本情報、ネットワーク情報)を更新します。

PUT /v1/vvsapi/basics

Request Parameters

Name Description Type Mandatoty
sysId (#1) 更新対象のシステムID String Yes
sysName (#2) システム名 String
orgName (#2,#3) 組織名 String
notes1 (#4) 備考1(システム基本情報) String
notes2 (#4) 備考2(システム基本情報) String
notes3 (#4) 備考3(システム基本情報) String
notes4 (#4) 備考4(システム基本情報) String
notes5 (#4) 備考5(システム基本情報) String
adminNotes1 管理者用備考1(システム基本情報) String
adminNotes2 管理者用備考2(システム基本情報) String
adminNotes3 管理者用備考3(システム基本情報) String
loginId (#5) システム責任者(ログインID指定) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 リクエストに本項目を指定する場合、空欄で更新はできません。
  • #3 登録されている組織名と一致しない場合にはエラーとなります。
  • #4 契約にて入力必須と設定依頼されている場合、リクエストに本項目を指定する際に、空欄で更新はできません。
  • #5 組織責任者を設定していない組織に変更し、かつ、システム責任者が未登録の場合には入力必須です。
    ※上記以外の場合には任意ですが、指定した場合にはシステム責任者として登録(更新)します。

Example Request

{
  "sysId":"SAMPLE0001",
  "sysName": "サンプルシステム",
  "orgName": "サンプル組織(組織責任者なし)",
  "notes1": "サンプル:システム基本情報備考1",
  "notes2": "サンプル:システム基本情報備考2",
  "notes3": "サンプル:システム基本情報備考3",
  "notes4": "サンプル:システム基本情報備考4",
  "notes5": "サンプル:システム基本情報備考5",
  "adminNotes1": "サンプル:システム基本情報管理者用備考1",
  "adminNotes2": "サンプル:システム基本情報管理者用備考2",
  "adminNotes3": "",
  "loginId":"sample_sysadmin"
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

システム基本情報削除

システム情報(基本情報、ネットワーク情報)を削除します。

DELETE /v1/vvsapi/basics?sysId={sysId}

Request Parameters

Name Description Type Mandatoty
sysId システムID String Yes

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク情報登録

ネットワーク情報を新規に追加登録します。

POST /v1/vvsapi/networks

Request Parameters

Name Description Type Mandatoty
sysId (#1) 登録対象のシステムID String Yes
systemNetworks ネットワーク情報 Object array Yes|
ipAddrStart (#2) 開始IPアドレス String Yes
ipAddrEnd (#2,#3) 終了IPアドレス(第4オクテッド部) String
isGlobal (#4) ネットワーク種別 String or Int Yes
comLineCntrCode (#5) 通信回線 String or Int Yes
comLineCntrText (#6) 通信回線(その他) String
comLineId 通信回線ID String
note1 (#7) 備考1(ネットワーク情報) String
note2 (#7) 備考2(ネットワーク情報) String
note3 (#7) 備考3(ネットワーク情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 ネットワーク種別が「1:グローバル」の場合はIPアドレス範囲を重複して登録することはできません。
    「0:プライベート」の場合はワーニングが表示されますが、登録は正常に行われています。
  • #3 指定しない場合、開始IPアドレス1件で登録します。
  • #4 <候補値>
    0:プライベート, 1:グローバル
  • #5 <候補値>
    1:インターネット回線, 2:VPN回線, 3:専用線,
    4:契約なし(ローカルのみ), 99:その他
  • #6 通信回線「99:その他」選択時は入力必須です。
  • #7 契約にて入力必須と設定依頼されている場合、入力必須です。

Example Request

{
  "sysId": "SAMPLE0001",
  "systemNetworks": [
    {
      "ipAddrStart": "1.2.3.5",
      "isGlobal": 0,
      "comLineCntrCode": 99,
      "comLineCntrText": "その他の通信回線",
      "comLineId": "通信回線ID",
      "note1": "サンプル:ネットワーク情報備考1",
      "note2": "サンプル:ネットワーク情報備考2",
      "note3": "サンプル:ネットワーク情報備考3"
    },
    {
      "ipAddrStart": "192.168.0.6",
      "ipAddrEnd": "30",
      "isGlobal": 0,
      "comLineCntrCode": 4
    }
  ]
}

Response Parameters

Name Description Type
sysId ネットワーク情報登録対象のシステムID String
systemNetworks 発番されたシステムネットワーク通番リスト Int array
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "systemNetworks": [
      3,
      4
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK",
  "warningInfos": [
    {
      "warningCode": "WAA0000B0001",
      "warningMessage": "入力したプライベートIPアドレスは既に登録されております。  
\r\n入力内容に誤りがなければこのまま登録を実施してください。  
\r\n(プライベートIPアドレスの重複登録は問題ございません。)"
    }
  ]

ネットワーク情報更新

ネットワーク情報を更新します。
項目を空にする場合には値を空欄でリクエストしてください。

PUT /v1/vvsapi/networks

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId (#1) ネットワーク情報更新対象のシステムID String Yes
systemNetworks ネットワーク情報 Object array Yes
sysNwSeqNo (#2) 更新対象のシステムネットワーク通番 String Yes
ipAddrStart (#3,#4) 開始IPアドレス String
ipAddrEnd (#4,#5) 終了IPアドレス(第4オクテッド部) String
comLineCntrCode (#6) 通信回線 String or Int
comLineCntrText (#7) 通信回線(その他) String
comLineId 通信回線ID String
note1 (#8) 備考1(ネットワーク情報) String
note2 (#8) 備考2(ネットワーク情報) String
note3 (#8) 備考3(ネットワーク情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、システムネットワーク通番の組み合わせと一致しない場合にはエラーとなります。
  • #3 リクエストに本項目を指定する場合、空欄で更新はできません。
  • #4 ネットワーク種別が「1:グローバル」の場合はIPアドレス範囲を重複して登録することはできません。
    「0:プライベート」の場合はワーニングが表示されますが、更新は正常に行われています。
  • #5 指定しない場合、開始IPアドレス1件で更新します。
  • #6 <候補値>
    1:インターネット回線, 2:VPN回線, 3:専用線,
    4:契約なし(ローカルのみ), 99:その他
  • #7 通信回線「99:その他」選択時は入力必須です。
  • #8 契約にて入力必須と設定依頼されている場合、リクエストに本項目を指定する際に、空欄で更新はできません。

Example Request

{
  "sysId": "SAMPLE0001",
  "systemNetworks": [
    {
      "sysNwSeqNo": 2,
      "ipAddrStart": "1.2.3.5",
      "comLineCntrCode": 99,
      "comLineCntrText": "その他の通信回線",
      "comLineId": "通信回線ID",
      "note1": "サンプル:ネットワーク情報備考1",
      "note2": "サンプル:ネットワーク情報備考2",
      "note3": "サンプル:ネットワーク情報備考3"
    },
    {
      "sysNwSeqNo": 1,
      "note1": ""
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク情報削除

指定したネットワーク情報を削除します。

DELETE /v1/vvsapi/networks?sysId={sysId}&sysNwSeqNo={sysNwSeqNo}

Request Parameters

Name Description Type Mandatoty
sysId 削除するネットワーク情報を含むシステムID String Yes
sysNwSeqNo 削除対象のシステムネットワーク通番 String Yes

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

システム詳細情報登録

システム詳細情報を新規に登録します。
本APIを実行する前に、システム責任者とシステム担当者を登録する必要があります。
システム責任者とシステム担当者の登録については、権限情報APIをご参照ください。
また、システム詳細情報を登録済で、更新する場合には更新処理(PUT)でリクエストしてください。

POST /v1/vvsapi/details

Request Parameters

Name Description Type Mandatoty
sysId (#1) 対象のシステムID String Yes
systemStartDate 運用開始時期(yyyy-mmの形式で入力) String Yes
siteAddr 設置場所住所 String
buildingDatacenterName ビル/データセンター名 String
domainName ドメイン名 String
cooperationSysName 連携システム名 String
serverNum サーバ台数(半角数字で指定) String or Int
usrClassificationCodes (#2) 利用者分類情報リスト String array or Int array Yes
usrClassification (#3) 利用者分類情報(その他) String
usageCode (#4) 使用目的(システム情報) String or Int Yes
usage (#5) 使用目的(その他)(システム情報) String
useStatus (#6) 使用状況(システム情報) String or Int Yes
intOpenFlg (#7) インターネット公開有無(システム情報) String or Int Yes
accessEnvironmentLevels (#8) 利用者アクセス環境リスト(システム情報) String array or Int array
piTypeCode (#7) 個人情報有無(システム情報) String or Int Yes
handlingInfoLevels (#9) 取扱利用者情報リスト(システム情報) String array or Int array
ideTypeCode (#7) IDS導入有無(システム情報) String or Int Yes
ideProductName (#10) IDS製品名/サービス名(システム情報) String
ipsTypeCode (#7) IPS導入有無(システム情報) String or Int Yes
ipsProductName (#10) IPS製品名/サービス名(システム情報) String
antiSpamTypeCode (#7) アンチスパム導入有無(システム情報) String or Int Yes
antiSpamProductName (#10) アンチスパム製品名/サービス名(システム情報) String
antiVirusTypeCode (#7) アンチウイルス導入有無(システム情報) String or Int Yes
antiVirusProductName (#10) アンチウィルス製品名/サービス名(システム情報) String
wafTypeCode (#7) WAF導入有無(システム情報) String or Int Yes
wafProductName (#10) WAF製品名/サービス名(システム情報) String
nwDiag (#11,#12) ネットワーク診断可否(システム情報) String or Int
nwDiagHoursCode (#12,#13) ネットワーク診断希望時間帯 String or Int
nwDiagOffReasonCode (#12,#14,#15) ネットワーク診断不可理由(システム情報) String or Int
nwDiagOffReason (#12,#16) ネットワーク診断不可理由詳細(システム情報) String
detailNotes1 (#17) 備考1(システム詳細情報) String
detailNotes2 (#17) 備考2(システム詳細情報) String
detailNotes3 (#17) 備考3(システム詳細情報) String
detailNotes4 (#17) 備考4(システム詳細情報) String
detailNotes5 (#17) 備考5(システム詳細情報) String
detailNotes6 (#17) 備考6(システム詳細情報) String
detailNotes7 (#17) 備考7(システム詳細情報) String
detailNotes8 (#17) 備考8(システム詳細情報) String
detailNotes9 (#17) 備考9(システム詳細情報) String
detailNotes10 (#17) 備考10(システム詳細情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 <候補値>
    1:法人(一般), 2:法人(特定), 3:個人(一般),
    4:個人(特定), 5:法人及び個人(一般), 6:法人及び個人(特定),
    7:社内(一般), 8:社内(特定), 99:その他
  • #3 利用者分類情報「99:その他」選択時は入力必須です。
  • #4 <候補値>
    1:社内用ITシステム, 2:インターネット経由の監視/保守用,
    3:開発/検証/デモ用, 4:プロダクト提供用(お客様貸し出し用含む),
    5:お客様システム(開発/保守受託),
    6:委託先システムを利用したサービスの提供,
    7:委託先システムの自社利用,99:その他,
  • #5 使用目的「99:その他」選択時は入力必須です。
  • #6 <候補値>
    0:未使用(サービス準備中), 1:使用(サービス提供中),
    2:使用(廃止予定), 3:廃止(除却前), 4:廃止(除却済),
    5:廃止(資産なし), 6:取消(開発中止), 7:取消(誤登録),
    8:未使用(サービス廃止)
  • #7 <候補値>
    0:無, 1:有
  • #8 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限),
    5:その他, 99:不明
  • #9 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #10 該当する製品導入有無で「1:有」を選択時は入力必須です。
  • #11 ネットワーク診断利用契約を締結している場合には入力必須です。
    <候補値>
    0:診断不可, 1:診断可
  • #12 ネットワーク診断を利用する場合に設定する項目です。
    ネットワーク診断利用契約を締結していない場合、項目を指定しても値は登録されません。
  • #13 指定なければ「0:希望設定なし」で登録されます。
    <候補値>
    0: 00:00~24:00(希望設定なし), 1: 00:00~09:59, 2: 10:00~13:59,
    3: 14:00~17:59, 4: 18:00~23:59
  • #14 ネットワーク診断可否で「0:診断不可」を選択時は入力必須です。
  • #15 <候補値>
    1:独自で実施している, 2:お客様システムのため,
    3:委託先システムのため, 99:その他
  • #16 ネットワーク診断不可理由で「99:その他」を選択時は入力必須です。
  • #17 契約にて入力必須と設定依頼されている場合、入力必須です。

Example Request

{
  "sysId": "SAMPLE0001",
  "systemStartDate": "2018-07",
  "siteAddr": "設置場所住所",
  "buildingDatacenterName": "ビル/データセンター名",
  "domainName": "ドメイン名",
  "cooperationSysName": "連携システム名",
  "serverNum": 10,
  "usrClassificationCodes": [
    1,
    99
  ],
  "usrClassification": "その他の利用者分類情報",
  "usageCode": 99,
  "usage": "その他の利用目的",
  "useStatus": 1,
  "intOpenFlg": 1,
  "accessEnvironmentLevels": [
    2,
    3
  ],
  "piTypeCode": 1,
  "handlingInfoLevels": [
    2,
    4
  ],
  "ideTypeCode": 1,
  "ideProductName": "IDS製品名/サービス名",
  "ipsTypeCode": 1,
  "ipsProductName": "IPS製品名/サービス名",
  "antiSpamTypeCode": 1,
  "antiSpamProductName": "アンチスパム製品名/サービス名",
  "antiVirusTypeCode": 1,
  "antiVirusProductName": "アンチウィルス製品名/サービス名",
  "wafTypeCode": 1,
  "wafProductName": "WAF製品名/サービス名",
  "nwDiag": 1,
  "nwDiagHoursCode": 0,
  "detailNotes1": "サンプル:システム詳細情報備考1",
  "detailNotes2": "サンプル:システム詳細情報備考2",
  "detailNotes3": "サンプル:システム詳細情報備考3",
  "detailNotes4": "サンプル:システム詳細情報備考4",
  "detailNotes5": "サンプル:システム詳細情報備考5",
  "detailNotes6": "サンプル:システム詳細情報備考6",
  "detailNotes7": "サンプル:システム詳細情報備考7",
  "detailNotes8": "サンプル:システム詳細情報備考8",
  "detailNotes9": "サンプル:システム詳細情報備考9",
  "detailNotes10": "サンプル:システム詳細情報備考10"
}


{
  "sysId": "SAMPLE0002",
  "systemStartDate": "2018-07",
  "usrClassificationCodes": [
    1,
    99
  ],
  "usrClassification": "その他の利用者分類情報",
  "usageCode": 1,
  "useStatus": 1,
  "intOpenFlg": 1,
  "piTypeCode": 1,
  "ideTypeCode": 1,
  "ideProductName": "IDS製品名/サービス名",
  "ipsTypeCode": 1,
  "ipsProductName": "IPS製品名/サービス名",
  "antiSpamTypeCode": 1,
  "antiSpamProductName": "アンチスパム製品名/サービス名",
  "antiVirusTypeCode": 1,
  "antiVirusProductName": "アンチウィルス製品名/サービス名",
  "wafTypeCode": 1,
  "wafProductName": "WAF製品名/サービス名",
  "nwDiag": 0,
  "nwDiagOffReasonCode": 99,
  "nwDiagOffReason": "ネットワーク診断不可理由詳細",
  "detailNotes1": "サンプル:システム詳細情報備考1"
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

システム詳細情報更新

システム詳細情報を更新します。
システム詳細情報を登録(POST)後に実行できます。
項目を空にする場合には値を空欄でリクエストしてください。
任意項目のリストを空にする場合には空配列でリクエストしてください。
(例: "accessEnvironmentLevels":[])

PUT /v1/vvsapi/details

Request Parameters

Name Description Type Mandatoty
sysId (#1) 更新対象のシステムID String Yes
systemStartDate (#2) 運用開始時期(yyyy-mmの形式) String
siteAddr 設置場所住所 String
buildingDatacenterName ビル/データセンター名 String
domainName ドメイン名 String
cooperationSysName 連携システム名 String
serverNum サーバ台数(半角数字) String or Int
usrClassificationCodes (#2,#3,#4) 利用者分類情報リスト String array Int array
usrClassification (#5) 利用者分類情報(その他) String
usageCode (#2,#6) 使用目的(システム情報) String or Int
usage (#7) 使用目的(その他)(システム情報) String
useStatus (#2,#8) 使用状況(システム情報) String or Int
intOpenFlg (#2,#9) インターネット公開有無(システム情報) String or Int
accessEnvironmentLevels (#3,#10) 利用者アクセス環境リスト(システム情報) String array or Int array
piTypeCode (#2,#9) 個人情報有無(システム情報) String or Int
handlingInfoLevels (#3,#11) 取扱利用者情報リスト(システム情報) String array or Int array
ideTypeCode (#2,#9) IDS導入有無(システム情報) String or Int
ideProductName (#12) IDS製品名/サービス名(システム情報) String
ipsTypeCode (#2,#9) IPS導入有無(システム情報) String or Int
ipsProductName (#12) IPS製品名/サービス名(システム情報) String
antiSpamTypeCode (#2,#9) アンチスパム導入有無(システム情報) String or Int
antiSpamProductName (#12) アンチスパム製品名/サービス名(システム情報) String
antiVirusTypeCode (#2,#9) アンチウイルス導入有無(システム情報) String or Int
antiVirusProductName (#12) アンチウィルス製品名/サービス名(システム情報) String
wafTypeCode (#2,#9) WAF導入有無(システム情報) String or Int
wafProductName (#12) WAF製品名/サービス名(システム情報) String
nwDiag (#13,#14) ネットワーク診断可否(システム情報) String or Int
nwDiagHoursCode (#14,#15) ネットワーク診断希望時間帯 String or Int
nwDiagOffReasonCode (#14,#16,#17) ネットワーク診断不可理由(システム情報) String or Int
nwDiagOffReason (#14,#18) ネットワーク診断不可理由詳細(システム情報) String
detailNotes1 (#19) 備考1(システム詳細情報) String
detailNotes2 (#19) 備考2(システム詳細情報) String
detailNotes3 (#19) 備考3(システム詳細情報) String
detailNotes4 (#19) 備考4(システム詳細情報) String
detailNotes5 (#19) 備考5(システム詳細情報) String
detailNotes6 (#19) 備考6(システム詳細情報) String
detailNotes7 (#19) 備考7(システム詳細情報) String
detailNotes8 (#19) 備考8(システム詳細情報) String
detailNotes9 (#19) 備考9(システム詳細情報) String
detailNotes10 (#19) 備考10(システム詳細情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 リクエストに本項目を指定する場合、空欄で更新はできません。
  • #3 リストでリクエストする項目は、リスト内容で登録済の内容を上書き更新します。
    追加処理ではないため実行する際はご注意ください。
  • #4 <候補値>
    1:法人(一般), 2:法人(特定), 3:個人(一般),
    4:個人(特定), 5:法人及び個人(一般), 6:法人及び個人(特定),
    7:社内(一般), 8:社内(特定), 99:その他
  • #5 利用者分類情報「99:その他」選択時は入力必須です。
  • #6 <候補値>
    1:社内用ITシステム, 2:インターネット経由の監視/保守用,
    3:開発/検証/デモ用, 4:プロダクト提供用(お客様貸し出し用含む),
    5:お客様システム(開発/保守受託),
    6:委託先システムを利用したサービスの提供,
    7:委託先システムの自社利用,99:その他,
  • #7 使用目的「99:その他」選択時は入力必須です。
  • #8 <候補値>
    0:未使用(サービス準備中), 1:使用(サービス提供中),
    2:使用(廃止予定), 3:廃止(除却前), 4:廃止(除却済),
    5:廃止(資産なし), 6:取消(開発中止), 7:取消(誤登録),
    8:未使用(サービス廃止)
  • #9 <候補値>
    0:無, 1:有
  • #10 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限),
    5:その他, 99:不明
  • #11 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #12 該当する製品導入有無で「1:有」を選択時は入力必須です。
  • #13 ネットワーク診断利用契約を締結している場合には、
    リクエストに本項目を指定する際、空欄で更新はできません。
    <候補値>
    0:診断不可, 1:診断可
  • #14 ネットワーク診断を利用する場合に設定する項目です。
    ネットワーク診断利用契約を締結していない場合、項目を指定しても値は登録されません。
  • #15 <候補値>
    0: 00:00~24:00(希望設定なし), 1: 00:00~09:59, 2: 10:00~13:59,
    3: 14:00~17:59, 4: 18:00~23:59
  • #16 ネットワーク診断可否で「0:診断不可」を選択時は入力必須です。
  • #17 <候補値>
    1:独自で実施している, 2:お客様システムのため,
    3:委託先システムのため, 99:その他
  • #18 ネットワーク診断不可理由で「99:その他」を選択時は入力必須です。
  • #19 契約にて入力必須と設定依頼されている場合、リクエストに本項目を指定する際に、空欄で更新はできません。

Example Request

{
  "sysId": "SAMPLE0001",
  "systemStartDate": "2018-07",
  "siteAddr": "設置場所住所",
  "buildingDatacenterName": "ビル/データセンター名",
  "domainName": "ドメイン名",
  "cooperationSysName": "連携システム名",
  "serverNum": 10,
  "usrClassificationCodes": [
    2,
    99
  ],
  "usrClassification": "その他の利用者分類情報",
  "usageCode": 99,
  "usage": "その他の利用目的",
  "useStatus": 1,
  "intOpenFlg": 1,
  "accessEnvironmentLevels": [
    2,
    4
  ],
  "piTypeCode": 1,
  "handlingInfoLevels": [
    2,
    3
  ],
  "ideTypeCode": 1,
  "ideProductName": "IDS製品名/サービス名",
  "ipsTypeCode": 1,
  "ipsProductName": "IPS製品名/サービス名",
  "antiSpamTypeCode": 1,
  "antiSpamProductName": "アンチスパム製品名/サービス名",
  "antiVirusTypeCode": 1,
  "antiVirusProductName": "アンチウィルス製品名/サービス名",
  "wafTypeCode": 1,
  "wafProductName": "WAF製品名/サービス名",
  "nwDiag": 1,
  "nwDiagHoursCode": 1,
  "detailNotes1": "サンプル:システム詳細情報備考1",
  "detailNotes2": "サンプル:システム詳細情報備考2",
  "detailNotes3": "サンプル:システム詳細情報備考3",
  "detailNotes4": "サンプル:システム詳細情報備考4",
  "detailNotes5": "サンプル:システム詳細情報備考5",
  "detailNotes6": "サンプル:システム詳細情報備考6",
  "detailNotes7": "サンプル:システム詳細情報備考7",
  "detailNotes8": "サンプル:システム詳細情報備考8",
  "detailNotes9": "サンプル:システム詳細情報備考9",
  "detailNotes10": "サンプル:システム詳細情報備考10"
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク診断不可承認(システム情報単位)

指定したシステム情報単位のネットワーク診断不可申請を承認します。
システム詳細情報にてネットワーク診断可否を「0:診断不可」で登録時に実行できます。
「ネットワーク診断不可否認」(後述)をした対象に実行すると「承認」に変更できます。

PUT /v1/vvsapi/details

Request Parameters

Name Description Type Mandatoty
sysId (#1) 承認対象のシステムID String Yes
nwDiagNoneApprovalOrReject (#2) ネットワーク診断不可承認否認(システム情報) String or Int Yes
nwDiagOffAppReason 承認理由(システム情報) String Yes
  • #1 登録されているシステムIDと一致しない場合、指定したシステムIDが診断不可でない場合には、エラーとなります。
  • #2 「1:承認」を指定

Example Request

{
  "sysId": "SAMPLE0002",
  "nwDiagNoneApprovalOrReject":"1" ,
  "nwDiagOffAppReason":"診断不可承認理由"
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク診断不可否認(システム情報単位)

指定したシステム情報単位のネットワーク診断不可申請を否認します。
システム詳細情報にてネットワーク診断可否を「0:診断不可」で登録時に実行できます。
「ネットワーク診断不可承認」(前述)をした対象に実行すると「否認」に変更できます。

PUT /v1/vvsapi/details

Request Parameters

Name Description Type Mandatoty
sysId (#1) 否認対象のシステムID String Yes
nwDiagNoneApprovalOrReject (#2) ネットワーク診断不可承認否認(システム情報) String or Int Yes
nwDiagOffRejReasonCode (#3) 否認種別(システム情報) String or Int Yes
nwDiagOffRejReason (#4) 否認理由詳細(システム情報) String
  • #1 登録されているシステムIDと一致しない場合、指定したシステムIDが診断不可でない場合には、エラーとなります。
  • #2 「0:否認」を指定
  • #3 <候補値>
    1:ネットワーク診断不可理由コード選択が不適切, 2:ネットワーク診断不可理由が不適切,
    3:ネットワーク診断不可の対象外(診断可へ変更要),99:その他
  • #4 否認種別に「99:その他」を選択した場合、必須入力です。

Example Request

{
  "sysId": "SAMPLE0002",
  "nwDiagNoneApprovalOrReject":"0" ,
  "nwDiagOffRejReasonCode":"99" ,
  "nwDiagOffRejReason":"診断不可否認理由詳細"
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

権限情報登録

指定したシステム情報に、システム責任者、システム担当者、サービス責任者を登録します。
システム責任者は1名のみ登録可、サービス責任者、システム担当者は複数名登録可です。
システム責任者の登録は未登録の場合のみ実行可です。登録後は変更のみ実行可となります。
システム情報の登録ステイタスを進めるためには、システム責任者とシステム担当者を登録する必要があります。
システム担当者は登録任意ですが、登録しない場合にもシステム担当者を登録なしとすることを明示的に実行する必要があります。
(実行方法については、リクエスト例をご参照ください)
※登録ステイタスは、画面にてシステム情報の登録未完了時に上部に表示されるステイタスバーのことを指します。

POST /v1/vvsapi/roles

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId (#1) システムID String Yes
authorityInfos 権限情報 Object array Yes
loginId (#2,#3) ログインID String
roleType (#4) 権限種別コード String or Int Yes
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 サービス責任者、システム責任者登録時には入力必須です。
    システム担当者登録時に空を指定、もしくは、項目を指定しない場合はシステム担当者登録なしとして処理します。
  • #3 登録されているログインIDと一致しない場合にはエラーとなります。
  • #4 <候補値>
    1:サービス責任者、2:システム責任者、3:システム担当者

Example Request

システム責任者とシステム担当者を登録する場合

{
  "sysId": "SAMPLE0001",
  "authorityInfos":[
    {
      "loginId":"sample_sysadmin",
      "roleType":"2"
    },
    {
      "loginId":"sample_sysperson",
      "roleType":"3"
    }
  ]
}

システム担当者を登録しない場合の例(システム情報登録ステイタスのみ変更します)

{
  "sysId": "SAMPLE0002",
  "authorityInfos":[
    {
      "roleType":"3"
    }
  ]
}

システム担当者を登録しない場合の例2(システム情報登録ステイタスのみ変更します)

{
  "sysId": "SAMPLE0002",
  "authorityInfos":[
    {
      "loginId":"",
      "roleType":"3"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

権限情報更新

指定したシステム情報に紐づくシステム責任者を更新します。
※サービス責任者、システム担当者の更新は、登録と削除にて行ってください。

PUT /v1/vvsapi/roles

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId (#1) システムID String Yes
authorityInfos 権限情報 Object array Yes
loginId (#2) ログインID String Yes
roleType 権限種別コード String or Int Yes|「2:システム責任者」を指定
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているログインIDと一致しない場合にはエラーとなります。

Example Request

{
  "sysId": "SAMPLE0001",
  "authorityInfos":[
    {
      "loginId":"sample_sysadmin2",
      "roleType":"2"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

権限情報削除

指定したシステム情報に紐づくサービス責任者、システム担当者を削除します。
システム責任者は1名必須のため削除することはできません。

DELETE /v1/vvsapi/roles?sysId={sysId}&loginId={loginId}&roleType={roleType}

Request Parameters

Name Description Mandatoty
sysId (#1) 削除する権限情報を含むシステムID Yes
loginId (#2) 権限削除対象のログインID Yes
roleType (#3) 削除対象の権限種別コード Yes
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているログインIDと一致しない場合にはエラーとなります。
  • #3 <候補値>
    1:サービス責任者、3:システム担当者

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

IPアドレス情報検索

指定したシステムIDに紐づくIPアドレス情報を取得します。
機器IDを追加で指定した場合には、指定した機器IDのIPアドレス情報を取得します。
※機器IDはIPアドレス情報を登録時に発番されるIDです。

GET /v1/vvsapi/ipaddresses?sysId={sysId}&devId={devId}&offset={offset}&limit={limit}

Request Parameters

Name Description Mandatoty
sysId 情報取得対象のシステムID Yes
devId 情報取得対象の機器ID
offset オフセット値
limit (#1) 返却数上限値
  • #1 指定しない場合、最大50件が返却される

Response Parameters

Name(Nest1) Name(Nest2) Description Type
sysId システムID String
ipAddressInfos IPアドレス情報 Object array
devId 機器ID Int
sysNwSeqNo システムネットワーク通番 Int
ipAddr IPアドレス String
isGlobal (#1) IP種別 Int
devName IP識別名 String
devFound (#2) ホスト接続有無 Int
useStatusCode (#3) 使用状況(IPアドレス情報) Int
nwDiag (#4,#5) ネットワーク診断可否(IPアドレス情報) Int
nwDiagOffReasonCode (#4,#6) ネットワーク診断不可理由(IPアドレス情報) Int
nwDiagOffReason (#4) ネットワーク診断不可理由詳細(IPアドレス情報) String
nwDiagAvailabilityRedistrateTime (#4,#7) ネットワーク診断可否登録日時(IPアドレス情報) String
nwDiagAvailabilityRedistratedBy (#4) ネットワーク診断可否登録者(IPアドレス情報) String
nwDiagOffApprovalOrRejectTime (#4,#7) ネットワーク診断不可承認/否認日時(IPアドレス情報) String
nwDiagOffApprovedOrRejectedBy (#4) ネットワーク診断不可承認/否認者(IPアドレス情報) String
nwDiagOffAprStatusCode (#4,#8) ネットワーク診断不可承認/否認(IPアドレス情報) Int
nwDiagOffAppReason (#4) ネットワーク診断不可承認理由(IPアドレス情報) String
nwDiagOffRejReasonCode (#4,#9) ネットワーク診断不可否認種別(IPアドレス情報) Int
nwDiagOffRejReason (#4) ネットワーク診断不可否認理由(IPアドレス情報) String
notes1 備考1(IPアドレス情報) String
notes2 備考2(IPアドレス情報) String
notes3 備考3(IPアドレス情報) String
adminNotes1 管理者用備考1(IPアドレス情報) String
adminNotes2 管理者用備考2(IPアドレス情報) String
adminNotes3 管理者用備考3(IPアドレス情報) String
ipLastUpdateTime (#7) 最終更新日時(IPアドレス情報) String
ipLastUpdatedBy 最終更新者(IPアドレス情報) String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    0:プライベート, 1:グローバル
  • #2 <候補値>
    0:無, 1:有
  • #3 <候補値>
    1:ネットワークアドレス, 2:ブロードキャストアドレス,
    3:ホストアドレス(サーバ), 4:ホストアドレス(クライアント),
    5:ホストアドレス(ネットワーク機器), 99:その他
  • #4 ネットワーク診断利用契約を締結していない場合にはnullが出力されます。
  • #5 <候補値>
    0:診断不可, 1:診断可
  • #6 <候補値>
    1:独自で実施している, 2:お客様システムのため,
    3:委託先システムのため, 99:その他
  • #7 yyyy-mm-ddThh:mm:ss±hh:mm形式
  • #8 <候補値>
    10:ネットワーク診断不可承認不要, 20:不可承認待ち,
    30:不可承認メール送信待ち, 40:不可否認, 50:不可承認
  • #9 <候補値>
    1:ネットワーク診断不可理由コード選択が不適切, 2:ネットワーク診断不可理由が不適切,
    3:ネットワーク診断不可の対象外(診断可へ変更要),99:その他

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "ipAddressInfos": [
      {
        "devId": 100000,
        "sysNwSeqNo": 2,
        "ipAddr": "1.2.3.4",
        "isGlobal": 1,
        "devName": "サンプル:IP識別名",
        "devFound": 1,
        "useStatusCode": 3,
        "nwDiag": 1,
        "nwDiagOffReasonCode": null,
        "nwDiagOffReason": null,
        "nwDiagAvailabilityRedistrateTime": "2018-07-01T15:19:49+09:00",
        "nwDiagAvailabilityRedistratedBy": "IP単位ネットワーク診断可否登録者",
        "nwDiagOffApprovalOrRejectTime": null,
        "nwDiagOffApprovedOrRejectedBy": null,
        "nwDiagOffAprStatusCode": 10,
        "nwDiagOffAppReason": null,
        "nwDiagOffRejReasonCode": null,
        "nwDiagOffRejReason": null,
        "notes1": "サンプル:IPアドレス情報備考1",
        "notes2": "",
        "notes3": "",
        "adminNotes1": "サンプル:IPアドレス情報管理者用備考1",
        "adminNotes2": "",
        "adminNotes3": "",
        "ipLastUpdateTime": "2018-07-01T15:30:49+09:00",
        "ipLastUpdatedBy": "IPアドレス情報最終更新者"
      },
      {
        "devId": 100100,
        "sysNwSeqNo": 1,
        "ipAddr": "192.168.0.2",
        "isGlobal": 0,
        "devName": "サンプル:IP識別名2",
        "devFound": 1,
        "useStatusCode": 2,
        "nwDiag": 0,
        "nwDiagOffReasonCode": 2,
        "nwDiagOffReason": null,
        "nwDiagAvailabilityRedistrateTime": "2018-07-01T16:10:49+09:00",
        "nwDiagAvailabilityRedistratedBy": "IP単位ネットワーク診断可否登録者",
        "nwDiagOffApprovalOrRejectTime": null,
        "nwDiagOffApprovedOrRejectedBy": null,
        "nwDiagOffAprStatusCode": 20,
        "nwDiagOffAppReason": null,
        "nwDiagOffRejReasonCode": null,
        "nwDiagOffRejReason": null,
        "notes1": "",
        "notes2": "",
        "notes3": "",
        "adminNotes1": "",
        "adminNotes2": "",
        "adminNotes3": "",
        "ipLastUpdateTime": "2018-07-01T15:45:22+09:00",
        "ipLastUpdatedBy": "IPアドレス情報最終更新者"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合(IPアドレス情報登録なし、システムIDの指定誤りなど)

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

IPアドレス情報 新規登録

IPアドレス情報を新規に登録します。
本APIを実行する前に、システム詳細情報を登録する必要があります。
システム詳細情報の登録については、システム詳細情報API(/details)をご参照ください。

POST /v1/vvsapi/ipaddresses

Request Parameters

Name(Nest1) Name(Nest2) Name(Nest3) Description Type Mandatoty
sysId (#1) システムID String Yes
systemNetworks ネットワーク情報 Object array Yes
sysNwSeqNo (#2) システムネットワーク通番 String or Int Yes
ipAddressInfos IPアドレス情報 Object array Yes
ipAddr (#2) IPアドレス String Yes
devName IP識別名 String
devFound (#3) ホスト接続有無 String or Int Yes
useStatusCode (#4) 使用状況(IPアドレス情報) String or Int Yes
nwDiag (#5,#6) ネットワーク診断可否(IPアドレス情報) String or Int
nwDiagOffReasonCode (#6,#7,#8) ネットワーク診断不可理由(IPアドレス情報) String or Int
nwDiagOffReason (#6,#9) ネットワーク診断不可理由詳細(IPアドレス情報) String
notes1 (#10) 備考1(IPアドレス情報) String
notes2 (#10) 備考2(IPアドレス情報) String
notes3 (#10) 備考3(IPアドレス情報) String
adminNotes1 管理者用備考1(IPアドレス情報) String
adminNotes2 管理者用備考2(IPアドレス情報) String
adminNotes3 管理者用備考3(IPアドレス情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、システムネットワーク通番、指定したネットワーク情報のIPアドレス範囲の組み合わせと一致しない場合にはエラーとなります。
  • #3 <候補値>
    0:無, 1:有
  • #4 <候補値>
    1:ネットワークアドレス, 2:ブロードキャストアドレス,
    3:ホストアドレス(サーバ), 4:ホストアドレス(クライアント),
    5:ホストアドレス(ネットワーク機器), 99:その他
  • #5 ネットワーク診断利用契約を締結している場合には入力必須です。
    <候補値>
    0:診断不可, 1:診断可
  • #6 ネットワーク診断を利用する場合に設定する項目です。
    ネットワーク診断利用契約を締結していない場合、項目を指定しても値は登録されません。
  • #7 ネットワーク診断可否で「0:診断不可」を選択時は入力必須です。
  • #8 <候補値>
    1:独自で実施している, 2:お客様システムのため,
    3:委託先システムのため, 99:その他
  • #9 ネットワーク診断不可理由で「99:その他」を選択時は入力必須です。
  • #10 契約にて入力必須と設定依頼されている場合、入力必須です。

Example Request

{
  "sysId": "SAMPLE0001",
  "systemNetworks": [
    {
      "sysNwSeqNo": 2,
      "ipAddressInfos": [
        {
          "ipAddr": "1.2.3.4",
          "devName": "サンプル:IP識別名",
          "devFound": 1,
          "useStatusCode": 3,
          "nwDiag": 1,
          "notes1": "サンプル:IPアドレス情報備考1",
          "notes2": "サンプル:IPアドレス情報備考2",
          "notes3": "サンプル:IPアドレス情報備考3",
          "adminNotes1": "サンプル:IPアドレス情報管理者用備考1",
          "adminNotes2": "サンプル:IPアドレス情報管理者用備考2",
          "adminNotes3": "サンプル:IPアドレス情報管理者用備考3"
        }
      ]
    },
    {
      "sysNwSeqNo": 1,
      "ipAddressInfos": [
        {
          "ipAddr": "192.168.0.2",
          "devName": "サンプル:IP識別名2",
          "devFound": 1,
          "useStatusCode": 4,
          "nwDiag": 0,
          "nwDiagOffReasonCode": 99,
          "nwDiagOffReason": "ネットワーク診断不可理由詳細"
        },
        {
          "ipAddr": "192.168.0.3",
          "devName": "サンプル:IP識別名3",
          "devFound": 1,
          "useStatusCode": 4,
          "nwDiag": 0,
          "nwDiagOffReasonCode": 1
        }
      ]
    }
  ]
}

Response Parameters

Name(Next1) Name(Nest2) Description Type
sysId システムID String
ipAddressInfos IPアドレス情報 Object array
devId 発番された機器ID Int
sysNwSeqNo システムネットワーク通番 Int
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "ipAddressInfos": [
      {
        "devId": 100001,
        "sysNwSeqNo": 2
      },
      {
        "devId": 100002,
        "sysNwSeqNo": 1
      },
      {
        "devId": 100003,
        "sysNwSeqNo": 1
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

IPアドレス情報更新

IPアドレス情報を更新します。
項目を空にする場合には値を空欄でリクエストしてください。

PUT /v1/vvsapi/ipaddresses

Request Parameters

Name Name(Nest2) Description Type Mandatoty
sysId (#1) 更新対象のIPアドレスを含むシステムID String Yes
ipAddressInfos IPアドレス情報 Object array Yes
devId (#2) 更新対象の機器ID String or Int Yes
devName IP識別名 String
devFound (#3,#4) ホスト接続有無 String or Int
useStatusCode (#3,#5) 使用状況(IPアドレス情報) String or Int
nwDiag (#6,#7) ネットワーク診断可否(IPアドレス情報) String or Int
nwDiagOffReasonCode (#7,#8\,#9) ネットワーク診断不可理由(IPアドレス情報) String or Int
nwDiagOffReason (#7,#10) ネットワーク診断不可理由詳細(IPアドレス情報) String
notes1 (#11) 備考1(IPアドレス情報) String
notes2 (#11) 備考2(IPアドレス情報) String
notes3 (#11) 備考3(IPアドレス情報) String
adminNotes1 管理者用備考1(IPアドレス情報) String
adminNotes2 管理者用備考2(IPアドレス情報) String
adminNotes3 管理者用備考3(IPアドレス情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、機器IDの組み合わせと一致しない場合にはエラーとなります。
  • #3 リクエストに本項目を指定する場合、空欄で更新はできません。
  • #4 <候補値>
    0:無, 1:有
  • #5 <候補値>
    1:ネットワークアドレス, 2:ブロードキャストアドレス,
    3:ホストアドレス(サーバ), 4:ホストアドレス(クライアント),
    5:ホストアドレス(ネットワーク機器), 99:その他
  • #6 ネットワーク診断利用契約を締結している場合には、
    リクエストに本項目を指定する際、空欄で更新はできません。
    <候補値>
    0:診断不可, 1:診断可
  • #7 ネットワーク診断を利用する場合に設定する項目です。
    ネットワーク診断利用契約を締結していない場合、項目を指定しても値は登録されません。
  • #8 ネットワーク診断可否で「0:診断不可」を選択時は入力必須です。
  • #9 <候補値>
    1:独自で実施している, 2:お客様システムのため
    3:委託先システムのため, 99:その他
  • #10 ネットワーク診断不可理由で「99:その他」を選択時は入力必須です。
  • #11 契約にて入力必須と設定依頼されている場合、入力必須です。

Example Request

{
  "sysId": "SAMPLE0001",
  "ipAddressInfos": [
    {
      "devId": 100002,
      "devName": "サンプル:IP識別名2",
      "devFound": 1,
      "useStatusCode": 3,
      "nwDiag": 1,
      "notes1": "サンプル:IPアドレス情報備考1",
      "notes2": "サンプル:IPアドレス情報備考2",
      "notes3": "サンプル:IPアドレス情報備考3",
      "adminNotes1": "サンプル:IPアドレス情報管理者用備考1",
      "adminNotes2": "サンプル:IPアドレス情報管理者用備考2",
      "adminNotes3": "サンプル:IPアドレス情報管理者用備考3"
    },
    {
      "devId": 100003,
      "nwDiag": 0,
      "nwDiagOffReasonCode": 99,
      "nwDiagOffReason": "ネットワーク診断不可理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

IPアドレス情報削除

指定した機器IDのIPアドレス情報を削除します。

DELETE /v1/vvsapi/ipaddresses?sysId={sysId}&devId={devId}

Request Parameters

Name Description Mandatoty
sysId 削除対象が紐づくシステムID Yes
devId 削除対象の機器ID Yes

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク診断不可承認(IPアドレス単位)

指定したIPアドレス情報のネットワーク診断不可申請を承認します。
IPアドレス情報にてネットワーク診断可否を「0:診断不可」で登録時に実行できます。
「ネットワーク診断不可否認」(後述)をした対象に実行すると「承認」に変更できます。

PUT /v1/vvsapi/ipaddresses

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId (#1) システムID String Yes
ipAddressInfos IPアドレス情報 Object array Yes
devId (#2) 機器ID String or Int Yes
nwDiagNoneApprovalOrReject (#3) ネットワーク診断不可承認否認(IPアドレス情報) String or Int Yes
nwDiagOffAppReason 承認理由(IPアドレス情報) String Yes
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、機器IDの組み合わせと一致しない場合にはエラーとなります。
    指定した機器IDが診断不可でない場合にはエラーとなります。
  • #3 「1:承認」を指定

Example Request

{
  "sysId": "SAMPLE0001",
  "ipAddressInfos": [
    {
      "devId": 100001,
      "nwDiagNoneApprovalOrReject":"1",
      "nwDiagOffAppReason":"診断不可承認理由"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ネットワーク診断不可否認(IPアドレス単位)

指定したIPアドレス情報のネットワーク診断不可申請を否認します。
IPアドレス情報にてネットワーク診断可否を「0:診断不可」で登録時に実行できます。
「ネットワーク診断不可承認」(前述)をした対象に実行すると「否認」に変更できます。

PUT /v1/vvsapi/ipaddresses

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
sysId (#1) システムID String Yes
ipAddressInfos IPアドレス情報 Object array Yes
devId (#2) 機器ID String or Int Yes
nwDiagNoneApprovalOrReject (#3) ネットワーク診断不可承認否認(IPアドレス情報) String or Int Yes
nwDiagOffRejReasonCode (#4) 否認種別(IPアドレス情報) String or Int Yes
nwDiagOffRejReason 否認理由詳細(IPアドレス情報) String (#5)
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、機器IDの組み合わせと一致しない場合にはエラーとなります。
    指定した機器IDが診断不可でない場合にはエラーとなります。
  • #3 「0:否認」を指定
  • #4 <候補値>
    1:ネットワーク診断不可理由コード選択が不適切, 2:ネットワーク診断不可理由が不適切,
    3:ネットワーク診断不可の対象外(診断可へ変更要),99:その他
  • #5 否認種別に「99:その他」を選択した場合、必須入力です。

Example Request

{
  "sysId": "SAMPLE0003",
  "ipAddressInfos": [
    {
      "devId": 100003,
      "nwDiagNoneApprovalOrReject":"0",
      "nwDiagOffRejReasonCode":"99",
      "nwDiagOffRejReason":"診断不可否認理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ホスト情報検索

指定したシステムIDに紐づくホスト情報を取得します。
エージェントIDを追加で指定した場合には、指定したエージェントIDのホスト情報を取得します。
※エージェントIDはホスト情報を登録時に発番されるIDです。

GET /v1/vvsapi/hosts?sysId={sysId}&agentId={agentId}&offset={offset}&limit={limit}

Request Parameters

Name Description Mandatoty
sysId 情報取得対象のシステムID Yes
agentId 情報取得対象のエージェントID
offset オフセット値
limit (#1) 返却数上限値
  • #1 指定しない場合、最大50件が返却される

Response Parameters

Name(Nest1) Name(Nest2) Name(Nest3) Description Type
sysId システムID String
hostInfos ホスト情報 Object array
agentId エージェントID Int
hostName ホスト名 String
hostIpAddresses IPアドレスリスト Object array
sysNwSeqNo システムネットワーク通番 Int
ipAddr IPアドレス String
usageCodes (#1) 使用目的リスト(ホスト情報) Intarray
usageText 使用目的(その他)(ホスト情報) String
intOpenFlg (#2) インターネット公開有無(ホスト情報) Int
accessEnvironmentLevels (#3) 利用者アクセス環境リスト(ホスト情報) Int array
piTypeCode (#2) 個人情報有無(ホスト情報) Int
handlingInfoLevels (#4) 取扱利用者情報リスト(ホスト情報) Int array
useSoftwares 利用ソフトウェア(プロダクト) Object array
sidfmApplicationName ソフトウェア String
sidfmApplicationVersion バージョン String
osApTypeCode (#5) 種別情報 Int
supplementaryInfo 補足情報(バージョン等) String
excludedSoftwares マッチング除外ソフトウェアリスト String array
antiVirusTypeCode (#2) アンチウイルス導入有無(ホスト情報) Int
antiVirusProductName アンチウィルス製品名/サービス名(ホスト情報) String
virtualPatchTypeCode (#2) 仮想パッチ/IDS/IPS導入有無(ホスト情報) Int
virtualPatchProductName 仮想パッチ/IDS/IPS製品名/サービス名(ホスト情報) String
wafTypeCode (#2) WAF導入有無(ホスト情報) Int
wafProductName WAF製品名/サービス名(ホスト情報) String
notes1 備考1(ホスト情報) String
notes2 備考2(ホスト情報) String
notes3 備考3(ホスト情報) String
adminNotes1 管理者用備考1(ホスト情報) String
adminNotes2 管理者用備考2(ホスト情報) String
adminNotes3 管理者用備考3(ホスト情報) String
hostLastUpdateTime (#6) 最終更新日時(ホスト情報) String
hostLastUpdatedBy 最終更新者(ホスト情報) String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    1:WEB, 2:DNS, 3:Mail, 4:Firewall, 5:ルータ, 99:その他
  • #2 <候補値>
    0:無, 1:有
  • #3 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限),
    5:その他, 99:不明
  • #4 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #5 <候補値>
    1:OS, 2:AP, 3:その他, 4:未選択
  • #6 yyyy-mm-ddThh:mm:ss±hh:mm形式

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "hostInfos": [
      {
        "agentId": 200000001,
        "hostName": "サンプルホスト名",
        "hostIpAddresses": [
          {
            "sysNwSeqNo": 1,
            "ipAddr": "192.168.0.2"
          },
          {
            "sysNwSeqNo": 2,
            "ipAddr": "1.2.3.4"
          }
        ],
        "usageCodes": [
          1,
          99
        ],
        "usageText": "その他の使用目的",
        "intOpenFlg": 1,
        "accessEnvironmentLevels": [
          2,
          3
        ],
        "piTypeCode": 1,
        "handlingInfoLevels": [
          2,
          4
        ],
        "useSoftwares": [
          {
            "sidfmApplicationName": "sample-os",
            "sidfmApplicationVersion": "1.0",
            "osApTypeCode": 1,
            "supplementaryInfo": "補足情報"
          },
          {
            "sidfmApplicationName": "sample-ap",
            "sidfmApplicationVersion": "2.0",
            "osApTypeCode": 2,
            "supplementaryInfo": ""
          }
        ],
        "excludedSoftwares": [
          "sample-ap"
        ],
        "antiVirusTypeCode": 1,
        "antiVirusProductName": "アンチウィルス製品名/サービス名",
        "virtualPatchTypeCode": 1,
        "virtualPatchProductName": "仮想パッチ/IDS/IPS製品名/サービス名",
        "wafTypeCode": 1,
        "wafProductName": "WAF製品名/サービス名",
        "notes1": "サンプル:ホスト情報備考1",
        "notes2": "",
        "notes3": "",
        "adminNotes1": "サンプル:ホスト情報管理者用備考1",
        "adminNotes2": "",
        "adminNotes3": "",
        "hostLastUpdateTime": "2018-07-01T16:18:57+09:00",
        "hostLastUpdatedBy": "ホスト情報最終更新者"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合(ホスト情報登録なし、システムIDの指定誤りなど)

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ホスト情報新規登録

ホスト情報を新規に登録します。
本APIを実行する前に、システム詳細情報を登録する必要があります。
システム詳細情報の登録については、システム詳細情報API(/detail)をご参照ください。

POST /v1/vvsapi/hosts

Request Parameters

Name(Nest1) Name(Nest2) Name(Nest3) Description Type Mandatoty
sysId (#1) システムID String Yes
hostInfos ホスト情報 Object array Yes
hostName ホスト名 String Yes
hostIpAddresses IPアドレスリスト Object array
sysNwSeqNo (#2) システムネットワーク通番 String or Int
ipAddr (#2) IPアドレス String
usageCodes (#3) 使用目的リスト(ホスト情報) String array or Int array Yes
usageText (#4) 使用目的(その他)(ホスト情報) String
intOpenFlg (#5) インターネット公開有無(ホスト情報) String or Int Yes
accessEnvironmentLevels (#6) 利用者アクセス環境リスト(ホスト情報) String array or Int array
piTypeCode (#5) 個人情報有無(ホスト情報) String or Int Yes
handlingInfoLevels (#7) 取扱利用者情報リスト(ホスト情報) String array or Int array
useSoftwares 利用ソフトウェア(プロダクト) Object array Yes
sidfmApplicationName (#8) ソフトウェア String Yes
sidfmApplicationVersion (#8) バージョン String Yes
osApTypeCode (#9) 種別情報 String or Int Yes
supplementaryInfo 補足情報(バージョン等) String
excludedSoftwares (#10) マッチング除外ソフトウェアリスト String array
antiVirusTypeCode (#5) アンチウイルス導入有無(ホスト情報) String or Int Yes
antiVirusProductName (#11) アンチウィルス製品名/サービス名(ホスト情報) String
virtualPatchTypeCode (#5) 仮想パッチ/IDS/IPS導入有無(ホスト情報) String or Int Yes
virtualPatchProductName (#11) 仮想パッチ/IDS/IPS製品名/サービス名(ホスト情報) String
wafTypeCode (#5) WAF導入有無(ホスト情報) String or Int Yes
wafProductName (#11) WAF製品名/サービス名(ホスト情報) String
notes1 (#12) 備考1(ホスト情報) String
notes2 (#12) 備考2(ホスト情報) String
notes3 (#12) 備考3(ホスト情報) String
adminNotes1 管理者用備考1(ホスト情報) String
adminNotes2 管理者用備考2(ホスト情報) String
adminNotes3 管理者用備考3(ホスト情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、システムネットワーク通番、指定したネットワーク情報のIPアドレス範囲の組み合わせと一致しない場合にはエラーとなります。
  • #3 <候補値>
    1:WEB, 2:DNS, 3:Mail, 4:Firewall, 5:ルータ, 99:その他
  • #4 使用目的で「99:その他」を選択時は入力必須です。
  • #5 <候補値>
    0:無, 1:有
  • #6 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限),
    5:その他, 99:不明
  • #7 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #8 ソフトウェア、バージョンは製品マスタに登録されていない値を入力するとエラーになります。
  • #9 <候補値>
    1:OS, 2:AP, 3:その他, 4:未選択
  • #10 製品マスタに登録されていないソフトウェアを入力するとエラーになります。
  • #11 該当する製品導入有無で「1:有」を選択時は入力必須です。
  • #12 契約にて入力必須と設定依頼されている場合、入力必須です。

Example Request

{
  "sysId": "SAMPLE0001",
  "hostInfos": [
    {
      "hostName": "サンプルホスト名",
      "hostIpAddresses": [
        {
          "sysNwSeqNo": 1,
          "ipAddr": "192.168.0.2"
        },
        {
          "sysNwSeqNo": 2,
          "ipAddr": "1.2.3.4"
        }
      ],
      "usageCodes": [
        1,
        99
      ],
      "usageText": "その他の使用目的",
      "intOpenFlg": 1,
      "accessEnvironmentLevels": [
        2,
        3
      ],
      "piTypeCode": 1,
      "handlingInfoLevels": [
        2,
        4
      ],
      "useSoftwares": [
        {
          "sidfmApplicationName": "sample-os",
          "sidfmApplicationVersion": "1.0",
          "osApTypeCode": 1,
          "supplementaryInfo": "補足情報"
        },
        {
          "sidfmApplicationName": "sample-ap",
          "sidfmApplicationVersion": "2.0",
          "osApTypeCode": 2,
          "supplementaryInfo": ""
        }
      ],
      "excludedSoftwares": [
        "sample-ap"
      ],
      "antiVirusTypeCode": 1,
      "antiVirusProductName": "アンチウィルス製品名/サービス名",
      "virtualPatchTypeCode": 1,
      "virtualPatchProductName": "仮想パッチ/IDS/IPS製品名/サービス名",
      "wafTypeCode": 1,
      "wafProductName": "WAF製品名/サービス名",
      "notes1": "サンプル:ホスト情報備考1",
      "notes2": "サンプル:ホスト情報備考2",
      "notes3": "サンプル:ホスト情報備考3",
      "adminNotes1": "サンプル:ホスト情報管理者用備考1",
      "adminNotes2": "サンプル:ホスト情報管理者用備考2",
      "adminNotes3": "サンプル:ホスト情報管理者用備考3"
    }
  ]
}

Response Parameters

Name Description Type
sysId システムID String
agentIds エージェントIDリスト String array or Int array
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "result": {
    "sysId": "SAMPLE0001",
    "agentIds": [
      200000001
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

ホスト情報更新

ホスト情報を更新します。
項目を空にする場合には値を空欄でリクエストしてください。
任意項目のリストを空にする場合には空配列でリクエストしてください。
(例: "accessEnvironmentLevels":[])

PUT /v1/vvsapi/hosts

Request Parameters

Name(Nest1) Name(Nest2) Name(Nest3) Description Type Mandatoty
sysId (#1) システムID String Yes
hostInfos ホスト情報 Object array Yes
agentId (#2) エージェントID String or Int Yes
hostName ホスト名 String
hostIpAddresses (#3) IPアドレスリスト Object array
sysNwSeqNo (#4) String or Int
ipAddr (#4) IPアドレス String
usageCodes (#3,#5,#6) 使用目的リスト(ホスト情報) String array or Int array
usageText (#7) 使用目的(その他)(ホスト情報) String
intOpenFlg (#5,#8) インターネット公開有無(ホスト情報) String or Int
accessEnvironmentLevels (#3,#9) 利用者アクセス環境リスト(ホスト情報) String array or Int array
piTypeCode (#5,#8) 個人情報有無(ホスト情報) String or Int
handlingInfoLevels (#3,#10) 取扱利用者情報リスト(ホスト情報) String array or Int array
useSoftwares (#3,#5) 利用ソフトウェア(プロダクト) Object array
sidfmApplicationName (#5,#11) String
sidfmApplicationVersion (#5,#11) String
osApTypeCode (#5,#12) String
supplementaryInfo String
excludedSoftwares (#3,#13) マッチング除外ソフトウェアリスト String array
antiVirusTypeCode (#5,#8) アンチウイルス導入有無(ホスト情報) String or Int
antiVirusProductName (#14) アンチウィルス製品名/サービス名(ホスト情報) String
virtualPatchTypeCode (#5,#8) 仮想パッチ/IDS/IPS導入有無(ホスト情報) String or Int
virtualPatchProductName (#14) 仮想パッチ/IDS/IPS製品名/サービス名(ホスト情報) String
wafTypeCode (#5,#8) WAF導入有無(ホスト情報) String or Int
wafProductName (#14) WAF製品名/サービス名(ホスト情報) String
notes1 (#15) 備考1(ホスト情報) String
notes2 (#15) 備考2(ホスト情報) String
notes3 (#15) 備考3(ホスト情報) String
adminNotes1 管理者用備考1(ホスト情報) String
adminNotes2 管理者用備考2(ホスト情報) String
adminNotes3 管理者用備考3(ホスト情報) String
  • #1 登録されているシステムIDと一致しない場合にはエラーとなります。
  • #2 登録されているシステムID、エージェントIDの組み合わせと一致しない場合にはエラーとなります。
  • #3 リストでリクエストする項目は、リスト内容で登録済の内容を上書き更新します。
    追加処理ではないため実行する際はご注意ください。
  • #4 登録されているシステムID、システムネットワーク通番、指定したネットワーク情報のIPアドレス範囲の組み合わせと一致しない場合にはエラーとなります。
  • #5 リクエストに本項目を指定する場合、空欄で更新はできません。
  • #6 <候補値>
    1:WEB, 2:DNS, 3:Mail, 4:Firewall, 5:ルータ, 99:その他
  • #7 使用目的で「99:その他」を選択時は入力必須です。
  • #8 <候補値>
    0:無, 1:有
  • #9 <候補値>
    1:制限なし(特定ポート/サービス解放), 2:特定IPのみ(アクセス元IP制限),
    3:特定ホストのみ(デバイス制限), 4:特定ユーザのみ(利用者制限)
    5:その他, 99:不明
  • #10 <候補値>
    1:会社名, 2:氏名, 3:電話番号, 4:メールアドレス,
    5:クレジットカード情報, 6:口座情報, 7:設備情報,
    8:その他のお客様情報, 9:お客様情報なし, 99:不明
  • #11 ソフトウェア、バージョンは製品マスタに登録されていない値を入力するとエラーになります。
  • #12 <候補値>
    1:OS, 2:AP, 3:その他, 4:未選択
  • #13 製品マスタに登録されていないソフトウェアを入力するとエラーになります。
  • #14 該当する製品導入有無で「1:有」を選択時は入力必須です。
  • #15 契約にて入力必須と設定依頼されている場合、リクエストに本項目を指定する際に、空欄で更新はできません。

Request Parameters

{
  "sysId": "SAMPLE0001",
  "hostInfos": [
    {
      "agentId": 200000001,
      "hostName": "サンプルホスト名",
      "hostIpAddresses": [
        {
          "sysNwSeqNo": 1,
          "ipAddr": "192.168.0.2"
        }
      ],
      "usageCodes": [
        1,
        99
      ],
      "usageText": "その他の使用目的",
      "intOpenFlg": 1,
      "accessEnvironmentLevels": [
        2,
        4
      ],
      "piTypeCode": 1,
      "handlingInfoLevels": [
        2,
        3
      ],
      "useSoftwares": [
        {
          "sidfmApplicationName": "sample-os",
          "sidfmApplicationVersion": "1.0",
          "osApTypeCode": 1,
          "supplementaryInfo": "補足情報"
        },
        {
          "sidfmApplicationName": "sample-ap",
          "sidfmApplicationVersion": "2.0",
          "osApTypeCode": 2,
          "supplementaryInfo": ""
        },
        {
          "sidfmApplicationName": "sample-other",
          "sidfmApplicationVersion": "バージョン無し",
          "osApTypeCode": 3,
          "supplementaryInfo": "ハードウェア"
        }
      ],
      "excludedSoftwares": [
        "sample-ap",
        "sample-other"
      ],
      "antiVirusTypeCode": 1,
      "antiVirusProductName": "アンチウィルス製品名/サービス名",
      "virtualPatchTypeCode": 1,
      "virtualPatchProductName": "仮想パッチ/IDS/IPS製品名/サービス名",
      "wafTypeCode": 1,
      "wafProductName": "WAF製品名/サービス名",
      "notes1": "サンプル:ホスト情報備考1",
      "notes2": "サンプル:ホスト情報備考2",
      "notes3": "サンプル:ホスト情報備考3",
      "adminNotes1": "サンプル:ホスト情報管理者用備考1",
      "adminNotes2": "サンプル:ホスト情報管理者用備考2",
      "adminNotes3": "サンプル:ホスト情報管理者用備考3"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

ホスト情報削除

指定したエージェントIDのホスト情報を削除します。

DELETE /v1/vvsapi/hosts?sysId={sysId}&agentId={agentId}

Request Parameters

Name Description Mandatoty
sysId 削除対象が紐づくシステムID Yes
agentId 削除対象のエージェントID Yes

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(ネットワーク診断)検索

指定した検索条件に紐づくネットワーク診断 対策管理情報を取得します。

POST /v1/vvsapi/nw-measures

Request Parameters

Name Description Type Mandatoty
sysId (#1) システムID String
sysName (#1) システム名 String
orgName (#1) 組織名 String
nwDiagTypePlanCodes (#2) 診断プラン String arrayor Int array
nwDiagId (#1) ネットワーク診断ID String
nwVulnId (#1) 脆弱性ID String
riskLevels (#3) リスクレベル String array or Int array
measStatusCodes (#4) 対策ステイタス String array or Int array
ipAddrStart (#4) IPアドレス(From) String
ipAddrEnd (#6) IPアドレス(To)(第4オクテット) String
nwDiagMeasNotifiedStartDate 通知日(From)(yyyy-mm-dd形式) String
nwDiagMeasNotifiedEndDate 通知日(To)(yyyy-mm-dd形式) String
offset オフセット値 String
limit (#7) 返却数上限値 String
  • #1 部分一致で検索する
  • #2 <候補値>
    11:監査NP-A, 12:監査NP-B
    13:セルフNP-A, 14:セルフNP-B
  • #3 <候補値>
    1:Risk1, 2:Risk2, 3:Risk3, 4:Risk4, 5:Risk5
  • #4 <候補値>
    10:対策要否/予定未登録, 20:対策予定(対策未完了)
    30:対策不要申請中, 40:対策不要(登録完了)
    50:対策不要否認, 60:対策完了(登録完了)
  • #5 IPアドレス形式で入力。IPアドレス(To)を指定時は入力が必要です。
  • #6 第4オクテット部を入力。本項目を指定する場合、IPアドレス(From)の入力が必要です。
  • #7 指定しない場合、最大50件が返却される

Example Request

{
  "sysId": "SAMPLE0001",
  "sysName": "サンプルシステム",
  "orgName": "サンプル組織",
  "nwDiagTypePlanCodes":[
    13
  ],
  "nwDiagId": "NIG1234567",
  "nwVulnId": "ssl-self-signed-certificate",
  "riskLevels":[
    2
  ],
  "measStatusCodes":[
    50,
    60
  ],
  "ipAddrStart": "1.2.3.1",
  "ipAddrEnd": "4",
  "nwDiagMeasNotifiedStartDate":"2018-07-01",
  "nwDiagMeasNotifiedEndDate":"2018-07-31"
}

Response Parameters

Name(Nest1) Name(Nest2) Description Type
measInfos 対策管理情報 Object array
nwDiagId ネットワーク診断ID String
nwDiagTypePlanCode (#1) 診断プラン Int
nwVulnType (#2) 脆弱性区分 Int
riskLevel (#3) リスクレベル Int
cvssBaseScore CVSS BASE Float
cvssTempScore CVSS TEMPORAL Float
nwVulnId 脆弱性ID String
portNo ポートNo Int
branchNo 枝番 Int
nwVulnTitle タイトル String
reference Reference String
nwDiagDevId ネットワーク診断機器ID Int
ipAddr IPアドレス String
devName IP識別名 String
orgName 組織名 String
sysId システムID String
sysName システム名 String
systemAdministrator システム責任者 String
empMail システム責任者メールアドレス String
empTel システム責任者電話番号 String
empDept1 システム責任者所属1 String
empDept2 システム責任者所属2 String
empDept3 システム責任者所属3 String
empDept4 システム責任者所属4 String
empDept5 システム責任者所属5 String
measStatusCode (#4) 対策ステイタス Int
meas (#5) 対策要否 Int
measScheDate 対策予定日(yyyy-mm-dd形式) String
measContKind (#6) 対策内容区分 Int
measCont 対策内容 String
measExecDate 対策実施日(yyyy-mm-dd形式) String
measNoneReasonCode (#7) 対策不要理由 Int
measNoneReason 対策不要詳細 String
measNoneApprovalOrRejectDate (#8) 対策不要承認否認登録日 String
measAprReason 承認理由 String
measAprType (#9) 承認種別 Int
measRejReasonCode (#10) 否認種別 Int
measRejReason 否認理由詳細 String
nwVulnExecDate 通知日(yyyy-mm-dd形式) String
measStatusUpdateTime (#8) 対策ステイタス更新日 String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    11:監査NP-A, 12:監査NP-B
    13:セルフNP-A, 14:セルフNP-B
  • #2 <候補値>
    1:Information Gathered, 2:Services
    3:Vulnerabilities, 4:Potential Vulnerabilities
  • #3 <候補値>
    1:Risk1, 2:Risk2, 3:Risk3, 4:Risk4, 5:Risk5
  • #4 <候補値>
    10:対策要否/予定未登録, 20:対策予定(対策未完了)
    30:対策不要申請中, 40:対策不要(登録完了)
    50:対策不要否認, 60:対策完了(登録完了)
  • #5 <候補値>
    1:要, 0:不要
  • #6 <候補値>
    1:パッチ適用, 2:ワークアラウンド(設定対処), 3:代替策
    4:運用対処, 5:サービス停止, 6:その他
  • #7 <候補値>
    1:サービス未使用/未起動, 2:リスク許容
    3:誤検出(ネットワーク診断のみ選択可), 99:その他
  • #8 yyyy-mm-ddThh:mm:ss±hh:mm形式
  • #9 <候補値>
    2:今回限り承認
  • #10 <候補値>
    1:不可理由不適切, 99:その他

Example Response

{
  "result": {
    "measInfos": [
      {
        "nwDiagId": "NIG1234567",
        "nwDiagTypePlanCode": 13,
        "nwVulnType": 3,
        "riskLevel": 2,
        "cvssBaseScore": 4.3,
        "cvssTempScore": null,
        "nwVulnId": "ssl-self-signed-certificate",
        "portNo": 443,
        "branchNo": 1,
        "nwVulnTitle": "TLS/SSL 自己署名証明書",
        "reference": null,
        "nwDiagDevId": 100001,
        "ipAddr": "1.2.3.4",
        "devName": "サンプル:IP識別名",
        "orgName": "サンプル組織",
        "sysId": "SAMPLE0001",
        "sysName": "サンプルシステム",
        "systemAdministrator": "システム責任者",
        "empMail": "sample-sysadmin@xxxx.xx.xx",
        "empTel": "0312345678",
        "empDept1": "サンプル所属1",
        "empDept2": "サンプル所属2",
        "empDept3": "サンプル所属3",
        "empDept4": "サンプル所属4",
        "empDept5": "サンプル所属5",
        "measStatusCode": 60,
        "meas": 1,
        "measScheDate": "2018-07-20",
        "measContKind": 6,
        "measCont": "対策内容詳細",
        "measExecDate": "2018-07-18",
        "measNoneReasonCode": null,
        "measNoneReason": null,
        "measNoneApprovalOrRejectDate": null,
        "measAprType": null,
        "measAprReason": null,
        "measRejReasonCode": null,
        "measRejReason": null,
        "nwVulnExecDate": "2018-07-01",
        "measStatusUpdateTime": "2018-07-20T15:21:12+09:00"
      },
      {
        "nwDiagId": "NIG1234567",
        "nwDiagTypePlanCode": 13,
        "nwVulnType": 3,
        "riskLevel": 2,
        "cvssBaseScore": 4.3,
        "cvssTempScore": null,
        "nwVulnId": "ssl-self-signed-certificate",
        "portNo": 443,
        "branchNo": 1,
        "nwVulnTitle": "TLS/SSL 自己署名証明書",
        "reference": null,
        "nwDiagDevId": 100002,
        "ipAddr": "1.2.3.4",
        "devName": "サンプル:IP識別名2",
        "orgName": "サンプル組織",
        "sysId": "SAMPLE0001",
        "sysName": "サンプルシステム",
        "systemAdministrator": "システム責任者",
        "empMail": "sample-sysadmin@xxxx.xx.xx",
        "empTel": "0312345678",
        "empDept1": "サンプル所属1",
        "empDept2": "サンプル所属2",
        "empDept3": "サンプル所属3",
        "empDept4": "サンプル所属4",
        "empDept5": "サンプル所属5",
        "measStatusCode": 50,
        "meas": 0,
        "measScheDate": null,
        "measContKind": null,
        "measCont": null,
        "measExecDate": null,
        "measNoneReasonCode": 2,
        "measNoneReason": "対策不要理由詳細",
        "measNoneApprovalOrRejectDate": "2018-07-18T11:15:06+09:00",
        "measAprType": null,
        "measAprReason": null,
        "measRejReasonCode": 99,
        "measRejReason": "否認理由詳細",
        "nwVulnExecDate": "2018-07-01",
        "measStatusUpdateTime": "2018-07-18T15:21:12+09:00"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合(ネットワーク診断 対策管理情報なし、システムIDの指定誤りなど)

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(ネットワーク診断)対策予定/対策実施 登録

ネットワーク診断の対策管理情報として、対策予定/対策実施を登録します。

PUT /v1/vvsapi/nw-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
nwVulnId (#1) 脆弱性ID String Yes
nwDiagId (#1) ネットワーク診断ID String Yes
nwDiagDevId (#1) ネットワーク診断機器ID String or Int Yes
portNo (#1) ポートNo String or Int Yes
branchNo (#1) 枝番 String or Int Yes
meas (#2) 対策要否 String or Int Yes
measScheDate 対策予定日(yyyy-mm-dd形式) String Yes
measContKind (#3) 対策内容区分 String or Int Yes
measCont 対策内容 String Yes
measExecDate (#4) 対策実施日(yyyy-mm-dd形式) String
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
  • #2 「1:要」を指定
  • #3 <候補値>
    1:パッチ適用, 2:ワークアラウンド(設定対処), 3:代替策,
    4:運用対処, 5:サービス停止, 6:その他
  • #4 対策完了入力する場合に入力する項目です。対策予定登録する場合には入力不要です。

Example Request

{
  "measInfos":[
    {
      "nwVulnId": "tls-untrusted-ca",
      "nwDiagId": "NIG1234567",
      "nwDiagDevId": 100001,
      "portNo": 443,
      "branchNo": 1,
      "meas": 1,
      "measScheDate": "2018-07-20",
      "measContKind": 1,
      "measCont": "対策内容",
      "measExecDate": "2018-07-18"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(ネットワーク診断)対策不要登録

ネットワーク診断の対策管理情報として、対策不要を登録します。

PUT /v1/vvsapi/nw-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
nwVulnId (#1) 脆弱性ID String Yes
nwDiagId (#1) ネットワーク診断ID String Yes
nwDiagDevId (#1) ネットワーク診断機器ID String or Int Yes
portNo (#1) ポートNo String or Int Yes
branchNo 枝番 (#1) String or Int Yes
meas (#2) 対策要否 String or Int Yes
measNoneReasonCode (#3) 対策不要理由 String or Int Yes
measNoneReason 対策不要理由詳細 String Yes
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
  • #2 「0:不要」を指定
  • #3 <候補値>
    1:サービス未使用/未起動, 2:リスク許容,
    3:誤検出(ネットワーク診断のみ選択可), 99:その他

Example Request

{
  "measInfos":[
    {
      "nwVulnId": "tls-untrusted-ca",
      "nwDiagId": "NIG1234567",
      "nwDiagDevId": 100001,
      "portNo": 443,
      "branchNo": 1,
      "meas": 0,
      "measNoneReasonCode": 99,
      "measNoneReason": "対策不要理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(ネットワーク診断)対策不要承認

「0:対策不要」として登録されたネットワーク診断の対策管理情報を承認します。
「対策不要否認」(後述)を対象とした場合は、「対策不要承認」に更新します。

PUT /v1/vvsapi/nw-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
nwVulnId (#1) 脆弱性ID String Yes
nwDiagId (#1) ネットワーク診断ID String Yes
nwDiagDevId (#1) ネットワーク診断機器ID String or Int Yes
portNo (#1) ポートNo String or Int Yes
branchNo (#1) 枝番 String or Int Yes
measNoneApprovalOrReject (#2) 対策不要承認否認 String or Int Yes
measAprReason 承認理由 String Yes
measAprType (#3) 承認種別 String or Int
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
    また、対策要否が「1:要」として登録された対象を指定した場合にもエラーとなります。
  • #2 「1:承認」を指定
  • #3 <候補値>
    2:今回限り承認

Example Request

{
  "measInfos":[
    {
      "nwVulnId": "tls-untrusted-ca",
      "nwDiagId": "NIG1234567",
      "nwDiagDevId": 100001,
      "portNo": 443,
      "branchNo": 1,
      "measNoneApprovalOrReject": 1,
      "measAprReason": "対策不要承認理由",
      "measAprType": 2
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(ネットワーク診断)対策不要否認

「0:対策不要」として登録されたネットワーク診断の対策管理情報を否認します。
「対策不要承認」(前述)を対象とした場合は、「対策不要否認」に更新します。

PUT /v1/vvsapi/nw-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
nwVulnId (#1) 脆弱性ID String Yes
nwDiagId (#1) ネットワーク診断ID String Yes
nwDiagDevId (#1) ネットワーク診断機器ID String or Int Yes
portNo (#1) ポートNo String or Int Yes
branchNo (#1) 枝番 String or Int Yes
measNoneApprovalOrReject (#2) 対策不要承認否認 String or Int Yes
measRejReasonCode (#3) 否認種別 String or Int Yes
measRejReason 否認理由詳細 String (#4)
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
    また、対策要否が「1:要」として登録された対象を指定した場合にもエラーとなります。
  • #2 「0:否認」を指定
  • #3 <候補値>
    1:不可理由不適切, 99:その他
  • #4 否認種別が「99:その他」の場合、入力必須です。

Example Request

{
  "measInfos":[
    {
      "nwVulnId": "tls-untrusted-ca",
      "nwDiagId": "NIG1234567",
      "nwDiagDevId": 100001,
      "portNo": 443,
      "branchNo": 1,
      "measNoneApprovalOrReject": 0,
      "measRejReasonCode": 99,
      "measRejReason": "否認理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(セキュリティ情報)検索

指定した検索条件に紐づくセキュリティ情報 対策管理情報を取得します。

POST /v1/vvsapi/sh-measures

Request Paraeters

Name Description Type Mandatoty
sysId (#1) システムID String
sysName (#1) システム名 String
orgName (#1) 組織名 String
docId (#1) 脆弱性ID String or Int
riskLevels (#2) リスクレベル String array or Int array
measStatusCodes (#3) 対策ステイタス String array or Int array
shMeasNotifiedStartDate 登録日(From)(yyyy-mm-dd形式) String
shMeasNotifiedEndDate 登録日(To)(yyyy-mm-dd形式) String
shAffectedProduct (#1) 影響ソフトウェア String
offset オフセット値 String
limit (#4) 返却数上限値 String
  • #1 部分一致で検索する
  • #2 <候補値>
    1:Risk1, 2:Risk2, 3:Risk3, 4:Risk4, 5:Risk5
  • #3 <候補値>
    10:対策要否/予定未登録, 20:対策予定(対策未完了),
    30:対策不要申請中, 40:対策不要(登録完了),
    50:対策不要否認, 60:対策完了(登録完了)
  • #4 指定しない場合、最大50件が返却される

Example Request

{
  "sysId": "SAMPLE0001",
  "sysName": "サンプルシステム",
  "orgName": "サンプル組織",
  "docId": 104510,
  "riskLevels":[
    4
  ],
  "measStatusCodes":[
    50
  ],
  "shMeasNotifiedStartDate": "2018-07-01"
  "shMeasNotifiedEndDate": "2018-07-31"
  "shAffectedProduct": "redhat enterprise linux server 7"
}

Response Parameters

Name(Nest1) Name(Nest2) Description Type
measInfos 対策管理情報 Object array
riskLevel (#1) リスクレベル Int
docId 脆弱性ID Int
title タイトル String
shVulnCveId (#2) CVEID String
baseScore CVSSv2(基本値) Float
targetOsAp (#3) マッチングソフトウェア String
agentId エージェントID Int
hostName ホスト名 String
ipAddr (#3) IPアドレス String
orgName 組織名 String
sysId システムID String
sysName システム名 String
systemAdministrator システム責任者 String
empMail システム責任者メールアドレス String
empTel システム責任者電話番号 String
empDept1 システム責任者所属1 String
empDept2 システム責任者所属2 String
empDept3 システム責任者所属3 String
empDept4 システム責任者所属4 String
empDept5 システム責任者所属5 String
measStatusCode (#4) 対策ステイタス Int
meas (#5) 対策要否 Int
measScheDate 対策予定日(yyyy-mm-dd形式) String
measContKind (#6) 対策内容区分 Int
measCont 対策内容 String
measExecDate 対策実施日(yyyy-mm-dd形式) String
measNoneReasonCode (#7) 対策不要理由 Int
measNoneReason 対策不要詳細 String
measNoneApprovalOrRejectDate (#8) 対策不要承認否認登録日 String
measAprReason 承認理由 String
measRejReasonCode (#9) 否認種別 Int
measRejReason 否認理由詳細 String
shVulnRegisteredDate 通知日(yyyy-mm-dd形式) String
measStatusUpdateTime (#8) 対策ステイタス更新日 String
statusCode ステータスコード String
statusDispNm ステータス(表示名) String
  • #1 <候補値>
    1:Risk1, 2:Risk2, 3:Risk3, 4:Risk4, 5:Risk5
  • #2 複数件該当する場合には、カンマ区切りで返却されます。
  • #3 複数件該当する場合には、コロン区切りで返却されます。
  • #4 <候補値>
    10:対策要否/予定未登録, 20:対策予定(対策未完了),
    30:対策不要申請中, 40:対策不要(登録完了),
    50:対策不要否認, 60:対策完了(登録完了)
  • #5 <候補値>
    1:要, 0:不要
  • #6 <候補値>
    1:対策内容検討中, 2:パッチ適用/バージョンアップ,
    3:リスク低減対処(設定対処), 4:リスク低減対処(運用対処),
    5:リスク低減対処(代替策), 6:サービス停止, 99:その他
  • #7 <候補値>
    1:サービス未使用/未起動, 2:リスク許容,
    3:誤検出(ネットワーク診断のみ選択可), 99:その他
  • #8 yyyy-mm-ddThh:mm:ss±hh:mm形式
  • #9 <候補値>
    1:不可理由不適切, 99:その他

Example Response

{
  "result": {
    "measInfos": [
      {
        "riskLevel": 4,
        "docId": 104510,
        "title": "Librelp CVE-2018-1000140スタックベースのバッファオーバーフローの脆弱性",
        "shVulnCveId": "CVE-2018-1000140",
        "baseScore": 7.6,
        "targetOsAp": "redhat enterprise linux server 7",
        "agentId": 200000001,
        "hostName": "サンプルホスト名",
        "ipAddr": "192.168.0.2:1.2.3.4",
        "orgName": "サンプル組織",
        "sysId": "SAMPLE0001",
        "sysName": "サンプルシステム",
        "systemAdministrator": "システム責任者",
        "empMail": "sample-sysadmin@xxxx.xx.xx",
        "empTel": "0312345678",
        "empDept1": "サンプル所属1",
        "empDept2": "サンプル所属2",
        "empDept3": "サンプル所属3",
        "empDept4": "サンプル所属4",
        "empDept5": "サンプル所属5",
        "measStatusCode": 50,
        "meas": 0,
        "measScheDate": null,
        "measContKind": null,
        "measCont": null,
        "measExecDate": null,
        "measNoneReasonCode": 99,
        "measNoneReason": "対策不要理由詳細",
        "measNoneApprovalOrRejectDate": "2018-07-20T13:20:29+09:00",
        "measAprReason": null,
        "measRejReasonCode": 99,
        "measRejReason": "否認理由詳細",
        "shVulnRegisteredDate": "2018-06-21T01:19:12+09:00",
        "measStatusUpdateTime": "2018-07-20T13:20:29+09:00"
      }
    ]
  },
  "statusCode": "200",
  "statusDispNm": "OK"
}

該当0件の場合(セキュリティ情報 対策管理情報なし、システムIDの指定誤りなど)

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(セキュリティ情報)対策予定/対策実施登録

セキュリティ情報の対策管理情報として、対策予定/対策実施を登録します。

PUT /v1/vvsapi/sh-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
sysId (#1) システムID String Yes
agentId (#1) エージェントID String or Int Yes
docId (#1) 脆弱性ID String or Int Yes
meas (#2) 対策要否 String or Int Yes
measScheDate 対策予定日(yyyy-mm-dd形式) String Yes
measContKind (#2) 対策内容区分 String or Int Yes
measCont 対策内容 String Yes
measExecDate (#3) 対策実施日(yyyy-mm-dd形式) String
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
  • #2 「1:要」を指定
  • #3 <候補値>
    1:対策内容検討中, 2:パッチ適用/バージョンアップ,
    3:リスク低減対処(設定対処), 4:リスク低減対処(運用対処),
    5:リスク低減対処(代替策), 6:サービス停止, 99:その他
  • #4 対策完了登録する場合に入力する項目です。対策予定登録する場合には入力不要です。

Example Request

対策予定を登録する場合

{
  "measInfos":[
    {
      "sysId": "SAMPLE0001",
      "agentId": 200000001,
      "docId": 104510,
      "meas": 1,
      "measScheDate": "2018-07-20",
      "measContKind": 1,
      "measCont": "対策内容",
    }
  ]
}

対策完了を登録する場合(対策予定登録した対象を更新する場合も同様)

{
  "measInfos":[
    {
      "sysId": "SAMPLE0001",
      "agentId": 200000001,
      "docId": 104510,
      "meas": 1,
      "measScheDate": "2018-07-20",
      "measContKind": 1,
      "measCont": "対策内容",
      "measExecDate": "2018-07-18"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

    {
      "statusCode": "200",
      "statusDispNm": "OK"
    }

対策管理情報(セキュリティ情報)対策不要登録

セキュリティ情報の対策管理情報として、対策不要を登録します。

PUT /v1/vvsapi/sh-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
sysId (#1) システムID String Yes
agentId (#1) エージェントID String or Int Yes
docId (#1) 脆弱性ID String or Int Yes
meas 対策要否 (#2) String or Int Yes
measNoneReasonCode (#3) 対策不要理由 String or Int Yes
measNoneReason 対策不要理由詳細 String Yes
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
  • #2 「0:不要」を指定
  • #3 <候補値>
    1:サービス未使用/未起動, 2:リスク許容, 99:その他

Example Request

{
  "measInfos":[
    {
      "sysId": "SAMPLE0001",
      "agentId": 200000001,
      "docId": 104510,
      "meas": 0,
      "measNoneReasonCode": 99,
      "measNoneReason": "対策不要理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(セキュリティ情報)対策不要承認

「0:対策不要」として登録されたセキュリティ情報の対策管理情報を承認します。
「対策不要否認」(後述)を対象とした場合は、「対策不要承認」に更新します。

PUT /v1/vvsapi/sh-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
sysId (#1) システムID String Yes
agentId (#1) エージェントID String or Int Yes
docId (#1) 脆弱性ID String or Int Yes
measNoneApprovalOrReject (#2) 対策不要承認否認 String or Int Yes
measAprReason 承認理由 String Yes
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
    また、対策要否が「1:要」として登録された対象を指定した場合にもエラーとなります。
  • #2 「1:承認」を指定

Example Request

{
  "measInfos":[
    {
      "sysId": "SAMPLE0001",
      "agentId": 200000001,
      "docId": 104510,
      "measNoneApprovalOrReject": 1,
      "measAprReason": "対策不要承認理由",
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}

対策管理情報(セキュリティ情報)対策不要否認

「0:対策不要」として登録されたセキュリティ情報の対策管理情報を否認します。
「対策不要承認」(前述)を対象とした場合は、「対策不要否認」に更新します。

PUT /v1/vvsapi/sh-measures

Request Parameters

Name(Nest1) Name(Nest2) Description Type Mandatoty
measInfos 対策管理情報 Object array Yes
sysId (#1) システムID String Yes
agentId (#1) エージェントID String or Int Yes
docId (#1) 脆弱性ID String or Int Yes
measNoneApprovalOrReject (#2) 対策不要承認否認 String or Int Yes
measRejReasonCode (#3) 否認種別 String or Int Yes
measRejReason 否認理由詳細 String (#4)
  • #1 対策管理情報を特定する項目です。登録済の内容と一致しない場合はエラーとなります。
    また、対策要否が「1:要」として登録された対象を指定した場合にもエラーとなります。
  • #2 「0:否認」を指定
  • #3 <候補値>
    1:不可理由不適切, 99:その他
  • #4 否認種別が「99:その他」の場合、入力必須です。

Example Request

{
  "measInfos":[
    {
      "sysId": "SAMPLE0001",
      "agentId": 200000001,
      "docId": 104510,
      "measNoneApprovalOrReject": 0,
      "measRejReasonCode": 99,
      "measRejReason": "否認理由詳細"
    }
  ]
}

Response Parameters

Name Description Type
statusCode ステータスコード String
statusDispNm ステータス(表示名) String

Example Response

{
  "statusCode": "200",
  "statusDispNm": "OK"
}