Hitachi

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


2.5.18 サービスが使用するサービステンプレートのバージョン変更

機能

指定したサービスに,任意のバージョンのサービステンプレートを適用します。

実行権限

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

APIのバージョン

v1

リクエスト形式

POST http://host:port/Automation/version/objects/Services/id/actions/applyTemplate/invoke

リクエストボディーの構造は,次のようになっています。

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

リクエストのスキーマで「parameters」のメンバーとして指定できるオブジェクトを,次の表で説明します。

表2‒53 「parameters」のメンバーとして指定できるオブジェクト

機能

リソース名称

説明

サービステンプレート

ServiceTemplate

1

バージョンアップするサービステンプレート

このオブジェクトに指定必須のプロパティについて,次に説明します。

リソース名称

メンバー名

ServiceTemplate

instanceID

1

ステータスコード

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

ステータスコード

メッセージ

説明

200

OK

成功しました。

400

Bad Request

引数が不正です。

401

Unauthorized

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

404

Not found

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

409

Conflict

変更先のサービステンプレートの状態が不正です。

412

Precondition failed

サーバが利用できません。または,テンプレート変更の前提条件を満たしていません。

500

Server-side error

変更できないサービスです。または,サーバ処理エラーが発生しました。

レスポンスのスキーマ

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

{
  "instanceID" : "instance-id",
  "created" : "created-date-and-time",
  "updated" : "updated-date-and-time",
  "completed" : "completed-date-and-time",
  "state" : "state",
  "affectedResources" : [ {...} ],
  "result" : [ {...} ],
  "resultType" : "result-type"
}

使用例

instanceID=2188のサービスが使用するサービステンプレートのバージョン変更をする場合の使用例を示します。

リクエストヘッダー:

POST /Automation/v1/objects/Services/2188/actions/applyTemplate/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Content-Type: application/json
Content-Length: 1199
Expect: 100-continue
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 100 Continue
HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 05:23:38 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 456eb72dda7029ba9cbdf3dd57233a25247d2717_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

レスポンスボディー:

{
  "instanceID" : "10920fed-ad4f-4be1-9015-bd2066e5312c",
  "created" : "2015-07-30T14:23:38.683+09:00",
  "updated" : "2015-07-30T14:23:38.683+09:00",
  "completed" : "2015-07-30T14:23:38.683+09:00",
  "state" : "success",
  "affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Services/2188" ],
  "result" : [ ]
}