You can obtain a list of actions available in RAID Agent.
For all actions available in RAID Agent, this API function stores the Action objects for the objects with omitted parameter fields to the Collection object, and then returns the object to the API client. You can use this Collection object (list of actions) to find out what kinds of actions are available.
HTTP request syntax (URI)
GET <scheme>://<host>:<port>/<application>/<version>/services/AgentManager/actions
Request structure
Not applicable.
Response structure
The configuration of the response body is as follows:
{
"items":[{"name":"<action-name>",
"url":"<URI-of-the-action>",
"method":"<HTTP-method-used-to-execute-the-action>",
"type":"<media-type-specified-in-the-Content-Type-header-of-the-request-to-execute-the-action>"
}]
}
The following table describes the format of the data included in the response body.
|
Object name |
Number of instances |
Description |
|
|---|---|---|---|
|
Collection |
1 |
The Collection object that is the parent object of Action objects |
|
|
－ |
Action |
0 to n |
Action objects (without the parameters variables) |
Example (obtaining RAID Agent administrative actions)
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
Execution result for the request:
Request header
GET /Analytics/RAIDAgent/v1/services/AgentManager/actions 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:52:26 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json;charset=utf-8
Response body
{
"items":[{"name":"RefreshAgentInstancesParameters",
"url":"https://server_1:22016/Analytics/RAIDAgent/v1/services/AgentManager/actions/refresh/invoke",
"method":"POST",
"type":"application/json"
}]
}