Hitachi

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


2.5.5 サービスに対する操作一覧の取得

機能

指定したサービスに対して実行できる操作の一覧を取得します。

実行権限

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

APIのバージョン

v1

リクエスト形式

GET http://host:port/Automation/version/objects/Services/id/actions

ステータスコード

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

ステータスコード

メッセージ

説明

200

OK

成功しました。

401

Unauthorized

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

404

Not found

権限が不正です。または,リソースがありません。

412

Precondition failed

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

500

Server-side error

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

レスポンスのスキーマ

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

{
  "data" : [ {
    "name" : "update",
    "href" : "http://host:port/Automation/version/objects/Services/id",
    "method" : "PUT",
    "parameters" : []
  }, {
    "name" : "submit",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/submit/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "detailhelp",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/detailhelp",
    "method" : "GET",
    "parameters" : []
  }, {
    "name" : "delete",
    "href" : "http://host:port/Automation/version/objects/Services/id",
    "method" : "DELETE",
    "parameters" : []
  }, {
    "name" : "reset",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/reset/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "release",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/release/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "maintenance",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/maintenance/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "disable",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions/disable/invoke",
    "method" : "POST",
    "parameters" : []
  }, {
    "name" : "applyTemplate",
    "href" : " http://host:port/Automation/version/objects/Services/id/actions applyTemplate/invoke",
    "method" : "POST",
    "parameters" : []
  } ],
  "count" : 9
}

使用例

instanceID=2004のサービスに対して,実行できる操作の一覧を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/Services/2004/actions 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: Thu, 30 Jul 2015 04:40:59 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 72fe74c462e2a50793542df0c0589289ce3f3_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" : [ {
    "name" : "update",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004",
    "method" : "PUT",
    "parameters" : [ ]
  }, {
    "name" : "submit",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/submit/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "detailhelp",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/detailhelp",
    "method" : "GET",
    "parameters" : [ ]
  }, {
    "name" : "delete",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004",
    "method" : "DELETE",
    "parameters" : [ ]
  }, {
    "name" : "reset",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/reset/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "release",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/release/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "maintenance",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/maintenance/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "disable",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/disable/invoke",
    "method" : "POST",
    "parameters" : [ ]
  }, {
    "name" : "applyTemplate",
    "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2004/actions/applyTemplate/invoke",
    "method" : "POST",
    "parameters" : [ ]
  } ],
  "count" : 9
}