Changing the priority of automatic resource assignment rules

Ops Center Analyzer REST API Reference Guide

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

You can change the priority of a specific automatic resource assignment rule.

Execution permission

Admin, Modify

Request line

POST baseURL/v1/services/AutoAssignFilters/actions/changeFilterPriority/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 ChangePriorityFilterParam objects necessary to execute an operation. For details, see the table below.

ChangePriorityFilterParam

{
        "filterType":"...",
        "resourceType":"...",
        "profileResourceType":["...", ...],
        "filterIDList":["...", ...]
}

ChangePriorityFilterParam (Type: ChangePriorityFilterParam)

Attribute

Type

Description

filterType

enum

Type of assignment rule

(For details about the valid values, see the table FilterType in List of enumerators.)

  • UserResourceThreshold
  • Group

resourceType

enum

Type of resource to which the assignment rule is to be applied

(For details about the valid values, see the table FilterResourceType in List of enumerators.)

  • VM
  • Volume
  • Host

profileResourceType

enum[]

Resource type of threshold profile

(For details about the valid values, see the table PerformanceResourceType in List of enumerators.)

filterIDList

string[]

ID of the assignment rule

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 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]
POST /Analytics/v1/services/AutoAssignFilters/actions/changeFilterPriority/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
    "name": "changeFilterPriority",
    "href": "http://localhost:22015/Analytics/v1/services/AutoAssignFilters/actions/changeFilterPriority/invoke",
    "method": "POST",
    "type": "application/json",
    "parameters": [
        {
            "filterType": "UserResourceThreshold",
            "resourceType": "VM",
            "profileResourceType": [
                "ESX_VM"
            ],
            "filterIDList": [
                "autoAssignFilter#4372943b-d86f-4346-8054-b85c0d3659c4"
            ]
        }
    ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 03:57:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f0751c34edbce22432793e8c64f16c2ea125e88_Y2UOI2pkMXQ=_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": "338977ac-5a39-45ad-8e25-d2c554c5006d",
    "created": "2016-08-22T12:57:59.444+09:00",
    "updated": "2016-08-22T12:57:59.444+09:00",
    "completed": "2016-08-22T12:57:59.444+09:00",
    "state": "success",
    "affectedResource": [
        
    ],
    "result": [
        
    ]
}