You can get information that needs to be specified in a request to get details about an Ops Center Automator service that is executable by the execute action function.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/services/CustomAction/actions/getResourcesAutomationDirectorServiceActionTemplateDetail
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of GetResourcesAutomationDirectorServiceActionTemplateDetailParam objects necessary to execute an operation. For details, see the table below. |
GetResourcesAutomationDirectorServiceActionTemplateDetailParam
{
"resourceIDs":["...", ...],
"serviceGroupName":"...",
"serviceName":"..."
}
GetResourcesAutomationDirectorServiceActionTemplateDetailParam (Type: GetResourcesAutomationDirectorServiceActionTemplateDetailParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
resourceIDs |
string[] |
A list of IDs for the components and devices for which an action is to be executed |
|
serviceGroupName |
string |
The name of an Ops Center Automator service group |
|
serviceName |
string |
The name of an Ops Center Automator service |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
400 |
Bad Request |
The format of the request body is invalid. |
|
401 |
Unauthorized |
No login privilege. |
|
403 |
Forbidden |
No update privilege. |
|
404 |
Not Found |
The resource was not found. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
|
503 |
Service Unavailable |
Analyzer detail view server communication error. |
Example code
[Request Header]
GET /Analytics/v1/services/CustomAction/actions/getResourcesAutomationDirectorServiceActionTemplateDetail
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Fri, 25 Aug 2017 11:07:39 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 384d86cd8397edfd44e093e28ff2dcf1b563e471_UQV8dA9cIGw=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"name": "getResourcesAutomationDirectorServiceActionTemplateDetail",
"href": "http://localhost:22015/Analytics/v1/services/CustomAction/actions/getResourcesAutomationDirectorServiceActionTemplateDetail/invoke",
"method": "POST",
"type": "application/json",
"parameters": [
{
"instanceID": 0,
"resourceIDs": [
"ResourceID 0",
"ResourceID 1"
],
"serviceGroupName": "A Service Group Name",
"serviceName": "A Service Name"
}
]
}