Preparing to assign resources

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

The following operation is the initial step to assign unassigned resources.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/services/AutoAssignFilters/actions/assignmentResource

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

AssignmentResourceParam

{
        "filterType":"...",
        "resourceType":"...",
        "profileResourceType":["...", ...],
        "assignmentAllResource":"...",
        "resourceIDList":["...", ...],
        "filterIDList":["...", ...],
        "includeAwaitingAssignmentResources":"...",
        "disableDiscoveredTimeCheck":"..."
}

AssignmentResourceParam (Type: AssignmentResourceParam)

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.)
assignmentAllResource	boolean	Whether or not to assign the consumer or threshold profile to all unassigned resources. If "true" is specified, the consumer or threshold profile is assigned to all unassigned resources. If "false" is specified, the consumer or threshold profile is assigned to the resources with the IDs specified in resourceIDList.
resourceIDList	string[]	ID of the assignment-target resource. This item is used only if assignmentAllResource is "false".
filterIDList	string[]	ID of the rule to be used for assignment. If an empty list is specified, all rules will be used.
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.
disableDiscoveredTimeCheck	boolean	Value that specifies whether to check, during the assignment of unassigned resources, whether data collection has finished. If "True" is specified, resources will be assigned without performing this check. If "False" is specified, this check will be performed. When the check is performed, if a corresponding resource already exists, the assignment of unassigned resources fails.

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
http://10.197.198.241:22015/Analytics/v1/services/AutoAssignFilters/actions/assignmentResource
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:39 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" : "assignmentResource",
  "href" : "http://localhost:22015/Analytics/v1/services/AutoAssignFilters/actions/assignmentResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "filterType" : "Group",
    "resourceType" : "Host",
    "assignmentAllResource" : false,
    "resourceIDList" : [ ]
  } ]
}