2.4.5 探索の停止
探索を停止します。
権限
Admin
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/services/Discoveries/actions/stop/invoke
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":["...", ...] }
Action (Type: Action)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
操作名です。 |
href |
string |
操作の実行先URLです。 |
method |
string |
メソッド名です。 |
type |
string |
データのデータ形式です。 |
parameters |
anyType[] |
操作実行時に必要なコレクション。空欄です。 |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "instanceID":"...", "created":"...", "updated":"...", "completed":"...", "state":"...", "affectedResource":["...", ...], "result":["...", ...] }
Job (Type: Job)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
string |
インスタンスのIDを示します。 |
created |
string |
オブジェクトの生成日付を示します。ISO8601形式です。 |
updated |
string |
オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
completed |
string |
処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
state |
string |
以下の値が設定されます。 “failed”: 操作が正常終了しなかったことを示します。 “success”: 操作が正常終了したことを示します。 |
affectedResource |
string[] |
操作の結果,作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。 |
result |
anyType[] |
実行結果のコレクション。空欄です。 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
400 |
Bad Request |
Discoveryが未実行 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
実行権限がない |
409 |
Conflict |
実行中 |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] POST http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke HTTP/1.1 Host: localhost:22015 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Content-Length: 159 [Request Body] { "name":"stop", "href": "http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke", "method":"POST", "type":"application/json","parameters":[] } [Response Header] HTTP/1.1 200 OK Date: Mon, 25 May 2020 02:53:56 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 5613ce8c7eb2fb4c4f682c32545f5a9136113e_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Content-Type: application/json Content-Length: 279 [Response Body] { "instanceID" : "5732aea6-4208-4467-a548-54df423b603e", "created" : "2020-05-25T11:53:56.611+09:00", "updated" : "2020-05-25T11:53:56.611+09:00", "completed" : "2020-05-25T11:53:56.611+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ ] }