Getting the results of automatic virtual machine distribution

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a preview of the results of assigning virtual machines according to automatic resource assignment rules.

Execution permission

Admin, Modify

Request line

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

AssignPreviewParam

{
        "profileID":"...",
        "type":"...",
        "autoAssignFilterIDs":["...", ...],
        "filterConditions":[{
            "displayOrder":"...",
            "attributeType":"...",
            "conditionType":"...",
            "osType":"...",
            "storageSystems":[{
                "storageSystemID":"...",
                "storageSystemName":"...",
                "poolID":"...",
                "poolName":"..."
            },
            :
            ],
            "filterString":"..."
        },
        :
        ],
        "profileResourceType":["...", ...],
        "hqlFilter":"...",
        "hqlSort":"...",
        "page":"...",
        "pageSize":"...",
        "includeAwaitingAssignmentResources":"..."
}

AssignPreviewParam (Type: AssignPreviewParam)

Attribute	Type	Description
profileID	string	ID of the profile
type	string	Filter type ("in" or "notIn")
autoAssignFilterIDs	string[]	ID of the assignment rule
filterConditions	FilterCondition[]	Condition for the assignment rule
profileResourceType	enum[]	Resource type of threshold profile (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
hqlFilter	string	Filter information
hqlSort	string	Sort information
page	integer	Pages obtained
pageSize	integer	Size of the page
includeAwaitingAssignmentResources	boolean	Value that specifies whether resources waiting to be assigned are to be included in the assignment target. If "True" is specified, the resources will be included in the assignment target. If "False" is specified, the resources will not be included in the assignment target.

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

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

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/previewVirtualMachine/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name": "previewVirtualMachine",
  "href": "http://localhost:22015/Analytics/v1/services/AutoAssignFilters/actions/previewVirtualMachine/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters":[{
    "profileID":["thProfile#ESX_VM"],
    "type":"in",
    "autoAssignFilterIDs":["autoAssignFilter#24fa3245-f476-4011-9184-da2cae1c39ab"],
    "filterConditions":[]
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:52:58 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]
{
  "instanceID" : "e9db1581-ad72-4d72-b434-e48748f58494",
  "created" : "2016-08-12T02:52:59.159+09:00",
  "updated" : "2016-08-12T02:52:59.159+09:00",
  "completed" : "2016-08-12T02:52:59.159+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : [ ],
    "count" : 0
  } ]
}