Obtaining the RAID Agent list parameter when the manual refresh process is executed

Ops Center Analyzer REST API Reference Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99ANA003-18

You can obtain the parameter that is necessary for executing the manual refresh process for the RAID Agent list.

For an action provided by the Ops Center Analyzer API, this API function returns (to the API client) the Action object whose default value has been specified in the parameters field. This Action object can be used, without change, as an argument of the API described in Manually refreshing the RAID Agent list.

HTTP request syntax (URI)

GET <scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions/refresh

Request structure

Not applicable.

Response structure

The configuration of the response body is as follows:

{
    "name":"RefreshAgentInstancesParameters",
    "url":"<scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions/refresh/invoke",
    "method":"POST",
    "type":"application/json",
    "parameters":[{"type":"string","value":"All"}]
}

Example (obtaining the RAID Agent list parameter when the manual refresh process is executed)

Request message by using the curl command

curl -v -H "Content-Type: application/json" -u system:manager -X GET https://server_1:22016/Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh

Execution result for the request:

Request header

GET /Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (i386-redhat-linux-gnu) libcurl/7.19.7
NSS/3.12.9.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2
Host: server_1:22016
Accept: */*
Content-Type: application/json

Response header

HTTP/1.1 200 OK
Date: Thu, 19 Jun 2014 04:53:01 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json;charset=utf-8

Response body

{
    "name":"RefreshAgentInstancesParameters",
    "url":"https://server_1:22016/Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh/invoke",
    "method":"POST",
    "type":"application/json",
    "parameters":[{"type":"string","value":"All"}]
}