2.11.2　タグ一覧の取得

機能

指定したリソースに設定されているタグの一覧を取得します。

実行権限

Adminロール，Developロール，Modifyロール，Submitロール

APIのバージョン

リクエスト形式

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

APIの実行ユーザーが権限を持つ，すべてのタグを対象として一覧を取得します。クエリパラメータを指定すると，一覧を取得する対象を絞り込めます。クエリパラメータは，次の形式で指定してください。

?クエリパラメータ=値[&クエリパラメータ=値...]

表2‒81　API「タグ一覧の取得」で指定できるクエリパラメータの一覧
クエリパラメータ		フィルタ条件
detail		タグの詳細を取得する
resourceType^※1	ServiceTemplate	指定した値と等しい
	Service
	Task
	TaskHistory

注※1: resourceTypeを指定した場合，クエリパラメータとHQL::filterは，resourceTypeに指定したリソースに対して有効になります。

そのほかに指定できるクエリパラメータについては，「2.2.9　クエリパラメータ」を参照してください。

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	成功しました。
401	Unauthorized	ログイン権限がありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

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

{
  "data" : [ {"タグ機能のリソース（Tags）のメンバー" : 値 ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数（0～n）
}

使用例

すべてのタグを対象として一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/Tags 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:38:52 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO d2729dff1c31a47ed713d92612eec93fe7919c8_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" : 35,
    "name" : "Replicate Storage",
    "tagGroupID" : 45
  }, {
    "instanceID" : 36,
    "name" : "SQL Server",
    "tagGroupID" : 34
  }, {
    "instanceID" : 37,
    "name" : "Add Like Storage",
    "tagGroupID" : 45
  }, {
    "instanceID" : 38,
    "name" : "Snapshot",
    "tagGroupID" : 45
  }, {
    "instanceID" : 39,
    "name" : "Add New Storage",
    "tagGroupID" : 45
  }, {
    "instanceID" : 40,
    "name" : "VMware vSphere",
    "tagGroupID" : 42
  }, {
    "instanceID" : 41,
    "name" : "XenDesktop",
    "tagGroupID" : 34
  }, {
    "instanceID" : 43,
    "name" : "Hyper-V",
    "tagGroupID" : 42
  }, {
    "instanceID" : 44,
    "name" : "Oracle Database",
    "tagGroupID" : 34
  }, {
    "instanceID" : 46,
    "name" : "Cluster",
    "tagGroupID" : 34
  }, {
    "instanceID" : 47,
    "name" : "Exchange",
    "tagGroupID" : 34
  }, {
    "instanceID" : 51,
    "name" : "Basic",
    "tagGroupID" : 54
  }, {
    "instanceID" : 52,
    "name" : "Hitachi",
    "tagGroupID" : 54
  }, {
    "instanceID" : 552,
    "name" : "Windows",
    "tagGroupID" : 54
  }, {
    "instanceID" : 559,
    "name" : "Linux",
    "tagGroupID" : 54
  }, {
    "instanceID" : 564,
    "name" : "Execute Script",
    "tagGroupID" : 54
  }, {
    "instanceID" : 1004,
    "name" : "Report Volume Information to Replication Manager",
    "tagGroupID" : 54
  } ],
  "count" : 17
}

2.11.2 タグ一覧の取得

2.11.2　タグ一覧の取得