4.1.5. 構成情報検索API

この章では Senju Configuration Manager の構成情報検索APIの操作方法について説明します。

注釈

このAPIはAdministratorロールのユーザーでは利用できません。

注釈

APIの利用にあたっては、ログインユーザーごとに予め発行したAPIトークンをリクエストに含める必要があります。 APIトークンはHTTPヘッダにてキー名 sjcm-api-token の値として指定してください。

注釈

対象データを特定するための条件として、クエリ文字列に検索条件を指定することができます。 なお、クエリ文字列はURLエンコードされている必要があります。

4.1.5.1. 基本構造

構成情報検索APIの基本的なURL構造は以下のとおりです。 GETメソッドでリクエストします。

https://{server}:{port}/api/{version}/Inventories?type={type}

{type} 部分に指定可能な種別には以下があります。

表 4.3 type種類

対象データ

指定値

Linuxソフトウェア

LinuxPackages

Linuxファイル

LinuxFiles

SNMPインベントリ

SnmpInventories

WMIインベントリ

WmiInventories

Textデータ

TextInventories

JSONデータ

JsonInventories

Tableデータ

TableInventories

イベント

SystemEvents

ステータス

CollectStatuses

指定可能なパラメータは以下のとおりです。

表 4.4 Parameter

パラメータ名

値の型

指定要否

説明

type

string

必須

input

string

任意

検索条件を指定します

search

string

任意

検索条件を指定します

注釈

  • 履歴系情報検索APIは最新表ではなく、履歴表を利用しています。

  • input、latestDataは( パラメータ参考表 )を参照してください。

4.1.5.2. パラメータ参考表

パラメータ input には以下の項目を指定できます。

表 4.5 input

項目名

値の型

説明

備考

limit

int

1回の応答に含めるデータの件数を指定します。

範囲：1～100、デフォルト値：25

page

int

ページングされた場合のページ番号を指定します。

範囲：1～100、デフォルト値：1

orderby

string

応答データの並び替えキー項目を指定します。

デフォルト値： Id

isdesc

string

応答データの並び替え順序を指定します。

Y :降順(デフォルト)、 N :昇順
表 4.6 latestDat

値

備考

0

デフォルト値、無意味

1

検索結果中最新の登録時間を取って、登録時間はこの最新登録時間のタスクを取ります

4.1.5.3. HTTPステータスコード

APIのレスポンスに失敗した場合、以下のHTTPステータスコードを応答します。

表 4.7 処理失敗時のHTTPステータスコード

コード

メッセージ

発生条件

400

The type field is required.

typeが未指定です

400

Type is illegal

typeが不正値です

400

The value 'xxx' is not valid for CreatedAtFrom.

CreatedAtFromが不正値です

400

TimeStampFrom or TimeStampTo should not be set

TimeStampFromまたはTimeStampToが不正値です

401

sjcm-api-token HTTP Header Not Found.

tokenが未指定です

401

Token access permission expired

tokenが不正値です