Preparing to set dynamic thresholds with profiles and resources specified

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 set dynamic thresholds by specifying user profiles and resources.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/ThresholdProfiles/{id}/actions/updateDynamicThreshold

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

ResourceThresholdFixedParam

{
        "metricType":"...",
        "resourceID":"...",
        "resourceType":"...",
        "planID":"...",
        "fixed":"...",
        "value":"..."
}

ResourceThresholdFixedParam (Type: ResourceThresholdFixedParam)

Attribute	Type	Description
metricType	enum	Type of the metric (For details about the valid values, see the table MetricType in List of enumerators.)
resourceID	string	ID of the resource
resourceType	enum	Type of the resource (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
planID	string	ID of the plan
fixed	boolean	Whether or not to recalculate the thresholds periodically. If the thresholds are recalculated periodically, "true" is set. If the thresholds are not recalculated periodically, "false" is set. This item is specified if the thresholds are to be manipulated for each component.
value	float	Value of threshold to be set

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.

Example code

[Request Header]
GET /Analytics/v1/objects/ThresholdProfiles/thProfile%23abcc9f1e-b1b8-45f4-9931-31eedd5905be/actions/updateDynamicThreshold
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 03:03:55 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_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" : "updateDynamicThreshold",
  "href" : "http://localhost:22015/Analytics/v1/objects/ThresholdProfiles/thProfile%23abcc9f1e%2db1b8%2d45f4%2d9931%2d31eedd5905be/actions/updateDynamicThreshold/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : "",
    "metricType" : "WIN_CPU_LOAD",
    "resourceID" : "",
    "resourceType" : "INVALID_MEMBER",
    "planID" : "",
    "fixed" : false,
    "value" : 0.0
  } ]
}