2.4.5 Stopping a Discovery
This API stop a discovery.
Execution permission
Admin
API version
v1
Request format
POST http[s]://host:port/Analytics/version/services/Discoveries/actions/stop/invoke
Request body
The structure of the request body and the object attributes are as follows:{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":["...", ...] }
Action (Type: Action)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the execute an operation. |
href |
string |
URL of the execute an operation. |
method |
string |
Name of the method. |
type |
string |
Data format of the object. |
parameters |
anyType[] |
A list of objects necessary to execute an operation. No value is set. |
Response body
The structure of the response body and the object attributes are as follows:{ "instanceID":"...", "created":"...", "updated":"...", "completed":"...", "state":"...", "affectedResource":["...", ...], "result":["...", ...] }
Job (Type: Job)
Attribute |
Type |
Description |
---|---|---|
instanceID |
string |
Indicates the ID of the Instance. |
created |
string |
Indicates the date the object is generated in ISO 8601 format. |
updated |
string |
Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set. |
completed |
string |
Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set. |
state |
string |
One of the following values is set: "failed": The operation did not terminate normally. "success": The operation terminated normally. |
affectedResource |
string[] |
Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty. |
result |
anyType[] |
A list of objects. No value is set. |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
400 |
Bad Request |
Discovery is not executing. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No execute privilege. |
409 |
Conflict |
Executing now. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[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" : [ ] }