Assigning a specific consumer

Ops Center Analyzer REST API Reference Guide

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

You can assign a specific consumer to resources to be monitored.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/objects/Groups/{id}/actions/updateTargetResource/invoke

Request body

The structure of the request body and the object attributes are 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 UpdateTargetResourceParam objects necessary to execute an operation. For details, see the table below.

UpdateTargetResourceParam

{
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "resourceIDs":["...", ...]
}

UpdateTargetResourceParam (Type: UpdateTargetResourceParam)

Attribute

Type

Description

volumeIDs

string[]

ID of the volume

vmIDs

string[]

ID of the virtual machine

resourceIDs

string[]

ID of the host

Response body

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

ID of the Instance.

created

string

Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

updated

string

Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

completed

string

Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

state

string

One of the following values is set:

"failed": The operation failed.

"success": The operation completed successfully.

affectedResource

string[]

A blank space is set.

result

anyType[]

A list of objects. No value is set.

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 fournd.

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]
POST /Analytics/v1/objects/Groups/group%23fd830c03-a08a-4a96-aed9-55024c4f678a/actions/updateTargetResource/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/Groups/group%23a6c24393%2d07c9%2d4465%2dba3f%2ddc33b9583d74/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs":["raidLdev#410025-00^03^3F"],
    "vmIDs" : [],
    "resourceIDs" : []
  } ]
}


[Response Header]
HTTP/1.1 200 OK
Date: Wed, 03 Aug 2016 02:00:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a61560c2eac97b0564aec48d2883daf39c0dfdf_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_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]
{
  "instanceID" : "b194ea16-2cce-4dee-bf0b-d77b57160620",
  "created" : "2016-08-03T11:00:50.143+09:00",
  "updated" : "2016-08-03T11:00:50.143+09:00",
  "completed" : "2016-08-03T11:00:50.143+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}