2.5.13 サービスの状態を「メンテナンス」に変更
機能
指定したサービスの状態を「メンテナンス」に変更します。
実行権限
Adminロール,Developロール,Modifyロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/objects/Services/id/actions/maintenance/invoke
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
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=2004のサービスの状態を「メンテナンス」に変更する場合の使用例を示します。
リクエストヘッダー: POST /Automation/v1/objects/Services/2004/actions/maintenance/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: 183 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Thu, 30 Jul 2015 05:04:40 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 23916dfb9e33860332c7e7995f78c2f2507dbf_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" : "36a53982-ac92-45aa-acea-21ede67b7df2", "created" : "2015-07-30T14:04:41.028+09:00", "updated" : "2015-07-30T14:04:41.028+09:00", "completed" : "2015-07-30T14:04:41.028+09:00", "state" : "success", "affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Services/2004" ], "result" : [ ] }