Hitachi

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


2.11.1 タググループ一覧の取得

機能

タググループの一覧を取得します。また,タググループに所属するタグ一覧を取得します。

実行権限

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

APIのバージョン

v1

リクエスト形式

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

ステータスコード

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

ステータスコード

メッセージ

説明

200

OK

成功しました。

401

Unauthorized

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

412

Precondition failed

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

500

Server-side error

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

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

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

使用例

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

リクエストヘッダー:

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

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 03:37:17 GMT
Server Cosminexus HTTP Server is not blacklisted
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO d72a9887e1aef533d4763b1adf0a391d6cfa6cb_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" : 34,
    "name" : "Applications",
    "tags" : "SQL Server,XenDesktop,Oracle Database,Cluster,Exchange"
  }, {
    "instanceID" : 42,
    "name" : "Hypervisors",
    "tags" : "VMware vSphere,Hyper-V"
  }, {
    "instanceID" : 45,
    "name" : "Storage Services",
    "tags" : "Replicate Storage,Add Like Storage,Snapshot,Add New Storage"
  }, {
    "instanceID" : 54,
    "name" : "Uncategorized",
    "tags" : "Basic,Hitachi,Windows,Linux"
  } ],
  "count" : 4
}