Preparing to update a condition information for automatic resource assignment rules

Ops Center Analyzer REST API Reference Guide

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

The following operation is the initial step to modify a condition of a specific automatic resource assignment rule.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/AutoAssignFilters/{id}/actions/updateFilterCondition

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 UpdateFilterConditionParam objects necessary to execute an operation. For details, see the table below.

UpdateFilterConditionParam

{
        "filterType":"...",
        "resourceType":"...",
        "filterConditions":[{
            "displayOrder":"...",
            "attributeType":"...",
            "conditionType":"...",
            "osType":"...",
            "storageSystems":[{
                "storageSystemID":"...",
                "storageSystemName":"...",
                "poolID":"...",
                "poolName":"..."
            },
            :
            ],
            "filterString":"...",
            "storageSystemModelName":"..."
        },
        :
        ]
}

UpdateFilterConditionParam (Type: UpdateFilterConditionParam)

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 to be updated is to be applied

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

  • VM
  • Volume
  • Host

filterConditions

FilterCondition[]

List of assignment rules to be set

filterConditions (Type: FilterCondition)

Attribute

Type

Description

displayOrder

int

Priority of the assignment rule

attributeType

enum

Attribute of the assignment rule

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

  • VMName
  • ClusterName
  • OSType
  • HostName
  • ConsumerName
  • Label
  • Pools
  • StorageSystems
  • Model
  • HostGroup
  • ConsumerNameOfRelatedResources
  • LUNOwnerName

conditionType

enum

Type of the condition for the assignment rule

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

  • Equals
  • Start_With
  • End_With
  • Contains
  • NotEquals
  • In
  • NotIn

osType

enum

OS type to be specified as an assignment rule value. This item is set only if the attribute of the assignment rule is "OSType".

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

  • Linux
  • Windows

storageSystems

FilterConditionStorageSystem[]

Storage assignment rule. This item is set only if the attribute of the assignment rule is "StorageSystems" or "Pools".

filterString

string

Value of the assignment rule. This item is not set if the attribute of the assignment rule is "OSType", "StorageSystems", or "Pools".

storageSystemModelName

string

Name of the storage system. This item is set only if the attribute of the assignment rule is "Model".

storageSystems (Type: FilterConditionStorageSystem)

Attribute

Type

Description

storageSystemID

string

ID of the storage system

storageSystemName

string

Name of the storage system

poolID

string

ID of the pool

poolName

string

Name of the pool

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login 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]
GET /Analytics/v1/objects/AutoAssignFilters/autoAssignFilter%23ab2c3eba-cc85-4a2a-b16e-2d73da986095/actions/updateFilterCondition
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:52:31 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_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]
{
  "name" : "updateFilterCondition",
  "href" : "http://localhost:22015/Analytics/v1/objects/AutoAssignFilters/autoAssignFilter%23ab2c3eba%2dcc85%2d4a2a%2db16e%2d2d73da986095/actions/updateFilterCondition/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "filterType" : "Group",
    "resourceType" : "Host",
    "filterConditions" : [ ]
  } ]
}