2.4.2 Obtaining the Information Necessary To Run a Discovery

This API request acquires the information necessary to run a discovery.

Execution permission

Admin

API version

Request format

GET http[s]://host:port/Analytics/version/services/Discoveries/actions/submit

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "autoManage":"...",
            "ipAddrRangeID":["...", ...]
        },
        :
        ]
}

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	DiscoveryParam[]	A list of DiscoveryParam objects necessary to execute an operation. For details about DiscoveryParam, see the table below.

parameters (Type: DiscoveryParam)

Attribute	Type	Description
autoManage	boolean	To automatically manage discovered resources, set true.
ipAddrRangeID	long[]	List of instance IDs in the IP address range used for discovery

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference 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/services/Discoveries/actions/submit/ 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:47:16 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ffcce126318d18ca63c8fd870a3bbbde84ca57b_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 274

[Response Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "autoManage" : true,
    "ipAddrRangeID" : [ 3, 2, 1, 4, 5, 50 ]
  } ]
}