2.9.1 Obtaining System Profile List

This API acquires a list of system profiles.

Execution permission

Admin, Modify

API version

Request format

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles

Request body

Not applicable.

Response body

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

{
        "data":[{
            "instanceID":"...",
            "profileName":"...",
            "description":"...",
            "resourceType":"...",
            "profileType":"...",
            "thresholdValues":[{
                "instanceID":"...",
                "monitoring":"...",
                "metricType":"...",
                "pluginMetricType":"...",
                "displayName":"...",
                "unit":"...",
                "proportion":"...",
                "thresholdValueOfWarning":"...",
                "thresholdValueOfError":"...",
                "stepSize":"...",
                "max":"...",
                "min":"..."
            },
            :
            ],
            "numOfResources":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	SystemThresholdProfile[]	A list of SystemThresholdProfile objects. For details about SystemThresholdProfile, 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.

data (Type: SystemThresholdProfile)

Attribute	Type	Description
instanceID	long	ID for identifying instances
profileName	string	System profile name. Use 128 or fewer characters.
description	string	Description of the system profile. Use 256 or fewer characters.
resourceType	string	Resource type to which the system profile can be applied. The following value can be specified. ・ESX: ESX ・HYPERV: Hyper-V ・IPSWITCH: IP Switch ・FCSWITCH: FC Switch ・CLUSTER: Clutser
profileType	string	Change type of the system profile. ・User: Profile is created by a user ・Default: Profile is registered by default ・Preset: Profile for which the initial settings are set
thresholdValues	SystemThresholdValue[]	Details of the threshold set in the system profile.
numOfResources	int	Number of resources to which the system profile is assigned

thresholdValues (Type: SystemThresholdValue)

Attribute	Type	Description
instanceID	long	ID for identifying instances
monitoring	boolean	Whether the threshold is monitored. ・true: Threshold is monitored ・false: Threshold is not monitored If this member is omitted, false is set.
metricType	string	Identifier of the threshold. This member is not supported.
pluginMetricType	string	Type of the metric set for a threshold (Plug-in)
displayName	string	Display name of the threshold.
unit	string	String indicating the unit of the threshold.
proportion	boolean	Direction of the threshold. ・true: When the measured value falls below the threshold, an error or warning occurs. ・false: When the measured value exceeds the threshold, an error or warning occurs.
thresholdValueOfWarning	float	Threshold for displaying warnings. You need to specify this threshold according to the following conditions: ・Multiple of stepSize ・Less than or equal to max ・Greater than or equal to min If the specified value is not allowed, the value is adjusted automatically.
thresholdValueOfError	float	Threshold for displaying errors. You need to specify this threshold according to the following conditions: ・Multiple of stepSize ・Less than or equal to max ・Greater than or equal to min If the specified value is not allowed, the value is adjusted automatically.
stepSize	float	Increment for the threshold
max	double	Maximum value that can be specified for the threshold
min	double	Minimum value that can be specified for the threshold

pagination (Type: Pagination)

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

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	A query parameter is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d4ca28827d6fe35b964eeece674e3fbda29b5a11_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 23,
    "profileName" : "Default Profile for Hyper-V",
    "description" : "Default Profile for Hyper-V",
    "resourceType" : "HYPERV",
    "profileType" : "Default",
    "thresholdValues" : [ {
      "instanceID" : 539,
      "monitoring" : true,
      "metricType" : "WIN_CPU_LOAD",
      "displayName" : "CPU Use",
      "unit" : "%",
      "proportion" : false,
      "thresholdValueOfWarning" : 80.0,
      "thresholdValueOfError" : 90.0,
      "stepSize" : 1.0,
      "max" : 100.0,
      "min" : 0.0
    }, {
      ..........
    },
    ..........
  ],
  "numOfResources" : 0,
  "originalThresholdProfileID" : 23
}
  "count" : 8
}