2.7.9 タスクの強制停止
機能
指定したタスクを強制停止します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/objects/Tasks/id/actions/forceStop/invoke
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
|---|---|---|
200 |
OK |
成功しました。 |
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" : [ ]
}
使用例
instanceID=5381のタスクを強制停止する場合の使用例を示します。
リクエストヘッダー:
POST /Automation/v1/objects/Tasks/5381/actions/forceStop/invoke HTTP/1.1
Host: 192.168.146.132:22015
User-Agent: curl/7.36.0
Accept: application/json
Content-Type: application/json
Content-Length: 175
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
{
"name" : "forceStop",
"href" : "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5338/actions/forceStop/invoke",
"method" : "POST",
"parameters" : [ ]
}
Accept-Language: ja
レスポンスヘッダー:
HTTP/1.1 200 OK
Date: Fri, 07 Aug 2015 10:00:39 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO a2e8ab6f7a9c35323fb7d9331735a9419235ebad_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" : "68451399-53c2-4f6b-bbdd-be025a61ed02",
"created" : "2015-08-07T19:00:40.025+09:00",
"updated" : "2015-08-07T19:00:40.025+09:00",
"completed" : "2015-08-07T19:00:40.025+09:00",
"state" : "success",
"affectedResource" : [ "http://192.168.146.132:22015/Automation/v1/objects/Tasks/5381" ],
"result" : [ ]
}