2.4.7 Obtaining Discovery History
This API request acquires the results from the last discovery.
Execution permission
Modify
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/DiscoveryLogs
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:{ "data":[{ "status":"...", "autoManage":"...", "startTime":"...", "completionTime":"...", "elapsedTime":"...", "discoveredResources":"...", "failedProtocols":"...", "noResponseIpAddresses":"...", "skippedResources":"...", "denominatorForProgress":"...", "numeratorForProgress":"...", "lastTime":"...", "discoverdLogTargetIPRange":[{ "name":"..." }, : ] }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
---|---|---|
data |
DiscoveryLog[] |
A list of DiscoveryLog objects. For details about DiscoveryLog, see the table below. |
pagination |
Pagination |
Page information. This parameter is displayed only when the relevant resource exists. |
count |
int |
Number of data items that meet the conditions. |
data (Type: DiscoveryLog)
Attribute |
Type |
Description |
---|---|---|
status |
enum |
Discovery progress status. If a discovery has not been run, properties other than the status are not output. (For details about the specifiable values, see the table DiscoveryStatusType in List of enumerators.) The specifiable values are as follows:
|
autoManage |
boolean |
To automatically manage discovered resources, set true. |
startTime |
dateTime |
Discovery start time |
completionTime |
dateTime |
Discovery end time. If the discovery is in progress, this value is null. |
elapsedTime |
int |
Time elapsed during discovery (in seconds) |
discoveredResources |
int |
Number of discovered resources |
failedProtocols |
int |
Number of resources for which discovery failed |
noResponseIpAddresses |
int |
Number of resources for which there was no response |
skippedResources |
int |
Number of skipped resources |
denominatorForProgress |
int |
Denominator for the progress calculation |
numeratorForProgress |
int |
Numerator for the progress calculation. This is the number of IP addresses (from among the discovery targets) for which processing is complete. |
lastTime |
dateTime |
Time when the discovery status was last checked |
discoverdLogTargetIPRange |
DiscoveryLogTargetIPRange[] |
List of IP-address ranges included in the discovery results |
discoverdLogTargetIPRange (Type: DiscoveryLogTargetIPRange)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of IPAddrRange |
pagination (Type: Pagination)
Attribute |
Type |
Description |
---|---|---|
page |
integer |
page |
pageSize |
integer |
Size of the pages |
numPages |
integer |
Number of the pages |
totalCount |
integer |
Number of the objects |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
401 |
Unauthorized |
No login privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] GET http://localhost:22015/Analytics/v1/objects/DiscoveryLogs/ HTTP/1.1 Host: localhost:22015 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= [Response Header] HTTP/1.1 200 OK Date: Mon, 25 May 2020 02:37:51 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO eed864e1af108faf58e4f486be419a1f45fca74_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Keep-Alive: timeout=5, max=100 Connection: Keep-Alive Content-Type: application/json Content-Length: 816 [Response Body] { "data" : [ { "status" : "Canceled", "autoManage" : true, "startTime" : "2020-05-25T10:41:56.389+09:00", "completionTime" : "2020-05-25T10:42:03.365+09:00", "elapsedTime" : 6, "discoveredResources" : 0, "failedProtocols" : 0, "noResponseIpAddresses" : 0, "skippedResources" : 1, "denominatorForProgress" : 100, "numeratorForProgress" : 12, "nextDiscoveryTime" : "2000-01-01T09:00:00.000+09:00", "lastTime" : "2020-05-25T11:37:51.529+09:00", "discoverdLogTargetIPRange" : [ { "name" : "192.168.11.1" }, { "name" : "test.com" }, { "name" : "test" } ] } ], "count" : 1 }