構成管理 REST API

構成グループ登録

  1. 処理概要

    グループを登録します。

  2. HTTPメソッド

    POST

  3. URL

    /v1/groups

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    group_name string グループ名を指定する。 不可 ‐ グループ名はテナント配下で重複不可
    parent_group_id string 親グループIDを指定する。 可 0 ルート直下にグループを追加する場合は0を指定
    comment string 任意のコメントを記述する。 可 ‐ 256文字以内の文字列
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    201 Created グループの登録が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    group_id string 登録したグループのグループID

  7. 変更履歴

    【リクエスト】

    POST /v1/groups HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 84

{
  "group_name" : "GroupA",
  "tenant_id" : "5caef1e101c2025400d5f2a3"
}

    【レスポンス】

    HTTP/1.1 201 OK
Content-Type: application/json; charset=utf-8
Content-Length: 28

{
  "group_id": "0000000123"
}

構成グループ更新

  1. 処理概要

    グループを更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/groups/***group\_id***

    group_id には更新するグループのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    group_name string グループ名を指定する。 可 ‐ グループ名はテナント配下で重複不可
    parent_group_id string 親グループIDを指定する。 可 ‐ ルート直下にグループを移動する場合は0を指定
    comment string 任意のコメントを記述する。 可 ‐ 256文字以内の文字列
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK グループの更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    POST /v1/groups/0000000123 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 32

{
  "tenant_id" : "5caef1e101c2025400d5f2a3"
}

    【レスポンス】

    HTTP/1.1 200 OK

構成グループ構成情報収集契機更新

  1. 処理概要

    グループの構成情報収集契機を更新します。
構成情報収集契機をクリアする場合は、InventoryTriggersの配列要素を空で指定します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/groups/***group\_id***/configurations

    group_id には更新するグループのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    conf_list array 構成情報収集契機情報のリスト。 不可 ‐ ‐
    function_name string 機能名を指定する。 不可 ‐ ・inventory_manager
    config_name string グループ名を指定する 不可 ‐ ・グループ名
    comment string 任意のコメントを指定する。 可 ‐ 256文字以内の文字列
    conf array 構成情報収集契機情報のリスト。 不可 ‐ ‐
    priority integer 優先度を指定する。 不可 ‐ 数値
    InventoryTriggers array 構成情報収集契機情報のリスト。 不可 ‐ ‐
    TriggerType string 収集契機の種類を指定する。 不可 ‐ ・"wakeup"：システム起動
    ・"weekly"：毎週
    ・"monthly"：毎月
    TriggerRepeats string 収集契機の繰り返しを指定する。 不可 ‐ 【TriggerTypeが"wakeup"、"monthly"の場合】
    ・""(値なし)
    【TriggerTypeが"weekly"の場合】
    ・曜日に対し契機あり/なしを0/1の数値で指定
    　月、水、金が契機として指定されている場合は"0101010"
    TriggerDate string 収集契機の日付を指定する。 不可 ‐ 【TriggerTypeが"wakeup"、"weekly"の場合】
    ・""(値なし)
    【 TriggerTypeが"monthly"の場合】
    ・指定する日
    TriggerTime string 収集契機の時刻を指定する。 不可 ‐ 【TriggerTypeが"wakeup"の場合】
    ・""(値なし)
    【TriggerTypeが"weekly"、"monthly"の場合】
    ・指定する時刻("00:00"の形式)(24時間表記)

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK グループの更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/groups/0000000123/configurations HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 650

{
  "tenant_id" : "5caef1e101c2025400d5f2a3"
  "conf_list" :  [{
    "function_name" : "inventory_manager",
    "config_name" : "GroupA",
    "comment" : "",
    "conf" :  [
    {
      "priority" : "1",
      "InventoryTriggers" : [
      {
        "TriggerType" : "wakeup",
        "TriggerRepeats" : "",
        "TriggerDate" : "",
        "TriggerTime" : ""
      },
       ・・・ InventoryTriggers の数分続く
      ]
    },
     ・・・ conf の数分続く
    ]
  }
　・・・ conf_list の数分続く
  ]
}

    【レスポンス】

    HTTP/1.1 200 OK

構成グループ取得

  1. 処理概要

    グループを取得します。
group_idを指定した場合は、指定したグループ直下のグループを取得します。
group_idを指定しなかった場合は、全グループを取得します。
group_idに「0」を指定した場合は、ルート直下のグループを取得します。
group_idに「0000000000」(0を10桁)を指定した場合は、デフォルトグループ直下のグループを取得します。
group_idとgroup_nameを同時に指定した場合は、group_idで指定したグループ直下のグループの内、group_nameにヒットしたグループを取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/groups?limit=***limit***&offset=***offset***&sort=***sort***&sort_order=***sort\_order***&tenant_id=***tenant\_id***&group_id=***group\_id***&group_name=***group\_name***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    limit integer 一覧表示するグループ数を指定する。 可 100 数値
    offset integer どの位置以降のグループを表示するかを指定する。 最初から表示する場合は0を指定する。 可 0 数値
    sort string グループ一覧をソートする際に、ソートのキーとするカラム名を指定する。 可 "entry_date" ・"group_name"：グループ名 ・"comment"：コメント ・"entry_date"：登録日時
    sort_order Integer グループ一覧をソートする際に、ソート順を指定する。 可 1 ・0：昇順 ・1：降順
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    group_id string 親グループIDを指定する。 可 ‐
    group_name string グループ名(部分一致のみ)を指定する。 可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK グループの取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    total_item integer 全グループ数
    items_per_page integer 取得したグループ数
    next_offset integer 続きの開始位置
    parent_group_id string 親グループID(要求時に省略した場合は、レスポンスも省略)
    group_list array グループ情報のリスト
    group_id string グループID
    group_name string グループ名
    comment string 任意のコメント
    entry_date string 登録日時(UTC、フォーマットは「YYYY-MM-DDTHH:mm:ss.lZ」)
    parent_group_id string 親グループID
    tenant_id string テナントID

  7. 変更履歴

    【リクエスト】

    GET /v1/groups HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 28

{
  "tenant_id" : "5caef1e101c2025400d5f2a3"
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 504

{
  "total_item": 348,
  "items_per_page": 100,
  "next_offset" : 101,
  "group_list" :[
  {
     "group_id": "0000000123",
     "group_name" : "GroupA",
     "comment" : "",
     "entry_date" : "2019-06-03 01:15:00",
     "parent_group_id" : "0000000100",
     "tenant_id" : "5caef1e101c2025400d5f2a3"
  },
  ・・・ group_list の数分続く
  ]
}

構成グループ構成情報収集契機取得

  1. 処理概要

    グループの構成情報収集契機を取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/groups/***group\_id***/configurations?tenant_id=***tenant\_id***

    group_id にはグループIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    conf_list array リスト
    function_name string 機能名
    config_name string グループ名
    conf array リスト
    priority integer 優先度
    InventoryTriggers array リスト
    TriggerType string 収集契機の種類
    TriggerRepeats string 収集契機の繰り返し
    TriggerDate string 収集契機の日付
    TriggerTime string 収集契機の時刻

  7. 変更履歴

    【リクエスト】

    GET /v1/groups/0000000123/configurations?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1056

{
  "conf_list":  [{
     "function_name" : "inventory_manager",
     "config_name" : "Test",
     "comment" : "",
     "conf" :  [
     {
       "priority" : "1",
       "InventoryTriggers" : [
       {
         "TriggerType" : "weekly",
         "TriggerRepeats" : "0101010",
         "TriggerDate" : "",
         "TriggerTime" : "21:00"
       },
       ・・・ InventoryTriggers 数分続く
       ]
     },
     ・・・ conf 数分続く
     ]
  }
　・・・ conf_list 数分続く
  ]
}

構成グループ削除

  1. 処理概要

    指定されたグループIDのグループを削除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/groups/***group\_id***

    group_id には削除するグループのIDを指定します。

  4. パラメータ

    リクエストのHTTPボディはありません。

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    204 No Content グループの削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    DELETE /v1/groups/0000000123 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 204 OK

構成情報登録・更新

  1. 処理概要

    指定されたエッジIDをもつ機器の構成情報を登録・更新します。複数指定可能です。
存在しないエッジIDを指定した場合は登録、存在するエッジIDを指定した場合は更新を行います。
グループID、グループパスの両方が指定された場合はグループIDを優先します。
一括登録の上限数は1000件とし、上限を超えたリクエストの場合は400を返却します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/inventories

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    edges array 登録・更新するエッジ機器のリスト。 不可 ‐ ‐
    edge_id string 登録・更新するエッジ機器のIDを指定する。 不可 ‐ ‐
    edge_name string エッジ機器のホスト名を指定する。 可 空白が指定されたものとする。 -
    group_list array エッジが所属するグループリスト。 可 ‐ ‐
    group_id string エッジが所属するグループIDを指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    group_name string エッジが所属するグループ名を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    message_connect_edge boolean エッジ接続時のメッセージ出力有無（true:有効、false:無効）を指定する。 可 "true"とする。 ・"true"：メッセージ出力有り ・"false"：メッセージ出力無し
    message_disconnect_edge boolean エッジ切断時のメッセージ出力有無（true:有効、false:無効）を指定する。 可 "true"とする。 ・"true"：メッセージ出力有り ・"false"：メッセージ出力無し
    description string エッジ機器の説明を指定する。 可 空白が指定されたものとする。 -
    administration_dept string エッジ機器の管理部門を指定する。 可 空白が指定されたものとする。 256文字以内の文字列
    chief_administrator string エッジ機器の管理責任者を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    location string エッジ機器の設置場所を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    user string エッジ使用者の名前を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    user_code string エッジ使用者の社員番号を指定する。 可 空白が指定されたものとする。 64文字以内の文字列
    user_email string エッジ使用者のメールアドレスを指定する。 可 空白が指定されたものとする。 512文字以内の文字列
    belonging_name string エッジ機器の所属を指定する。 可 空白が指定されたものとする。 256文字以内の文字列
    note1 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    note2 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    note3 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    node_red_key string MACアドレス(クライアント認証ありの場合のみ指定)を記述する。 可 空白が指定されたものとする。 クライアント認証ありの場合は必須
    tenant_id string テナントIDを記述する。 不可 ‐ ‐
    management_info_ext object 拡張管理項目がある場合、management_info_extに値を指定します。 可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/inventories/managementinfo HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024

{
 "edges":  [ {
    "edge_id" : "edge001",
    "edge_name" : "InfoEdge",
    "group_list":  [ {
        "group_id" : "0000000123",
        "group_name" : "GroupA" 
    } ],

    "description" : "" 
    "administration_dept" : "総務部",
    "chief_administrator" : "日電太郎",
    "location" : "広島開発センター",
    "user" : "日電太郎",
    "user_code" : "001-0001",
    "user_email" : "nichiden-tarou@user.co.jp",
    "belonging_name" : "開発部",
    "note1" : "2F 柱Aの隣",
    "note2" : "2017年10月廃棄予定",
    "note3" : "" 
    "node_red_key" : "44-8A-5B-17-36-D2",
    "management_info_ext": {
        "custom_value1": "s",
        "custom_value2": "1",
        "custom_value3": "2020-12-11 15:00:00",
        "custom_value4": "2020-12-12 01:10:10"
    }
  },
  {
    "edge_id" : "edge002",
    "edge_name" : "InfoEdge",
    "group_list":  [ {
        "group_id" : "0000000124",
        "group_name" : "GroupB" 
    } ],

    "description" : "" 
    "administration_dept" : "情報システム部",
    "chief_administrator" : "日電太郎",
    "location" : "青森市 店舗A",
    "user" : "日電花子",
    "user_code" : "020-0022",
    "user_email" : "nichiden-hanako@user.co.jp",
    "belonging_name" : "営業部", 
    "note1" : "1F 冷蔵庫裏", 
    "note2" : "店舗Bからの移管品", 
    "note3" : "" 
    "node_red_key" : "8B-85-4A-18-56-E1" 
  },
  ・・・ edges の数分続く
 ]
 "tenant_id" : "5caef1e101c2025400d5f2a3"
}

    【レスポンス】

    HTTP/1.1 200 OK

構成情報CSV登録・更新

  1. 処理概要

    CSVインポートによるエッジ機器の手動登録/更新を行います。複数指定可能です。
存在しないエッジIDを指定した場合は登録、存在するエッジIDを指定した場合は更新を行います。
グループID、グループパスの両方が指定された場合はグループIDを優先します。
一括登録の上限数は1000件とし、上限を超えたリクエストの場合は400を返却します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/import_jobs?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    importfile file エッジ機器の登録／更新情報用CSVデータを指定する。 不可 ‐ ‐
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    succeeded_results array エッジ情報登録/更新の成功結果のリスト
    edge_id string 登録/更新に成功したエッジID
    failed_results array エッジ情報登録/更新の失敗結果のリスト
    edge_id string 登録/更新に失敗したエッジID
    status_code integer HTTPステータスコード(400:不正リクエスト(パラメータ誤り)、500:サーバ側の内部エラー)
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    PUT /v1/import_jobs?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024
(ファイルの中身)

    【レスポンス】

    HTTP/1.1 200 OK

{
 "succeeded_results":  [ {
    "edge_id" : "edge001"
    } ]
 "failed_results":  [ {
    "edge_id" : "edge002",
    "status_code" : 500,
    "return_code" : 1
    } ]
}

構成情報json登録・更新

  1. 処理概要

    JSONインポートによるエッジ機器の手動登録/更新を行います。
存在しないエッジIDを指定した場合は登録、存在するエッジIDを指定した場合は登録している構成情報を削除し、指定したJSONの内容を登録します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/import_inventories?tenant_id=***tenant\_id&***edge_id=***edge\_id

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    importfile file エッジ機器の構成情報登録／更新情報用JSONデータを指定する。 不可 ‐ ‐
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    PUT /v1/import_inventories?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024
importfile:(ファイルの中身)

    【レスポンス】

    HTTP/1.1 200 OK

{
 "return_code": "0"
}

構成情報のエクスポート

  1. 処理概要

    エッジ機器の構成情報をファイルに出力します。
エクスポートする構成情報はマネージャ側にファイル出力し、本APIではURLの返却を行います。

  2. HTTPメソッド

    POST

  3. URL

    /v1/export_inventories?tenant_id=***tenant\_id&***type=***type

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    type string 出力ファイルタイプを指定する。(json:JSON形式) 不可 ‐ ‐
    array エッジIDのリスト。 不可 ‐ ‐
    edge_id string エッジIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)
    array エッジ情構成報ファイルダウンロードURLのリスト。
    url string エッジ情構成報ファイルダウンロードURL

  7. 変更履歴

    【リクエスト】

    POST /v1/export_inventories?tenant_id=5caef1e101c2025400d5f2a3&type=json HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 79

[
    {
        "edge_id": "edge001"
    },
    {
        "edge_id": "edge002"
    }
]

    【レスポンス】

    HTTP/1.1 200 OK

{
    "return_code": "0",
    [
        {
            "url": "http://10.30.20.1/5caef1e101c2025400d5f2a3/edge001.json"
        },
        {
            "url": "http://10.30.20.1/5caef1e101c2025400d5f2a3/edge002.json"
        }
    ]
}

    以下は curl コマンドでの実行例です。

    # curl -X POST http://127.0.0.1:22527/v1/export_inventories?tenant_id=5caef1e101c2025400d5f2a3\&type=json -d '[{"edge_id":"edge001"}]'
[{"url":"http:\/\/192.168.1.1\/5caef1e101c2025400d5f2a3\/edge001.json"}]

構成情報条件検索

  1. 処理概要

    指定された条件に一致するエッジ/デバイスをデータベースから検索し、条件にヒットしたエッジ/デバイスの一覧を取得します。
条件は複数指定可能で、複数指定した場合はリクエストに応じてAND又はOR検索ができます、ORが複数ある場合ANDが優先されて検索されます。
ヒットしたエッジ/デバイスの詳細な構成情報を取得するには、本APIのレスポンスで返却されたエッジID/デバイスIDを使用して、構成情報詳細表示APIを実行してください。

  2. HTTPメソッド

    POST

  3. URL

    /v1/inventories

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    limit integer 一覧表示するエッジ/デバイスの数を指定する。 「-1」が指定された場合は、検索条件にヒットする全レコードを返却する。 可 10とする。 数値
    offset integer sort_table, sort_column, sort_orderでソートしたエッジ/デバイス一覧のどの位置以降のエッジ/デバイスを表示するかを指定する。最初から表示する場合は0を指定する。 可 0とする。 数値
    sort_table string 検索結果のエッジ/デバイス一覧をソートする際に、ソートのキーとするカラムが属するテーブル名を指定する。 可 エッジ機器の場合は、"ComputerInfo"とする。
    デバイスの場合は、"DeviceProfile"とする。    		 【target_typeが"edge"の場合】
    ・ComputerInfo：コンピュータ情報テーブル
    ・OSInfo：OS情報テーブル
    ・検索条件または表示項目で指定したテーブル(conditions ‐ table に指定したテーブル)
    【target_typeが"device"の場合】
    ・DeviceProfile：デバイスプロファイル情報テーブル
    ・検索条件または表示項目で指定したテーブル(conditions ‐ table に指定したテーブル)
    sort_column string 検索結果のエッジ/デバイス一覧をソートする際に、ソートのキーとするカラム名を指定する。 可 "MachineID"とする。 【target_typeが"edge"の場合】
    ・MachineID：エッジID
    ・ElementName：対象機器のホスト名
    ・Model：対象機器のモデル番号
    ・Caption：対象機器のOS種別
    ・CollectTime：対象機器の構成情報収集日時
    ・検索条件または表示項目で指定したカラム(conditions ‐ column に指定したカラム)
    【target_typeが"device"の場合】
    ・MachineID：デバイスID
    ・検索条件または表示項目で指定したカラム(conditions ‐ column に指定したカラム)
    sort_order string 検索結果のエッジ/デバイス一覧をソートする際に、ソート順を指定する。 可 "ASC"とする。 ・"ASC"：昇順 ・"DESC"：降順
    target_type string 検索対象となる機器の種別を指定する。 可 "edge"とする。 ・"edge"：エッジ指定 ・"device"：デバイス指定
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    conditions array 検索条件のリスト。 不可 ‐ ‐
    table string エッジ/デバイスを検索する条件となる構成情報のテーブル名を指定する。 不可 ‐ 指定可能なテーブル名は「収集項目一覧」を参照。
    column string エッジ/デバイスを検索する条件となる構成情報のカラム名を指定する。 不可 ‐ 指定可能なカラム名は「収集項目一覧」を参照。
    operator string エッジ/デバイスを検索する条件となる比較演算子を指定する。 不可 ‐ ・"include"：～を含む
    ・"not include"：～を含まない
    ・"equal"：～と等しい
    ・"not equal"：～と等しくない
    ・"between"：～と～の間に含まれる
    ・"begin"：～で始まる
    ・"end"：～で終わる
    ・"or more"：～以上
    ・"or less"：～以下
    ・"over"：～より大きい
    ・"under"：～より小さい
    ・"and"：且つ
    ・"or"：または
    value1 string 比較演算子とともにエッジ/デバイスを検索する条件となる値を指定する。 不可 ‐ 4,000文字以内の文字列
    value2 string 比較演算子とともにエッジ/デバイスを検索する条件となる値を指定する。(operator が between の場合に有効) 可 ‐ 4,000文字以内の文字列
    display_colums array 表示項目のリスト。 可 ‐ ‐
    table string エッジ/デバイスを検索する条件となる構成情報のテーブル名を指定する。 不可 ‐ 指定可能なテーブル名は「収集項目一覧」を参照。
    column string エッジ/デバイスを表示する構成情報のカラム名を指定する。 不可 ‐ 指定可能なカラム名は「収集項目一覧」を参照。

    ※operator(比較演算子)で指定された値に応じた検索内容

    条件 operator value1 value2 検索内容
    ～を含む "include" A 指定しない 「A」を含む文字列を検索
    ～を含まない "not include" A 指定しない 「A」を含まない文字列を検索
    ～と等しい "equal" A 指定しない 「A」と等しい文字列、数値、日時を検索
    ～と等しくない "not equal" A 指定しない 「A」と等しくない文字列、数値、日時を検索
    ～と～の間に含まれる "between" A B 「A」から「B」の範囲に含まれる数値、日時を検索
    ～で始まる "begin" A 指定しない 「A」で始まる文字列を検索
    ～で終わる "end" A 指定しない 「A」で終わる文字列を検索
    ～以上 "or more" A 指定しない 「A」以上の数値を検索
    ～以下 "or less" A 指定しない 「A」以下の数値を検索
    ～より大きい "over" A 指定しない 「A」より大きい数値をを検索
    ～より小きい "under" A 指定しない 「A」より小さい数値を検索
    且つ "and" 指定しない 指定しない 複数条件がありAND条件で検索する場合していする
    または "or" 指定しない 指定しない 複数条件がありOR条件で検索する場合していする

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 構成情報の検索が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    total_result integer 指定した検索条件にヒットしたエッジ/デバイス数
    items_per_page integer 指定した検索条件にヒットしたエッジ/デバイスの中から、本レスポンスで返却するエッジ/デバイス数
    limit integer 取得する情報数(リクエストで指定した値を返却)
    offset integer リクエストで指定した値に取得した情報数を加算した値
    sort_table string ソートキーのカラムが属するテーブル名(リクエストで指定した値を返却)
    sort_column string ソートキーとするカラム名(リクエストで指定した値を返却)
    sort_order string ソート順(リクエストで指定した値を返却)
    results array 検索条件にヒットしたエッジ/デバイスのリスト
    id string 検索条件にヒットした対象機器のID(エッジIDまたはデバイスID)
    hostname string 検索条件にヒットした対象機器のホスト名(機器種別がedgeの場合のみ)
    group_list array 検索条件にヒットした対象機器が所属するグループのリスト
    group_name string 検索条件にヒットした対象機器が所属するグループ名
    status integer 検索条件にヒットした対象機器の接続状態(0:未接続, 1:接続, 3:切断)
    dist_status string 検索条件にヒットした対象機器の配布状態(直近の配布ステータス ready/running/complete/error/なし)
    dist_package_name string 検索条件にヒットした対象機器の直近配布した配布パッケージ名(配布なしの場合は空)
    description string 検索条件にヒットした対象機器のGET配布時に設定したコメント
    type string 検索条件にヒットした対象機器の種別(エッジ:edge、デバイス:device)
    parent_id string 検索条件にヒットした対象機器の親エージェントID(機器種別がdeviceの場合のみ)
    model string 検索条件にヒットした対象機器のモデル番号(機器種別がedgeの場合のみ)
    os string 検索条件にヒットした対象機器のOS(機器種別がedgeの場合のみ)
    collectdate string 検索条件にヒットした対象機器の構成情報収集日時(機器種別がedgeの場合のみ)
    last_connect_date string 検索条件にヒットした対象機器の最終接続日時(機器種別がedgeの場合のみ)
    node_red_user string 検索条件にヒットした対象機器のNode-REDフロー配信にリクエストを出す際のエッジID(クライアント認証なし：<エッジID>@edm.nec.com, クライアント認証あり：MACアドレス)
    agent_type string 検索条件にヒットした対象機器のエージェント種別(edge:エージェント, probe:プローブ収集)
    probe integer 検索条件にヒットした対象機器のプローブの有効/無効(機器種別がedgeの場合のみ)
    elements array 検索結果の値リスト
    table string 検索条件で指定したテーブル名
    column string 検索条件で指定したカラム名
    value string ヒットした値 (該当カラムに登録されている値)

  7. 変更履歴

    【リクエスト】

    POST /v1/inventories HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 358

{
  "limit" : 100,
  "offset" : 0,
  "sort_table" : "ComputerInfo",
  "sort_column" : "ElementName",
  "sort_order" : "ASC",
  "item_type" : "edge",
  "tenant_id" : "5caef1e101c2025400d5f2a3",
  "conditions" : [{
    "table" : "CPUInfo",
    "column" : "NumberOfCores",
    "operator" : "equal",
    "value1" : "2",
    "value2" : ""
  },
  {
    "table" : "or"
  },
  {
    "table" : "ComputerInfo",
    "column" : "MachineID",
    "operator" : "equal",
    "value1" : "edgegw0001",
    "value2" : ""
  }],
  "display_columns" : [{
    "table" : "ComputerInfo",
    "column" : "Domain"
  }]
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1024

{
  "total_result": 348,
  "items_per_page": 100,
  "limit" : 100,
  "offset" : 101,
  "sort_table" :"ComputerInfo",
  "sort_column" :"ElementName",
  "sort_order" : "ASC",
  "results" :[
  {
     "id": "edgegw0001",
     "hostname" : "Edge001",
     "group_list" :[{
          "group_name" : "GroupA"
     }]
     "status" : 1,
     "dist_status" : "complete",
     "dist_package_name" : "pack01",
     "description" : "comment01",
     "type" : "edge",
     "model" : "MJ36H",
     "os" : "debian",
     "collectdate" : "2016-11-01 10:59:18",
     "last_connect_date" : "2016-11-01 11:00:21",
     "node_red_user" : "edgegw0001@edm.nec.com",
     "agent_type" : "edge",
     "probe" : "1",
     "elements" :[{
          "table" :  "CPUInfo",
          "column" :  "NumberOfCores",
          "value" :  "2"
     }]
  },
  ・・・ results の数分続く
  ]
}

構成情報詳細表示

  1. 処理概要

    指定されたエッジID/デバイスIDをもつ機器の構成情報を表示します。

  2. HTTPメソッド

    POST

  3. URL

    /v1/inventories/***target\_id***

    target_id には構成情報を表示するエッジまたはデバイスのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    target_type string 構成情報を表示する機器の種別を指定する。 可 "edge"とする。 ・"edge"：エッジ指定 ・"device"：デバイス指定
    include_device string target_typeが"edge"の場合、エッジ機器の構成情報に加えて、エッジに紐付くデバイスの構成情報も表示するかどうかを指定する。 可 "no"とする。 ・"no"：エッジに紐付くデバイスの構成情報は表示しない
    ・"yes"：エッジに紐付くデバイスの構成情報を表示する

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 構成情報の詳細表示が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 指定したIDの構成情報が存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    results array 指定されたエッジ/デバイスの構成情報のリスト
    id string 対象機器のID(リクエストで指定した値を返却)
    type string 対象機器の種別(リクエストで指定した値を返却)
    tables array 構成情報テーブルのリスト
    tablename string 構成情報テーブル名 表示されるテーブル名は「構成情報テーブル・カラム一覧」を参照。
    records array tablenameに登録されているレコードのリスト
    columns array 各recordsのカラムのリスト
    columnname string 構成情報カラム名 表示されるカラム名は「構成情報テーブル・カラム一覧」を参照。
    value string 該当カラムに登録されている値
    default_group array デフォルトグループ
    group_id string デフォルトグループID(「0000000000」固定)
    group_name string デフォルトグループ名

  7. 変更履歴

    【リクエスト】

    POST /v1/inventories/edgegw0001 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 25

{
  "target_type" : "edge",
  "include_device" : "no"
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1024

{
  "results":  [{
     "id" : "edgegw0001" ,
     "type" : "edge" ,
     "tables" :  [
     {
       "tablename" :  "Computerinfo",
       "records" :  [
       {
         "columns" :  [
         {
           "columnname" : "MachineID",
           "value" : "edgegw0001"
         },
         {
           "columnname" : "Elementname",
           "value" : "Edge001"
         },
         ・・・ ComputerInfo のカラム数分続く
       }
       ]  
     },
     {
       "tablename" :  "CPUInfo",
       "records" :  [
       {
         "columns" :  [
         {
           "columnname" : "MachineID",
           "value" : "edgegw0001"
         },
         {
           "columnname" : "Name",
           "value" : "Pentium III (Coppermine)"
         },
         ・・・ CPUInfo のカラム数分続く
       },
       ・・・ CPUInfo のレコード数分続く
       ]  
     },
     ・・・ 構成情報テーブル数分続く
     "default_group" :
     {
       "group_id" :  "0000000000",
       "group_name" : "GroupA"
     }
  }]
}

構成情報削除

  1. 処理概要

    指定されたエッジID/デバイスIDをもつ機器の構成情報を削除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/inventories/***target\_id***

    target_id には構成情報を削除するエッジまたはデバイスのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    target_type string 構成情報を削除する機器の種別を指定する。 可 "edge"とする。 ・"edge"：エッジ指定 ・"device"：デバイス指定
    include_device string target_typeが"edge"の場合、エッジ機器の構成情報に加えて、エッジに紐付くデバイスの構成情報も削除するかどうかを指定する。 可 "no"とする。 ・"no"：エッジに紐付くデバイスの構成情報は削除しない ・"yes"：エッジに紐付くデバイスの構成情報を削除する

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 構成情報の削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 指定したIDの構成情報が存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    DELETE /v1/inventories/edgegw0001 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 25

{
  "target_type" : "edge",
  "include_device" : "no"
}

    【レスポンス】

    HTTP/1.1 200 OK

構成情報一括削除

  1. 処理概要

    指定された複数のエッジIDまたはデバイスIDの構成情報を一括で削除します。
1件でも削除に成功するとステータスコードは200を返却するため、エッジIDまたはデバイスID毎に削除結果を確認したい場合は構成情報削除APIを実行してください。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/inventories

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    include_device string target_typeが"edge"の場合、エッジ機器の構成情報に加えて、エッジに紐付くデバイスの構成情報も削除するかどうかを指定する。 可 "no"とする。 ・"no"：エッジに紐付くデバイスの構成情報は削除しない ・"yes"：エッジに紐付くデバイスの構成情報を削除する
    targets array 削除対象機器のリスト。 不可 ‐ ‐
    target_id string 構成情報を削除するエッジまたはデバイスのIDを指定する。 不可 ‐ ・エッジID ・デバイスID
    target_type string 構成情報を削除する機器の種別を指定する。 不可 ‐ ・"edge"：エッジ指定 ・"device"：デバイス指定

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 構成情報の一括削除が成功(1件でも削除できれば成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    DELETE /v1/inventories/ HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 48

{
  "include_device" : "no",
  "targets" :[ 
  {
     "target_id" : "edgegw0001" ,
     "target_type" :  "edge"
  },
  {
     "target_id" : "device0001" ,
     "target_type" :  "device"
  }
  ] 
}

    【レスポンス】

    HTTP/1.1 200 OK

プロファイル情報登録・更新

  1. 処理概要

    データベースに登録されているエッジ/デバイスのプロファイル情報を最新化します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/inventories/***target\_id***

    target_id にはプロファイル情報を最新化するエッジ機器のIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    target_type string 情報を最新化するプロファイルの種別を指定する。 可 "edge"とする。 ・"edge"：エッジ機器のアプリケーションプロファイル情報を最新化する ・"device"：デバイスのデバイスプロファイル情報とデバイスアダプタプロファイル情報を最新化する

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK プロファイル情報の最新化が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 指定したIDのエッジが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/inventories/edgegw0001 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 25

{
  "target_type" : "edge"
}

    【レスポンス】

    HTTP/1.1 200 OK

管理情報登録・更新

  1. 処理概要

    指定されたエッジIDをもつ機器の管理情報(メタ情報)を登録・更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/inventories/managementinfo

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    managementinfoes array 更新する管理情報のリスト。 可 管理情報の更新は行われない。 ‐
    machineid string 管理情報を登録・更新するエッジ機器のIDを指定する。 可 administrationdept～note3に指定した値は無視される。 ‐
    administrationdept string エッジを管理する部門名を指定する。 可 空白が指定されたものとする。 256文字以内の文字列
    chiefadministrator string エッジ機器の管理責任者名を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    location string エッジ機器の設置場所を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    user string エッジ機器の使用者名を指定する。 可 空白が指定されたものとする。 128文字以内の文字列
    usercode string エッジ使用者の社員番号を指定する。 可 空白が指定されたものとする。 64文字以内の文字列
    useremail string エッジ使用者のメールアドレスを指定する。 可 空白が指定されたものとする。 512文字以内の文字列
    belongingname string エッジ使用者の所属を指定する。 可 空白が指定されたものとする。 256文字以内の文字列
    note1 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    note2 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    note3 string 固定項目以外で管理すべき情報を指定する。 可 空白が指定されたものとする。 4,000文字以内の文字列
    description string 説明を記述する。 可 空白が指定されたものとする。 4,000文字以内の文字列

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/inventories/managementinfo HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024

{
 "managementinfoes":  [ {
    "machineid" : "edgegw0001",
    "administrationdept" : "総務部",
    "chiefadministrator" : "日電太郎",
    "location" : "広島開発センター",
    "user" : "日電太郎",
    "usercode" : "001-0001",
    "useremail" : "nichiden-tarou@user.co.jp",
    "belongingname" : "開発部",
    "note1" : "2F 柱Aの隣",
    "note2" : "2017年10月廃棄予定",
    "note3" : "" 
    "description" : "" 
  },
  {
    "machineid" : "edgegw0002",
    "administrationdept" : "情報システム部",
    "chiefadministrator" : "日電太郎",
    "location" : "青森市 店舗A",
    "user" : "日電花子",
    "usercode" : "020-0022",
    "useremail" : "nichiden-hanako@user.co.jp",
    "belongingname" : "営業部", 
    "note1" : "1F 冷蔵庫裏", 
    "note2" : "店舗Bからの移管品", 
    "note3" : "" 
    "description" : "" 
  },
  ・・・ 管理情報のレコード数分続く
 ]
}

    【レスポンス】

    HTTP/1.1 200 OK

接続状態更新

  1. 処理概要

    指定されたエージェントIDをもつ機器の接続状態を即時更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/inventories/***target\_id***/status

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    timeout integer 切断と判断するまでのタイムアウト時間を指定する。 可 60とする。 10～300秒

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 接続状態の更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 指定したIDのエージェントが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/inventories/12345/status HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 24

{
  "timeout" : "10"
}

    【レスポンス】

    HTTP/1.1 200 OK

構成情報一括削除

  1. 処理概要

    指定されたエージェントIDをもつ機器の構成情報を一括削除します。

  2. HTTPメソッド

    POST

  3. URL

    /v1/edges/delete

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    include_device string 登録・更新情報用CSVデータを指定する。 可 "no"とする。 ・"yes"：削除する ・"no"：削除しない
    targets array 一括削除対象情報のリスト。 不可 ‐ ‐
    target_id string 削除するエージェントIDを指定する。 不可 ‐ ‐
    target_type string 削除するエージェントの機器種別を指定する。 可 "edge"とする。 ・"edge"：エッジ ・"device"：デバイス

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 管理情報の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    succeeded_results array 削除の成功結果のリスト
    target_id string 削除に成功した機器のID
    target_type array 削除に成功した機器の種別(エッジ:edge、デバイス:device) ※EDM v2.0ではedgeのみ
    failed_results string 削除の失敗結果のリスト
    target_id string 削除に失敗したエッジID
    target_type array 削除に失敗した機器の種別(エッジ:edge、デバイス:device) ※EDM v2.0ではedgeのみ
    status_code integer HTTPステータスコード(400:不正リクエスト(パラメータ誤り)、500:サーバ側の内部エラー)
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    PUT /v1/import_jobs HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024

{
 "include_device" : "yes"
 "targets":  [
    {
    "target_id" : "edgegw0001",
    "target_type" : "edge"
    },
    {
    "target_id" : "edgegw0002",
    "target_type" : "edge"
    }
 ]
}

    【レスポンス】

    HTTP/1.1 200 OK

{
 "succeeded_results":  [ {
    "target_id" : "edgegw0001",
    "target_type" : "edge"
    } ]
 "failed_results":  [ {
    "target_id" : ""edgegw0002"",
    "target_type" : "edge",
    "status_code" : "500",
    "return_code" : "1"
    } ]
}

設定情報更新

  1. 処理概要

    テナント単位の設定情報を更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/options/***apply\_id***

    apply_id には更新する適用先IDを指定します(EDM v2.0ではテナントIDのみ)。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    option_list array 設定情報のリストを指定する。 不可 ‐ ‐
    check_pre_regist_edge integer エッジ機器の事前登録の要不要を指定する。 可 0とする ・0：不要 ・1：必要
    notify_interval integer エッジ機器の定期通知間隔(秒)を指定する。 可 3600とする。 ‐
    health_check_suspend Integer エッジ機器の死活監視の切断検出猶予時間(秒)を指定する。 可 60とする。 ‐
    dist_check_notify_progress integer エッジ機器の配布実行中の進捗状況を通知するかどうかを指定する。 可 0とする。 ・0：通知する ・1：通知しない
    dist_check_exec_task integer エッジ機器の配布タスクの二重実行チェックを実施するかどうかを指定する。 可 0とする。 ・0：実施する ・1：実施しない

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK 更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/options/0000000123 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 285

{
  "option_list" :[
  {
     "check_pre_regist_edge": 0,
     "notify_interval" : 3600,
     "health_check_suspend" : 60,
     "dist_check_notify_progress" : 0,
     "dist_check_exec_task" : 0
  },
  ・・・ option_list の数分続く
  ]
}

    【レスポンス】

    HTTP/1.1 200 OK

設定情報取得

  1. 処理概要

    テナント単位の設定情報を取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/options/***apply\_id***

    apply_id には取得する適用先IDを指定します(EDM v2.0ではテナントIDのみ)。

  4. パラメータ

    リクエストのHTTPボディはありません。

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    204 No Content グループの削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    404 Not Found 該当のグループが存在しない。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    option_list array 設定情報のリスト
    check_pre_regist_edge integer 検索条件にヒットしたエッジ機器の事前登録の要不要(0：不要, 1：必要)
    notify_interval integer 検索条件にヒットしたエッジ機器の定期通知間隔(秒)
    health_check_suspend integer 検索条件にヒットしたエッジ機器の死活監視の切断検出猶予時間(秒)
    dist_check_notify_progress integer 検索条件にヒットしたエッジ機器の配布実行中の進捗状況を通知するかどうか(0：通知する, 1：通知しない)
    dist_check_exec_task integer 検索条件にヒットしたエッジ機器の配布タスクの二重実行チェックを実施するかどうか(0：実施する, 1：実施しない)

  7. 変更履歴

    【リクエスト】

    GET /v1/options/5cee350813d54c1e1be64f56 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1024

{
  "option_list" :[
  {
     "check_pre_regist_edge": 0,
     "notify_interval" : 30,
     "health_check_suspend" : 60,
     "dist_check_notify_progress" : 0,
     "dist_check_exec_task" : 0
  },
  ・・・ option_list の数分続く
  ]
}

構成サマリ情報取得

  1. 処理概要

    エッジ機器のサマリ情報を取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/summaries/edges?tenant_id=***tenant\_id***
    クエリパラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string サマリ情報を取得したいテナントIDを指定する。 不可 ‐ ‐

  4. パラメータ

    リクエストのHTTPボディはありません。

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK サマリ情報の取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    total_item integer 検索条件にヒットした全エッジ数
    status_list array エッジサマリ情報のリスト
    status integer 検索条件にヒットしたエッジ機器のステータス(0:未接続, 1:接続, 3:切断, 88:プローブ収集)
    count integer 検索条件にヒットしたステータスに対応するエッジ数

  7. 変更履歴

    【リクエスト】

    GET /v1/summaries/edges?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1024

{
  "total_item": 34,
  "status_list": [{
    "status": 0,
    "count": 3
    },
    ・・・status_list の数分続く
 ]
}

CAPサーバ取得

  1. 処理概要

    CAPサーバを取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/cooperation/hosts?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK CAPサーバの取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    host_mode string CAPサーバー構成。(0:複数サーバ構成、1:シングルサーバ構成)
    host_list array CAPサーバのリスト。
    host_name string CAPサーバのホスト名。
    authentication integer CAPサーバのエッジ認証方式。(0:ID/PW認証、1:クライアント認証)

  7. 変更履歴

    【リクエスト】

    GET /v1/cooperation/hosts?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 504

{
    "host_mode": "0",
    "host_list" : [
        {
        "authentication" : 0,
        "host_name" : "127.0.0.1"
        }
        ・・・ CAPサーバ の数分続く
    ]
}

カスタム構成情報定義登録

  1. 処理概要

    カスタム構成情報の定義を登録します。

  2. HTTPメソッド

    POST

  3. URL

    /v1/custom_confs?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    name string クラス名を指定する。RWManagementInfoExtを指定すると拡張管理項目になります。 不可 ‐ クラス名はテナント配下で重複不可
    display_name string クラスの表示名を指定する。 不可 ‐ ‐
    class_type integer クラスのタイプを指定する。(key-value型:0、配列型:1) 不可 ‐ ‐
    menu_index integer サイドメニューの表示順序を指定する。 不可 ‐ ‐
    properties array カスタム構成情報プロパティのリスト 不可 ‐ ‐
    member_name string プロパティ名を指定する。 不可 ‐ プロパティ名はプロパティ配下で重複不可
    member_type integer プロパティの型を指定する。(文字列:0、数値:1、日付(unixtime):2、日時(unixtime):3) 不可 ‐ ‐
    display_name string プロパティの表示名を指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK カスタム構成情報定義の登録が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    POST /v1/custom_confs?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 602

{
    "class_type" : 0,
    "display_name" : "\u62E1\u5F35\u7BA1\u7406\u60C5\u5831",
    "menu_index" : 0,
    "name" : "RWManagementInfoExt",
    "properties" : [
    {
        "display_name" : "\u5099\u8003",
        "member_name" : "biko_str",
        "member_type" : 0
    },
    {
        "display_name" : "\u6570\u5024",
        "member_name" : "biko_num",
        "member_type" : 1
    },
    {
        "display_name" : "\u65E5\u4ED8",
        "member_name" : "biko_date",
        "member_type" : 2
    },
    {
        "display_name" : "\u65E5\u6642",
        "member_name" : "biko_time",
        "member_type" : 3
    }
    ]
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 28

{
  "return_code": "0"
}

カスタム構成情報定義取得

  1. 処理概要

    カスタム構成情報の定義を取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/custom_confs?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK カスタム構成情報定義の取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    array カスタム構成情報定義のリスト
    name string クラス名。
    display_name string クラスの表示名。
    class_type integer クラスのタイプ。(key-value型:0、配列型:1)
    menu_index integer サイドメニューの表示順序。
    properties array カスタム構成情報プロパティのリスト
    member_name string プロパティ名。
    member_type integer プロパティの型。(文字列:0、数値:1、日付(unixtime):2、日時(unixtime):3)
    display_name string プロパティの表示名。

  7. 変更履歴

    【リクエスト】

    GET /v1/custom_confs?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 504

[
    {
        "class_type" : 0,
        "display_name" : "\u62E1\u5F35\u7BA1\u7406\u60C5\u5831",
        "menu_index" : 0,
        "name" : "RWManagementInfoExt",
        "properties" : [
        {
            "display_name" : "\u5099\u8003",
            "member_name" : "biko_str",
            "member_type" : 0
        },
        {
            "display_name" : "\u6570\u5024",
            "member_name" : "biko_num",
            "member_type" : 1
        },
        {
            "display_name" : "\u65E5\u4ED8",
            "member_name" : "biko_date",
            "member_type" : 2
        },
        {
            "display_name" : "\u65E5\u6642",
            "member_name" : "biko_time",
            "member_type" : 3
        }
        ]
    },
    ・・・ カスタム構成情報定義 の数分続く
]

カスタム構成情報定義削除

  1. 処理概要

    指定されたクラス名のカスタム構成情報定義を削除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/custom_confs?tenant_id=***tenant\_id***&class_name=***class\_name***

    class_name には削除するカスタム構成情報定義のクラス名を指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    class_name string クラス名を指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK カスタム構成情報定義の削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    DELETE /v1/custom_confs?tenant_id=5caef1e101c2025400d5f2a3&class_name=className HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK

プローブ収集定義登録・更新

  1. 処理概要

    プローブ収集の定義を登録・更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/probe/configuration/***edge\_id***?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    edge_id string エッジIDを指定する。 不可 ‐ ‐
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    configurations array プローブ収集定義のリスト 可 ‐ ‐
    id string 更新時にマネージャーから返却された値を指定する。 可 ‐ ‐
    enable string 有効/無効。"on"(有効)、"off"(無効)を指定する。 可 on ‐
    auto_discovery string 自動発見。"on"(有効)、"off"(無効)を指定する。 可 on ‐
    probe_triggers array 収集契機情報のリスト。 不可 ‐ ‐
    trigger_type string 収集契機の種類を指定する。 不可 ‐ ・"daily"：毎日
    ・"weekly"：毎週
    ・"monthly"：毎月
    trigger_repeats string 収集契機の繰り返しを指定する。 可 ‐ 【trigger_typeが"daily"、"monthly"の場合】
    ・""(値なし)
    【trigger_typeが"weekly"の場合】
    ・曜日に対し契機あり/なしを0/1の数値で指定
    　月、水、金が契機として指定されている場合は"0101010"
    trigger_date string 収集契機の日付を指定する。 可 ‐ 【trigger_typeが"daily"、"weekly"の場合】
    ・""(値なし)
    【 trigger_typeが"monthly"の場合】
    ・指定する日
    trigger_time string 収集契機の時刻を指定する。 不可 ‐ ・指定する時刻("00:00"の形式)(24時間表記)
    targets array 収集対象情報のリスト。 不可 ‐ ‐
    id string 更新時にマネージャーから返却された値を指定する。 可 ‐ ‐
    type string 収集対象の種類を指定する。"ip_address"(IPアドレスの範囲指定)、"subnet_mask"(マスク指定)、"host_name"(ホスト名指定)。 不可 ‐ ‐
    ip_address_from string IPアドレスの範囲指定の場合、IPアドレス開始を指定する。 可 ‐ ‐
    ip_address_to string IPアドレスの範囲指定の場合、IPアドレス終了を指定する。 可 ‐ ‐
    ip_address string マスク指定の場合、ネットワークアドレスを指定する。 可 ‐ ‐
    address_prefix string マスク指定の場合、プレフィックスを指定する。 可 ‐ ‐
    host_name string ホスト名指定の場合、ホスト名を指定する。 可 ‐ ‐
    protocol_config object プロトコル情報。 不可 ‐ ‐
    protocol_type string プロトコルの種類を指定する。"WMI"、"SSH/SCP"、"Custom"。 不可 ‐ ‐
    auth string プロトコルの種類が"SSH/SCP"の場合、認証方式を指定する。"password"(パスワード認証)、"public_key"(公開鍵認証)。 可 ‐ ‐
    user string プロトコルの種類が"WMI"、"SSH/SCP"の場合、ユーザ名を指定する。 可 ‐ ‐
    oldpass string プロトコルの種類が"WMI"、"SSH/SCP"の場合、旧パスワード/パスフレーズ指定する。 旧パスワード/パスフレーズは更新時のみ指定する。 可 ‐ ‐
    pass string プロトコルの種類が"WMI"、"SSH/SCP"の場合、パスワード/パスフレーズ指定する。更新時にパスワード/パスフレーズを変更しない場合指定しない。 ただし、プロトコルの種類、認証方式を変更した場合、パスワード/パスフレーズを変更しない場合も指定する。 可 ‐ ‐
    port string プロトコルの種類が"SSH/SCP"の場合、ポートを指定する。 可 22 ‐
    keyfile string プロトコルの種類が"SSH/SCP"かつ認証方式がpublic_keyの場合、秘密鍵ファイルパスを指定する。 可 ‐ ‐
    command_line string プロトコルの種類が"Custom"の場合、起動するプログラムのパスを指定する。 可 ‐ ‐
    command_option string プロトコルの種類が"Custom"の場合、起動オプションを指定する。 可 ‐ ‐
    command_workdir string プロトコルの種類が"Custom"の場合、作業フォルダを指定する。 可 ‐ ‐
    exceptions array 収集対象外情報のリスト。 可 ‐ ‐
    id string 更新時にマネージャーから返却された値を指定する。 可 ‐ ‐
    type string 収集対象の種類を指定する。"ip_address"(IPアドレスの範囲指定)、"subnet_mask"(マスク指定)、"host_name"(ホスト名指定)。 不可 ‐ ‐
    ip_address_from string IPアドレスの範囲指定の場合、IPアドレス開始を指定する。 可 ‐ ‐
    ip_address_to string IPアドレスの範囲指定の場合、IPアドレス終了を指定する。 可 ‐ ‐
    ip_address string マスク指定の場合、ネットワークアドレスを指定する。 可 ‐ ‐
    address_prefix string マスク指定の場合、プレフィックスを指定する。 可 ‐ ‐
    host_name string ホスト名指定の場合、ホスト名を指定する。 可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK プローブ収集定義の登録・更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    PUT /v1/probe/configuration/edge001?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 2909

{
    "configurations": [
        {
            "id": "d2893136-c92a-4c4b-9531-650d416b54b4",
            "config_name": "config name",
            "enable": "on",
            "auto_discovery": "on",
            "probe_triggers": [
                {
                    "trigger_type": "weekly",
                    "trigger_time": "13:30",
                    "trigger_repeats": "0101010"
                }
            ],
            "targets": [
                {
                    "id": "4c99fcbd-28b8-438b-b20c-7e0e0b2e1414",
                    "type": "subnet_mask",
                    "protocol_config": {
                        "protocol_type": "Custom",
                        "command_line": "sh test.sh",
                        "command_option": "-h",
                        "command_workdir": ""
                    },
                    "ip_address": "192.168.111.0",
                    "address_prefix": "24"
                },
                {
                    "id": "e785fa40-c729-42b4-ac75-58d549bda05e",
                    "type": "ip_address",
                    "protocol_config": {
                        "protocol_type": "SSH/SCP",
                        "auth": "password",
                        "user": "Eileen.Lubowitz",
                        "port": 22
                    },
                    "ip_address_from": "192.168.111.100",
                    "ip_address_to": "192.168.111.110"
                }
            ],
            "exceptions": [
                {
                    "type": "subnet_mask",
                    "protocol_config": {
                        "protocol_type": "Custom",
                        "command_line": "start.sh"
                    },
                    "ip_address": "192.168.111.0",
                    "address_prefix": "24"
                }
            ],
            "tenant_id": "5a6a8dd635342331c0f5f06e",
            "edge_id": "N8498-84AEEAE111"
        }
    ]
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 0

プローブ収集定義取得

  1. 処理概要

    プローブ収集の定義を取得します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/probe/configuration/***edge\_id***?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    edge_id string エッジIDを指定する。 不可 ‐ ‐
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK プローブ収集定義の取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    configurations array プローブ収集定義のリスト
    id string プローブ収集定義のID。
    enable string 有効/無効。
    probe_triggers array 収集契機情報のリスト。
    trigger_type string 収集契機の種類。
    trigger_repeats string 収集契機の繰り返し。
    trigger_date string 収集契機の日付。
    trigger_time string 収集契機の時刻。
    targets array 収集対象情報のリスト。
    id string 収集対象のID。
    type string 収集対象の種類。"ip_address"(IPアドレスの範囲指定)、"subnet_mask"(マスク指定)、"host_name"(ホスト名指定)。
    ip_address_from string IPアドレスの範囲指定の場合、IPアドレス開始。
    ip_address_to string IPアドレスの範囲指定の場合、IPアドレス終了。
    ip_address string マスク指定の場合、ネットワークアドレス。
    address_prefix string マスク指定の場合、プレフィックス。
    host_name string ホスト名指定の場合、ホスト名。
    protocol_config object プロトコル情報。
    protocol_type string プロトコルの種類。"WMI"、"SSH/SCP"、"Custom"。
    auth string プロトコルの種類が"SSH/SCP"の場合、認証方式。"password"(パスワード認証)、"public_key"(公開鍵認証)。
    user string プロトコルの種類が"WMI"、"SSH/SCP"の場合、ユーザ名。
    port string プロトコルの種類が"SSH/SCP"の場合、ポート。
    keyfile string プロトコルの種類が"SSH/SCP"かつ認証方式がpublic_keyの場合、秘密鍵ファイルパス。
    command_line string プロトコルの種類が"Custom"の場合、起動するプログラムのパス。
    command_option string プロトコルの種類が"Custom"の場合、起動オプション。
    command_workdir string プロトコルの種類が"Custom"の場合、作業フォルダ。
    exceptions array 収集対象外情報のリスト。
    id string 収集対象外のID。
    type string 収集対象の種類。"ip_address"(IPアドレスの範囲指定)、"subnet_mask"(マスク指定)、"host_name"(ホスト名指定)。
    ip_address_from string IPアドレスの範囲指定の場合、IPアドレス開始。
    ip_address_to string IPアドレスの範囲指定の場合、IPアドレス終了。
    ip_address string マスク指定の場合、ネットワークアドレス。
    address_prefix string マスク指定の場合、プレフィックス。
    host_name string ホスト名指定の場合、ホスト名。

  7. 変更履歴

    【リクエスト】

    GET /v1/probe/configuration/edge001?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 2909

{
    "configurations": [
        {
            "id": "d2893136-c92a-4c4b-9531-650d416b54b4",
            "config_name": "config name",
            "enable": "on",
            "auto_discovery": "on",
            "probe_triggers": [
                {
                    "trigger_type": "weekly",
                    "trigger_time": "13:30",
                    "trigger_repeats": "0101010"
                }
            ],
            "targets": [
                {
                    "id": "4c99fcbd-28b8-438b-b20c-7e0e0b2e1414",
                    "type": "subnet_mask",
                    "protocol_config": {
                        "protocol_type": "Custom",
                        "command_line": "sh test.sh",
                        "command_option": "-h",
                        "command_workdir": ""
                    },
                    "ip_address": "192.168.111.0",
                    "address_prefix": "24"
                },
                {
                    "id": "e785fa40-c729-42b4-ac75-58d549bda05e",
                    "type": "ip_address",
                    "protocol_config": {
                        "protocol_type": "SSH/SCP",
                        "auth": "password",
                        "user": "Eileen.Lubowitz",
                        "port": 22
                    },
                    "ip_address_from": "192.168.111.100",
                    "ip_address_to": "192.168.111.110"
                }
            ],
            "exceptions": [
                {
                    "type": "subnet_mask",
                    "protocol_config": {
                        "protocol_type": "Custom",
                        "command_line": "start.sh",
                    },
                    "ip_address": "192.168.111.0",
                    "address_prefix": "24"
                }
            ],
            "tenant_id": "5a6a8dd635342331c0f5f06e",
            "edge_id": "N8498-84AEEAE111"
        }
    ]
}

プローブ収集定義削除

  1. 処理概要

    指定されたエッジ機器IDのプローブ収集定義を削除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/probe/***edge\_id***?tenant_id=***tenant\_id***

    edge_id には削除するプローブ収集定義のエッジIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    edge_id string エッジIDを指定する。 不可 ‐ ‐
    tenant_id string テナントIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK プローブ収集定義の削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)

  7. 変更履歴

    【リクエスト】

    DELETE /v1/probe/edge001?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK

SBOM情報登録

  1. 処理概要

    SBOM情報を登録します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/sboms

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_name string SBOM名を指定する。 不可 ‐
    description string 説明を指定する。 可 ‐ ‐
    file file SBOMデータを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報の登録が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)
    id string SBOMのID。

  7. 変更履歴

    【リクエスト】

    PUT /v1/sboms HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024
file: (ファイルの中身)
BaseCommandApplication::SendRequest::RequestBody: {"sbom_name":"sbom_name","description":"説明","tenant_id":"5a6a8dd635342331c0f5f06e"}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 28

{
  "id": "1"
}

SBOM情報更新

  1. 処理概要

    SBOM情報を更新します。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/sboms/***sbom\_id***

    sbom_id にはSBOM情報を表示するSBOMのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_id string SBOMIDを指定する。 不可 ‐ ‐
    sbom_name string SBOM名を指定する。 不可 ‐
    description string 説明を指定する。 可 ‐ ‐
    file file SBOMデータを指定する。 可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報の更新が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    return_code integer 処理結果(異常終了:0以外)
    id string SBOMのID。

  7. 変更履歴

    【リクエスト】

    PUT /v1/sboms/1?tenant_id=5a6a8dd635342331c0f5f06e HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 1024
file: (ファイルの中身)
BaseCommandApplication::SendRequest::RequestBody: {"sbom_name":"sbom_name","description":"説明","tenant_id":"5a6a8dd635342331c0f5f06e"}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 28

{
  "id": "1"
}

SBOM情報取得

  1. 処理概要

    SBOM情報を取得します。

  2. HTTPメソッド

    POST

  3. URL

    /v1/sboms

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    limit integer 一覧表示するSBOMの数を指定する。 「-1」が指定された場合は、検索条件にヒットする全レコードを返却する。 可 10とする。 数値
    offset integer sort_table, sort_column, sort_orderでソートしたSBOM一覧のどの位置以降のSBOMを表示するかを指定する。最初から表示する場合は0を指定する。 可 0とする。 数値
    sort_column string 検索結果のSBOM一覧をソートする際に、ソートのキーとするカラム名を指定する。 可 "UpdateTime"とする。 ・SBOMName：SBOM名
    ・Description：説明
    ・UpdateTime：更新日時
    ・Timestamp：SBOM作成日時
    ・Supplier：サプライヤー
    ・Component：パッケージ名
    ・UniqueIdentifier：ID
    ・Version：バージョン
    ・ComponentHash：チェックサム
    ・RelationShips：リレーションシップ
    ・SBOMAuthor：SBOM作成者
    sort_order string 検索結果のSBOM一覧をソートする際に、ソート順を指定する。 可 "ASC"とする。 ・"ASC"：昇順 ・"DESC"：降順
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    machine_id string エッジIDを指定する。 可 ‐ ‐
    conditions array 検索条件のリスト。 可 ‐ ‐
    column string SBOMを検索する条件となるカラム名を指定する。 不可 ‐ ・SBOMName：SBOM名
    ・Description：説明
    ・UpdateTime：更新日時
    ・Timestamp：SBOM作成日時
    ・Supplier：サプライヤー
    ・Component：パッケージ名
    ・UniqueIdentifier：ID
    ・Version：バージョン
    ・ComponentHash：チェックサム
    ・RelationShips：リレーションシップ
    ・SBOMAuthor：SBOM作成者
    ・SBOMData：SBOMデータ
    operator string SBOMを検索する条件となる比較演算子を指定する。 不可 ‐ ・"include"：～を含む
    ・"not include"：～を含まない
    ・"equal"：～と等しい
    ・"not equal"：～と等しくない
    ・"begin"：～で始まる
    ・"end"：～で終わる
    ・"or more"：～以上
    ・"or less"：～以下
    ・"over"：～より大きい
    ・"under"：～より小さい
    ・"and"：且つ
    ・"or"：または
    UpdateTime以外は文字列データの検索と同様。 UpdateTimeについては数値データと同様の指定が可能です。
    value string 比較演算子とともにSBOMを検索する条件となる値を指定する。 不可 ‐ 4,000文字以内の文字列
    display_colums array 表示項目のリスト。 可 ‐ ‐
    column string SBOMを表示するカラム名を指定する。 不可 ‐ ・Timestamp：SBOM作成日時
    ・Supplier：サプライヤー
    ・Component：パッケージ名
    ・UniqueIdentifier：ID
    ・Version：バージョン
    ・ComponentHash：チェックサム
    ・RelationShips：リレーションシップ
    ・SBOMAuthor：SBOM作成者

    ※operator(比較演算子)で指定された値に応じた検索内容

    条件 operator value1 value2 検索内容
    ～を含む "include" A 指定しない 「A」を含む文字列を検索
    ～を含まない "not include" A 指定しない 「A」を含まない文字列を検索
    ～と等しい "equal" A 指定しない 「A」と等しい文字列、数値、日時を検索
    ～と等しくない "not equal" A 指定しない 「A」と等しくない文字列、数値、日時を検索
    ～で始まる "begin" A 指定しない 「A」で始まる文字列を検索
    ～で終わる "end" A 指定しない 「A」で終わる文字列を検索
    ～以上 "or more" A 指定しない 「A」以上の数値を検索
    ～以下 "or less" A 指定しない 「A」以下の数値を検索
    ～より大きい "over" A 指定しない 「A」より大きい数値をを検索
    ～より小きい "under" A 指定しない 「A」より小さい数値を検索
    且つ "and" 指定しない 指定しない 複数条件がありAND条件で検索する場合していする
    または "or" 指定しない 指定しない 複数条件がありOR条件で検索する場合していする

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOMの取得が成功(検索結果が0件でも成功として扱う)。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    total_result integer 指定した検索条件にヒットしたSBOM数
    items_per_page integer 指定した検索条件にヒットしたSBOMの中から、本レスポンスで返却するSBOM数
    limit integer 取得する情報数(リクエストで指定した値を返却)
    offset integer リクエストで指定した値に取得した情報数を加算した値
    sort_column string ソートキーとするカラム名(リクエストで指定した値を返却)
    sort_order string ソート順(リクエストで指定した値を返却)
    results array 検索条件にヒットしたSBOMのリスト
    Id string SBOMID。
    SBOMName string SBOM名。
    Description string 説明。
    UpdateTime string 更新日時。
    Supplier string サプライヤー。（検索条件指定時、表示指定時のみ出力）
    Component string パッケージ名。（検索条件指定時、表示指定時のみ出力）
    Version string バージョン。（検索条件指定時、表示指定時のみ出力）
    Timestamp string SBOM作成日時。（検索条件指定時、表示指定時のみ出力）
    UniqueIdentifier string ID。（検索条件指定時、表示指定時のみ出力）
    ComponentHush string チェックサム。（検索条件指定時、表示指定時のみ出力）
    RelationShips string リレーションシップ。（検索条件指定時、表示指定時のみ出力）
    SBOMAuthor string SBOM作成者。（検索条件指定時、表示指定時のみ出力）
    SBOMData string SBOMデータ。（検索条件指定時のみ出力）

  7. 変更履歴

    【リクエスト】

    POST /v1/sboms HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280
Content-Length: 358

{
  "limit" : 100,
  "offset" : 0,
  "sort_column" : "UpdateTime",
  "sort_order" : "DESC",
  "tenant_id" : "5caef1e101c2025400d5f2a3",
  "conditions" : [{
    "column" : "SBOMName",
    "operator" : "include",
    "value" : "t"
  }],
  "display_columns" : [{
    "column" : "Version"
  }]
}

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 504

{
    "items_per_page" : 2,
    "limit" : "10",
    "offset" : 2,
    "results" : [
        {
            "Description" : "Description",
            "Id" : "5",
            "SBOMName" : "SBOMName",
            "UpdateTime" : "2023-02-21 04:52:58",
            "Version": "1.2"
        },
        {
            "Description" : "Description",
            "Id" : "4",
            "SBOMName" : "SBOMName2",
            "UpdateTime" : "2023-02-20 10:28:24",
            "Version": "2.2"
        }
    ],
    "sort_column" : "UpdateTime",
    "sort_order" : "DESC",
    "sort_table" : "SBOMInfo",
    "total_result" : 2
}

SBOM情報詳細表示

  1. 処理概要

    指定されたSBOMIDをもつSBOM情報を表示します。

  2. HTTPメソッド

    GET

  3. URL

    /v1/sboms/***sbom\_id***?tenant_id=***tenant\_id***

    sbom_id にはSBOM情報を表示するSBOMのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_id string SBOMIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報の詳細表示が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    パラメータ 型 説明
    data array 指定されたSBOMIDのSBOMデータ

  7. 変更履歴

    【リクエスト】

    GET /v1/sboms/1?tenant_id=5a6a8dd635342331c0f5f06e HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1906

{
    "data": {
        "SBOMAuthor": "SBOMAuthor",
        "dataLicense": "CC0-1.0",
        "Timestamp": "2010-01-29T18:30:22Z",
        "documentName": "SPDX-Tools-v2.0",
        "nameSpace": "http://spdx.org/spdxdocs/spdx-example-444504E0-4F89-41D3-9A0C-0305E82C3301",
        "packages": [
            {
                "component": "glibc",
                "componentHash": [],
                "fileName": "glibc-2.11.1.tar.gz",
                "licenseConclude": "(LGPL-2.0-only OR LicenseRef-3)",
                "licenseDeclared": "(LGPL-2.0-only AND LicenseRef-3)",
                "relationShips": [],
                "supplier": "Person: Jane Doe (jane.doe@example.com)",
                "uniqueIdentifier": "SPDXRef-Package",
                "version": "2.11.1"
            },
            {
                "component": "Apache Commons Lang",
                "componentHash": [],
                "fileName": "",
                "licenseConclude": "NOASSERTION",
                "licenseDeclared": "NOASSERTION",
                "relationShips": [],
                "supplier": "",
                "uniqueIdentifier": "SPDXRef-fromDoap-1",
                "version": ""
            },
            {
                "component": "Jena",
                "componentHash": [],
                "fileName": "",
                "licenseConclude": "",
                "licenseDeclared": "",
                "relationShips": [],
                "supplier": "",
                "uniqueIdentifier": "SPDXRef-fromDoap-0",
                "version": "3.12.0"
            },
            {
                "component": "Saxon",
                "componentHash": [],
                "fileName": "saxonB-8.8.zip",
                "licenseConclude": "MPL-1.0",
                "licenseDeclared": "MPL-1.0",
                "relationShips": [],
                "supplier": "",
                "uniqueIdentifier": "SPDXRef-Saxon",
                "version": "8.8"
            }
        ]
    }
}

SBOM情報削除

  1. 処理概要

    指定されたIDのSBOM情報を削除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/sboms/***sbom\_id***?tenant_id=***tenant\_id***

    sbom_id には削除するSBOM情報のSBOMのIDを指定します。

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_id string SBOMIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報の削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    DELETE /v1/sboms/1?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK

SBOM情報をエッジ機器に紐づけ

  1. 処理概要

    SBOM情報を指定したエッジ機器に紐づけします。

  2. HTTPメソッド

    PUT

  3. URL

    /v1/sboms/***sbom\_id***/***edge\_id***?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_id string SBOMIDを指定する。 不可 ‐ ‐
    edge_id string エッジ機器のIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報とエッジ機器の紐づけが成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    PUT /v1/sboms/1/edge001?tenant_id=5a6a8dd635342331c0f5f06e HTTP/1.1
Content-Type: application/json;charset=utf-8
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK

SBOM情報をエッジ機器に紐づけ解除

  1. 処理概要

    SBOM情報から指定したエッジ機器の紐づけを解除します。

  2. HTTPメソッド

    DELETE

  3. URL

    /v1/sboms/***sbom\_id***/***edge\_id***?tenant_id=***tenant\_id***

  4. パラメータ

    パラメータ 型 説明 省略可否 省略時の動作 有効な値
    tenant_id string テナントIDを指定する。 不可 ‐ ‐
    sbom_id string SBOMIDを指定する。 不可 ‐ ‐
    edge_id string エッジ機器のIDを指定する。 不可 ‐ ‐

  5. レスポンス(HTTPステータスコード)

    HTTPステータスコード 意味 説明
    200 OK SBOM情報の削除が成功。
    400 Bad Request 不正なリクエスト。パラメータに誤りがある。
    500 Internal Server Error サーバー側の内部エラー。

  6. レスポンス(HTTPボディ)

    レスポンスのHTTPボディはありません。

  7. 変更履歴

    【リクエスト】

    DELETE /v1/sboms/1/edge001?tenant_id=5caef1e101c2025400d5f2a3 HTTP/1.1
Host: localhost:8280

    【レスポンス】

    HTTP/1.1 200 OK

変更履歴（構成管理）

  1. 構成グループ登録

    Version 変更内容
    2.0.0 新規追加

  2. 構成グループ更新

    Version 変更内容
    2.0.0 新規追加

  3. 構成グループ構成情報収集契機更新

    Version 変更内容
    2.0.0 新規追加

  4. 構成グループ取得

    Version 変更内容
    2.0.0 新規追加

  5. 構成グループ構成情報収集契機取得

    Version 変更内容
    2.0.0 新規追加

  6. 構成グループ削除

    Version 変更内容
    2.0.0 新規追加

  7. 構成情報登録・更新

    Version 変更内容
    2.0.0 新規追加

  8. 構成情報CSV登録・更新

    Version 変更内容
    2.0.0 新規追加

  9. 構成情報条件検索

    Version 変更内容
    1.0.0 新規追加
    2.0.0 パラメータにtenant_idを追加、レスポンスに複数項目を追加
    2.1.0 パラメータにdisplay_columns及び検索条件を複数追加を追加、レスポンスにプローブを追加

  10. 構成情報詳細表示

    Version 変更内容
    1.0.0 新規追加
    2.0.0 レスポンスにdefault_group配下を追加

  11. 構成情報削除

    Version 変更内容
    1.0.0 新規追加

  12. 構成情報一括削除

    Version 変更内容
    1.0.0 新規追加

  13. プロファイル情報登録・更新

    Version 変更内容
    1.0.0 新規追加

  14. 管理情報登録・更新

    Version 変更内容
    1.0.0 新規追加
    2.0.0 パラメータにdescriptionを追加

  15. 接続状態更新

    Version 変更内容
    2.0.0 新規追加

  16. 構成情報エッジ一括削除

    Version 変更内容
    2.0.0 新規追加

  17. 設定情報更新

    Version 変更内容
    2.0.0 新規追加

  18. 設定情報取得

    Version 変更内容
    2.0.0 新規追加

  19. 構成サマリ情報取得

    Version 変更内容
    2.0.0 新規追加
    2.1.0 ステータス追加

  20. 構成情報json登録・更新

    Version 変更内容
    2.1.0 新規追加

  21. 構成情報のエクスポート

    Version 変更内容
    2.1.0 新規追加

  22. カスタム構成情報定義登録

    Version 変更内容
    2.1.0 新規追加

  23. CAP情報取得

    Version 変更内容
    2.1.0 新規追加

  24. カスタム構成情報定義取得

    Version 変更内容
    2.1.0 新規追加

  25. カスタム構成情報定義削除

    Version 変更内容
    2.1.0 新規追加

  26. プローブ収集定義登録・更新

    Version 変更内容
    2.1.0 新規追加

  27. プローブ収集定義取得

    Version 変更内容
    2.1.0 新規追加

  28. プローブ収集定義削除

    Version 変更内容
    2.1.0 新規追加

  29. SBOM情報登録

    Version 変更内容
    2.1.0 新規追加

  30. SBOM情報更新

    Version 変更内容
    2.1.0 新規追加

  31. SBOM情報取得

    Version 変更内容
    2.1.0 新規追加

  32. SBOM情報詳細表示

    Version 変更内容
    2.1.0 新規追加

  33. SBOM情報削除

    Version 変更内容
    2.1.0 新規追加

  34. SBOM情報をエッジ機器に紐づけ

    Version 変更内容
    2.1.0 新規追加

  35. SBOM情報をエッジ機器に紐づけ解除

    Version 変更内容
    2.1.0 新規追加