Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.9.8 Allocating System Profile

This API assigns the specified system profile to monitoring targets.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke

Request body

The structure of the request body and the object attributes are as follows:
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "instanceID":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

InstanceID[]

A list of InstanceID objects necessary to execute an operation. For details about InstanceID, see the table below.

parameters (Type: InstanceID)

Attribute

Type

Description

instanceID

long

InstanceID

Response body

The structure of the response body and the object attributes are as follows:
{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of 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.

Example code

[Request Header]
POST /Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 251


[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 4
  } ]
}


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:11:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2cf2b949bc23ff176de6c674e95e8d7b2cb3148_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : "2d8efa39-3ce7-475e-a0a3-7e16504edb97",
  "created" : "2015-11-27T18:11:06.459+09:00",
  "updated" : "2015-11-27T18:11:06.525+09:00",
  "completed" : "2015-11-27T18:11:06.526+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}