Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.10.11 Allocating Consumers that Have a Resource Allocation Category Specified

This API allocates the specified consumer to monitoring targets based on the specified allocation category.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

The structure of the request body and the object attributes are as follows:
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumes":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "vms":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "resources":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "hypervisors":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "applications":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "pods":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "instances":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ]
        },
        :
        ]
}

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

UpdateTargetResourceWithAssignmentType[]

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

parameters (Type: UpdateTargetResourceWithAssignmentType)

Attribute

Type

Description

volumes

TargetResource[]

List of volumes to be allocated

vms

TargetResource[]

List of virtual machines to be allocated

resources

TargetResource[]

List of hosts to be allocated

hypervisors

TargetResource[]

List of hypervisors to be allocated

applications

TargetResource[]

List of applications to be allocated

pods

TargetResource[]

List of pods to be allocated

instances

TargetResource[]

List of instances to be allocated

volumes (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

vms (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

resources (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

hypervisors (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

applications (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

pods (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

instances (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

(For details about the specifiable values, see the table AssignmentType in List of enumerators.)

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 reference 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/Groups/10/actions/updateTargetResourceWithAssignmentType/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: 288


[Request Body]
"{
  ""name"": ""updateTargetResourceWithAssignmentType"",
  ""href"": ""http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke"",
  ""method"": ""POST"",
  ""type"": ""application/json"",
  ""parameters"": [
    {
      ""volumes"": [],
      ""vms"": [
        {
          ""id"": 14381,
          ""assignmentType"": ""Share""
        }
      ],
      ""resources"": [],
      ""hypervisors"": [
        {
          ""id"": 255,
          ""assignmentType"": ""NoChange""
        }
      ],
      ""applications"": [
        {
          ""id"": 205,
          ""assignmentType"": ""Occupy""
        }
      ],
      ""pods"": [
        {
          ""id"": 3001,
          ""assignmentType"": ""Occupy""
        }
      ]
    }
  ]
}"

[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 154d18c71a465150d5e228e8f16bf42c4dd280_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : "092d8a40-9bb3-4067-9d39-404c5c646101",
  "created" : "2016-11-22T11:30:45.805+09:00",
  "updated" : "2016-11-22T11:30:47.122+09:00",
  "completed" : "2016-11-22T11:30:47.122+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}