Hitachi

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


2.5.6 サービス実行に必要な情報の取得

機能

指定したサービスの実行操作に必要な情報を取得します。

実行権限

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

APIのバージョン

v1

リクエスト形式

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

ステータスコード

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

ステータスコード

メッセージ

説明

200

OK

成功しました。

401

Unauthorized

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

404

Not found

サービスを取得する権限がありません。または,サービスがありません。

412

Precondition failed

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

500

Server-side error

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

レスポンスのスキーマ

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

{
  "name" : "submit",
  "href" : "http://host:port/Automation/version/objects/Services/id/actions/submit/invoke",
  "method" : "POST",
  "parameters" : [ {...} ]
}

「parameters」のメンバーとして出力されるオブジェクトを,次の表で説明します。

表2‒50 「parameters」のメンバーとして出力されるオブジェクト(サービス実行に必要な情報の取得)

機能

リソース名称

説明

スケジュール

Schedule

1

サービスの実行予定

プロパティ値の一覧

PropertyValue

0~n

サービスの入力プロパティ

使用例

instanceID=2015のサービスを実行する準備として,必要な情報を取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/Services/2015/actions/submit 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 75cdef77cf941edbf5b2934f6afe1e8e18fdba8a_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

レスポンスボディー:

{
  "name" : "submit",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2015/actions/submit/invoke",
  "method" : "POST",
  "parameters" : [ {
    "name" : "Execute Remote Command",
    "submitter" : "",
    "scheduleType" : "immediate",
    "description" : "",
    "scheduledStartTime" : "2015-07-30T14:51:23.342+09:00",
    "recurrenceInterval" : "daily",
    "recurrenceDayOfWeek" : "",
    "recurrenceDayOfMonth" : "",
    "recurrenceLastDayOfMonth" : false,
    "recurrenceStartDate" : "2015-07-30",
    "recurrenceTime" : "00:00:00",
    "serviceID" : 5137
  }, {
    "instanceID" : 5112,
    "type" : "string",
    "keyName" : "common.targetHost",
    "value" : "",
    "readOnly" : false,
    "hidden" : false,
    "serviceID" : 5137
  }, {
    "instanceID" : 5135,
    "type" : "string",
    "keyName" : "common.remoteCommand",
    "value" : "",
    "readOnly" : false,
    "hidden" : false,
    "serviceID" : 5137
  }, {
    "instanceID" : 5128,
    "type" : "string",
    "keyName" : "common.remoteCommandParameter",
    "value" : "",
    "readOnly" : false,
    "hidden" : false,
    "serviceID" : 5137
  } ]
}