2.5.1 サービス一覧の取得
機能
JP1/AOに登録されているサービスの一覧を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Services
APIの実行ユーザーが権限を持つ,すべてのサービスを対象として一覧を取得します。クエリパラメータを指定すると,一覧を取得する対象を絞り込めます。クエリパラメータは,次の形式で指定してください。
?クエリパラメータ=値[&クエリパラメータ=値...]
クエリパラメータ |
フィルタ条件 |
---|---|
serviceGroupID |
指定した値に等しい。 |
serviceTemplateID |
|
favorite |
|
propertyKey |
指定した値を含む「PropertyValues」リソースのkeyName |
tags |
値をすべて含んでいるか。「,」区切りで複数指定できる。 |
q |
次に示す検索対象のスキーマに対して,値を含んでいるか全文検索する。
半角スペース区切りで複数指定した場合,値をすべて含んでいるか全文検索する。大文字・小文字を区別しない。 |
そのほかに指定できるクエリパラメータについては,「2.2.9 クエリパラメータ」を参照してください。
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
クエリパラメータが不正です。 |
401 |
Unauthorized |
ログイン権限がありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
レスポンスボディーには,リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。
{ "data" : [ {"サービス機能のリソース(Services)のメンバー" : 値 ... }, ... ], "count" : クエリパラメータの条件に合致したデータの個数(0~n) }
使用例
すべてのサービスを対象として,サービス一覧を取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/Services HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= Host: 10.196.184.182:22015 User-Agent: curl/7.36.0 Accept: application/json Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Thu, 30 Jul 2015 02:30:37 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO fdef80b1cbd2d625cdbda39c16fda15f68a3d8c_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json レスポンスボディー: { "data" : [ { "instanceID" : 5137, "name" : "Execute Remote Command", "description" : "Executes a command on the remote execution target server.", "tags" : "Windows,Linux,Execute Script", "serviceTemplateName" : "Execute Remote Command", "createTime" : "2015-08-07T14:44:07.000+09:00", "modifyTime" : "2015-08-07T14:44:07.000+09:00", "serviceState" : "test", "serviceGroupName" : "DefaultServiceGroup", "iconURL" : "http://10.196.184.182:22015/Automation/icon/services/com.hitachi.software.dna.cts/remoteCommandExe/01.20.00", "vendorName" : "Hitachi,Ltd.", "version" : "01.20.00", "favorite" : false, "failedCount" : 0, "completedCount" : 0, "executedCount" : 0, "latest" : true, "supportedScheduleType" : "immediate,schedule,recurrence", "submitCount" : 0, "serviceTemplateID" : 5106, "serviceGroupID" : 3, "supportedActionType" : "forciblyStop,retry" } ], "count" : 1 }