Shelty Open APIの呼び出し方
Shelty Manager 1.3.0以降にはAPIのエンドポイントが用意されております。
そちらのエンドポイントに対してHTTP(S)でリクエストを送ることでJSON形式の応答が返却されます。
また、Shelty Open APIを使用するためにはAPIキーを事前に発行しておき、APIキーをリクエストのURLパラメータに含める必要があります。APIキーの発行方法についてはAPIキー管理 を参照してください。
ポート番号はデフォルト値8080です。httpsの場合はShelty Managerサイド(ポート番号) を参照してください。
リクエストの例
APIキーが00d5a491-7a41-42cf-b383-3da5e2d4430cの場合
http://${Shelty Manager サーバ}:8080/shelty/api/public/v1/meta/hierarchy/systems? |
レスポンスの例
{ "system": [ { "systemId": 1, "systemName": "IIMオンラインシステム", "isSharedSystem": false, "relationSystem": [ { "systemId": 13, "systemName": "共通認証システム", "isSharedSystem": true } ] } (~中略~) ] } |
また、検索条件もURLパラメータとして指定することが可能です。APIによって利用できる検索条件が異なりますので、それぞれのAPIの定義を参照してください。
また、日本語の指定にはUTF-8でのURLエンコーディングが必要になりますのでご注意下さい
(例:「オンライン」→「%E3%82%AA%E3%83%B3%E3%83%A9%E3%82%A4%E3%83%B3」)。
例:「システムIDが「1」もしくは「2」」を条件に指定する場合
http://${Shelty Manager サーバ}:8080/shelty/api/public/v1/meta/hierarchy/systems?apiKey=00d5a491-7a41-42cf-b383-3da5e2d4430c&systemId=1,2 |
例:「システムIDが「1」かつシステム名に「オンライン」を含む」を条件に指定する場合
http://${Shelty Manager サーバ}:8080/shelty/api/public/v1/meta/hierarchy/systems?apiKey=00d5a491-7a41-42cf-b383-3da5e2d4430c&systemId=1&systemName=%E3%82%AA%E3%83%B3%E3%83%A9%E3%82%A4%E3%83%B3 |
!注意
①環境変数、またはJavaアプリケーションのシステムプロパティ中にセキュリティ情報(例えば、パスワードを平文にて渡している場合など)が含まれている場合、取得された情報にはそのままの状態で含まれます。
②出力内容の行間に改行コードが含まれる場合、エスケープシーケンスを付与して出力されます。
対象改行コード:\r, \n, \r\n
例:SheltyManager\nVersion2.1.0 ↓ エスケープシーケンスを付与 SheltyManager\\nVersion2.1.0 |
但し、Javaのline.separatorなど改行コードそのものの場合はエスケープシーケンスは付与されません。
③ホストやAgentのインベントリ情報を取得する場合、Agentのバージョンを2.1.0以降にする必要があります。
Related content
Copyright © IIM. All Rights Reserved.