Use this function to manually refresh the RAID Agent list.
When you change any configuration settings in RAID Agent such as monitored storage systems or instance information, you must manually refresh the list information in RAID Agent before acquiring performance data.
HTTP request syntax (URI)
POST <scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions/refresh/invoke
Request structure
The configuration of the request body is as follows:
{
"name" : "RefreshAgentInstancesParameters",
"url" : "<scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions/refresh/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ { ... } ]
}
The following table shows the values that can be specified in parameters.
|
Variable name |
Value |
Number of arguments |
Description |
|
|---|---|---|---|---|
|
parameters |
type |
string: Indicates the variable type. |
1 |
If more than two arguments are specified, the arguments after the first argument are ignored. |
|
value |
Specify either "All" or "AgentForRAID". |
|||
Response structure
The configuration of the response body is as follows:
{"status":"Completed"}
When the update processing completes normally, the response body includes the Job objects indicated in the following table. If an error occurs, the response body might include the Job object or the Error object, depending on the cause of the error. The response body object can be determined from the status code.
|
Variable name |
Type |
Description |
|---|---|---|
|
status |
string |
The status indicating the result of processing. If the processing is completed normally, Completed is set. If an error occurs, Error is set. |
|
errorID |
string |
The information that uniquely identifies the error that occurred. If an error occurs, the same string as the error ID output to the log is set. This variable is not added if processing ends normally. |
|
errorDescription |
string |
An explanation of the error that occurred. If an error occurs, the same string that is output to the log is set. This variable is not added if processing ends normally. |
Example (manually refreshing the RAID Agent list)
Request message by using the curl command
curl -v -u system:manager -H "Content-Type: application/json" -H "Content-Length: *" -H "Transfer-Encoding: chunked" -X
POST https://server_1:22016/Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh/invoke -d
'{ "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" } ] }'
Execution result for the request:
Request header
POST /Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh/invoke 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 Content-Length: * Transfer-Encoding: chunked
Response header
HTTP/1.1 200 OK Date: Fri, 20 Jun 2014 12:32:14 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json;charset=utf-8
Response body
{"status":"Completed"}