Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 


2.10.1 サービスグループ一覧の取得

機能

サービスグループの一覧を取得します。

実行権限

Adminロール,Developロール,Modifyロール,Submitロール

APIのバージョン

v1

リクエスト形式

GET http://host:port/Automation/version/objects/ServiceGroups

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。

ステータスコード

メッセージ

説明

200

OK

成功しました。

400

Bad Request

クエリパラメータが不正です。

401

Unauthorized

ログイン権限がありません。

412

Precondition failed

サーバが利用できません。

500

Server-side error

サーバ処理エラーが発生しました。

レスポンスのスキーマ

レスポンスボディーには,リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。

{
  "data" : [ {"サービスグループ機能のリソース(ServiceGroups)のメンバー" :  ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数(0~n)
}

使用例

サービスグループの一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/ServiceGroups HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 07:09:41 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 75f7726f932537efbc38f15ea81c31a8797bab1e_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_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" : 3,
    "objectID" : "Automation_RG_DEFAULT",
    "name" : "DefaultServiceGroup",
    "description" : "default service group"
  }, {
    "instanceID" : 2,
    "objectID" : "Automation_RG_ALL",
    "name" : "All Service Groups",
    "description" : "default service groups which contains all services"
  } ],
  "count" : 2
}