Getting a list 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 obtain a list of automatic resource assignment rules.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/AutoAssignFilters

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of AutoAssignFilter objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

AutoAssignFilter

{
        "instanceID":"...",
        "filterName":"...",
        "filterType":"...",
        "resourceType":"...",
        "priority":"...",
        "description":"...",
        "groupID":"...",
        "groupName":"...",
        "userResourceThresholdID":"...",
        "userResourceThresholdName":"...",
        "profileResourceType":"..."
}

AutoAssignFilter (Type: AutoAssignFilter)

Attribute	Type	Description
instanceID	string	ID of the assignment rule
filterName	string	Name of the assignment rule
filterType	enum	Type of the assignment rule (For details about the valid values, see the table FilterType in List of enumerators.) UserResourceThreshold Group
resourceType	enum	Type of resources 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
priority	int	Priority of the assignment rule
description	string	Description of the assignment rule
groupID	string	ID of the assignment-destination consumer. This item is set only if the rule type is "Group".
groupName	string	Name of the assignment-destination consumer. This item is set only if the rule type is "Group".
userResourceThresholdID	string	ID of the threshold profile to be assigned to the resource. This item is set only if the rule type is "UserResourceThreshold".
userResourceThresholdName	string	Name of the threshold profile to be assigned to the resource. This item is set only if the rule type is "UserResourceThreshold".
profileResourceType	enum	Resource type of threshold profile. (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
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]
GET /Analytics/v1/objects/AutoAssignFilters
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 12 Aug 2016 11:17:00 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 30f198fbc8b17b25ed2d623b761929ba5a56df2_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]
{
  "data" : [ {
    "instanceID" : "autoAssignFilter#86f40c58-4000-429d-a50c-d1acf7be73e5",
    "filterName" : "filterName-20160812201659091",
    "filterType" : "Group",
    "resourceType" : "VM",
    "priority" : 1,
    "description" : "Description 7 Consumer - Host",
    "groupID" : "group#d4b70260-a0d0-4961-9765-6f06b437163a",
    "groupName" : "GroupForAutoAssignFilterGetTest",
    "profileResourceType" : "INVALID_MEMBER"
  } ],
  "count" : 1