2.5.3　サービスの編集

機能

指定したサービスを編集します。

このAPIでは，サービスのプロパティ値は変更できません。プロパティ値を更新したい場合は「2.9.6　プロパティ値の一括更新」または「2.9.8　プロパティ値の更新」のトピックを参照してください。

Submitロールを持つユーザーは，プロパティ「favorite」だけを更新できます。Adminロール，Developロール，またはModifyロールの権限を持つユーザーは，すべてのプロパティを更新できます。

実行権限

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

APIのバージョン

リクエスト形式

PUT http://host:port/Automation/version/objects/Services/id

リクエストのスキーマは，API「サービスの情報取得」のレスポンスボディーと同じ形式です。「Services」のメンバーとして指定できるオブジェクトを，次の表で説明します。

表2‒49　「Services」のメンバーとして指定できるオブジェクト
機能	リソース名称	数	説明
サービス	Services	1	指定したIDのServicesリソース

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

リソース名称	メンバー名	数
Services	name	1
	description
	tags
	favorite
	serviceState
	supportedScheduleType

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	成功しました。
400	Bad Request	引数不正です。または，すでに存在しているサービス名を指定しています。
401	Unauthorized	ログイン権限がありません。
404	Not found	サービスの取得権限がありません。または，サービスがありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

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

{
  "instanceID" : instance-id,
  "name" : "service-display-name",
  "description" : "description-text",
  "tags" : "tags"
  "serviceTemplateName" : "service-template-name"
  "createTime" : "created-date-and-time",
  "modifyTime" : "updated-date-and-time",
  "serviceState" : "service-state"
  "serviceGroupName" : "service-group-name",
  "iconURL" : "icon-URL",
  "vendorName" : "vendor-name",
  "version" : "version"
  "lastSubmitTime" : "last-submit-time",
  "favorite" : {true|false},
  "failedCount" : failed-count,
  "completedCount" : completed-count,
  "executedCount" : executed-count,
  "latest" : {true|false},
  "imageURL" : "image-URL",
  "supportedScheduleType" : "supported-schedule-type",
  "submitCount" : submit-count,
  "serviceTemplateID" : service-template-id,
  "serviceGroupID" : service-group-id,
  "supportedActionType" : supported-action-type
}

使用例

instanceID=2015のサービスを編集する場合の使用例を示します。

リクエストヘッダー:

PUT /Automation/v1/objects/Services/2015 HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 11:40:10 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 5929972368348e976584903133f5f8ce93ce2aec_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

レスポンスボディー:

{
  "instanceID" : 2015,
  "name" : "testService1",
  "description" : "description",
  "tags" : "",
  "serviceTemplateName" : "testService",
  "createTime" : "2014-07-14T01:16:11.000-0700",
  "modifyTime" : "2014-07-14T04:36:30.000-0700",
  "serviceState" : "release",
  "serviceGroupName" : "DefaultServiceGroup",
  "iconURL" : "http://10.196.184.238:22015/Automation/icon/services/com.hitachi.software/remoteCommandExe/01.20.00",
  "vendorName" : "Hitachi,Ltd.",
  "version" : "01.20.00",
  "lastSubmitTime" : "2014-07-14T01:16:11.000-0700",
  "favorite" : false,
  "failedCount" : 0,
  "completedCount" : 0,
  "executedCount" : 0,
  "latest" : true,
  "supportedScheduleType" : "immediate,schedule,recurrence",
  "submitCount" : 0,
  "serviceTemplateID" : 5106,
  "serviceGroupID" : 3,
  "supportedActionType" : "forciblyStop,retry"
}

ページの先頭へ

2.5.3 サービスの編集

2.5.3　サービスの編集