Getting a list of threshold profiles

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of information about threshold profiles, such as the profile names and thresholds.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/ThresholdProfiles

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

ThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "profileResourceType":"...",
        "representativeProfileId":"...",
        "isRepresentativeProfile":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "metricTypeName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfCritical":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "margin":"...",
        "marginName":"...",
        "plans":[{
            "instanceID":"...",
            "planType":"...",
            "planName":"...",
            "schedule":["...", ...],
            "from":"...",
            "to":"...",
            "priority":"...",
            "description":"...",
            "thresholdValues":[{
                "instanceID":"...",
                "monitoringMode":"...",
                "metricType":"...",
                "metricTypeName":"...",
                "unit":"...",
                "proportion":"...",
                "thresholdValueOfWarning":"...",
                "thresholdValueOfCritical":"...",
                "stepSize":"...",
                "max":"...",
                "min":"...",
                "maxValueOfDynamic":"...",
                "minValueOfDynamic":"...",
                "avgValueOfDynamic":"..."
            },
            :
            ],
            "monitoringMode":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfCritical":"...",
            "fixed":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

ThresholdProfile (Type: ThresholdProfile)

Attribute	Type	Description
instanceID	string	ID of the threshold profile
profileName	string	Name of the threshold profile
description	string	Description
resourceType	enum	Type of the threshold profile (For details about the valid values, see the table PerfThresholdResourceType in List of enumerators.) User System Reserve
profileType	enum	Type determining whether the threshold profile can be edited. The threshold profile can be edited only if the type is "User" or "Default". (For details about the valid values, see the table TemplateCreatorType in List of enumerators.) User Preset Default
profileResourceType	enum	Resource type of the threshold profile (For details about the valid values, see the table PerformanceResourceType in List of enumerators.)
representativeProfileId	string	The Signature of the representative profile among the split profiles.
isRepresentativeProfile	boolean	Flag whether the profile is representative or not
thresholdValues	ThresholdValue[]	Information about the thresholds set in the threshold profile. This item is specified only for the thresholds for system resources.
margin	string	ID of the margin set in the threshold profile. This item is specified only for the thresholds for user resources.
marginName	string	Display name of the margin set in the threshold profile. This item is specified only for the thresholds for user resources.
plans	ThresholdPlan[]	Information about the plans set in the threshold profile. This item is specified only for the thresholds for user resources.
numOfResources	int	Number of resources to which the threshold profile is assigned
autoAssignFilters	string[]	Rules of automatic assignment to the resources set in the threshold profile. This item is specified only for the thresholds for user resources.

thresholdValues (Type: ThresholdValue)

Attribute	Type	Description
instanceID	string	ID of the threshold
monitoring	boolean	Whether or not to enable threshold-based monitoring. If enabled, "true" is set. If disabled, "false" is set.
metricType	enum	Type of the metric set for a threshold (For details about the valid values, see the table MetricType in List of enumerators.)
metricTypeName	string	Name of the metric set for a threshold
unit	string	Unit of the metric set for a threshold
proportion	boolean	Threshold setting. If a warning or critical alert is generated when the measurement value goes above the threshold, "true" is set. If a warning or critical alert is generated when the measurement value goes below the threshold, "false" is set.
thresholdValueOfWarning	float	Value of the warning threshold
thresholdValueOfCritical	float	Value of the critical threshold
stepSize	float	Increment of the threshold
max	float	Maximum value of the threshold
min	float	Minimum value of the threshold

plans (Type: ThresholdPlan)

Attribute	Type	Description
instanceID	string	ID of the plan.
planType	enum	Type of the plan. (For details about the valid values, see the table PlanType in List of enumerators.) Base Schedule
planName	string	Name of the plan.
schedule	integer[]	Day of the week when to apply the plan. 1: Mon., 2: Tue., 3: Wed., 4: Thu., 5: Fri., 6: Sat., and 7: Sun. The value set here takes effect only if the plan type is "Schedule".
from	string	Start time of the plan. Specified in "hh:mm" format. The value set here takes effect only if the plan type is "Schedule".
to	string	End time of the plan. Specified in "hh:mm" format. The value set here takes effect only if the plan type is "Schedule".
priority	int	Priority of the plan.
description	string	Description of the plan.
thresholdValues	ThresholdPlanValue[]	Information about the thresholds specified in the plan.
monitoringMode	enum	Monitoring status of the plan. This item is specified when the thresholds are recalculated for each component. (For details about the valid values, see the table MonitoringMode in List of enumerators.)
thresholdValueOfWarning	float	Value of the warning threshold. This item is specified when the thresholds are recalculated for each component.
thresholdValueOfCritical	float	Value of the critical threshold. This item is specified when the thresholds are recalculated for each component.
fixed	boolean	Specifies 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 recalculated for each component.

thresholdValues (Type: ThresholdPlanValue)

Attribute	Type	Description
instanceID	string	ID of the thresholds for each plan.
monitoringMode	enum	Specifies whether or not to enable threshold-based monitoring. If enabled, "true" is set. If disabled, "false" is set. (For details about the valid values, see the table MonitoringMode in List of enumerators.)
metricType	enum	ID of the metric set for a threshold. (For details about the valid values, see the table MetricType in List of enumerators.)
metricTypeName	string	Name of the metric set for a threshold.
unit	string	Unit of the metric set for a threshold.
proportion	boolean	Threshold setting. If a warning or critical alert is generated when the measurement value goes above the threshold, "true" is set. If a warning or critical alert is generated when the measurement value goes below the threshold, "false" is set.
thresholdValueOfWarning	float	Value of the warning threshold.
thresholdValueOfCritical	float	Value of the critical threshold.
stepSize	float	Increment of the threshold.
max	float	Maximum value of the threshold.
min	float	Minimum value of the threshold.
maxValueOfDynamic	float	Maximum value of the dynamic threshold.
minValueOfDynamic	float	Minimum value of the dynamic threshold.
avgValueOfDynamic	float	Average value of a dynamic threshold.

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/ThresholdProfiles
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 02:12:10 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]
{
  "data" : [ {
    "instanceID" : "thProfile#RAID_STORAGE_PRESET",
    "profileName" : "#Preset Profile for Storage",
    "description" : "#Preset Profile for Storage",
    "resourceType" : "System",
    "profileType" : "Preset",
    "profileResourceType" : "RAID_STORAGE",
    "thresholdValues" : [ {
      "instanceID" : "th#RAID_STORAGE_RAIDPORT_TOTALIOPS_PRESET",
      "monitoring" : false,
      "metricType" : "RAID_STORAGE_RAIDPORT_TOTALIOPS",
      "metricTypeName" : "Total IOPS (Port)",
      "unit" : "Ops",
      "proportion" : false,
      "thresholdValueOfWarning" : 0.0,
      "thresholdValueOfCritical" : 0.0,
      "stepSize" : 1.0,
      "max" : 3.4028235E38,
      "min" : 0.0
    }, {
    ........
    } ],
    "margin" : "Normal",
    "marginName" : "Normal",
    "numOfResources" : 0,
    "autoAssignFilters" : [ ]
  }, {
  ........
  } ],
  "count" : 26
}