The following operation is the initial step to obtain information about dynamic or static thresholds by specifying threshold profiles and resources.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/objects/ThresholdProfiles/{id}/actions/getResourceThresholdValues
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 ResourceThresholdParam objects necessary to execute an operation. For details, see the table below. |
ResourceThresholdParam
{
"metricType":"...",
"resourceType":"...",
"resourceIds":["...", ...]
}
ResourceThresholdParam (Type: ResourceThresholdParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
metricType |
enum |
ID of the metric to be obtained (For details about the valid values, see the table MetricType in List of enumerators.) |
|
resourceType |
enum |
Type of the metric to be obtained (For details about the valid values, see the table PerformanceResourceType in List of enumerators.) |
|
resourceIds |
string[] |
ID of the resource to be obtained. To obtain multiple resources at the same time, specify the IDs of those resources. |
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%23fe428a12-35a8-4210-8e9d-d0d28fe38d5d/actions/getResourceThresholdValues
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:54:28 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" : "getResourceThresholdValues",
"href" : "http://localhost:22015/Analytics/v1/objects/ThresholdProfiles/thProfile%23fe428a12%2d35a8%2d4210%2d8e9d%2dd0d28fe38d5d/actions/getResourceThresholdValues/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"instanceID" : "",
"metricType" : "WIN_CPU_LOAD",
"resourceType" : "INVALID_MEMBER",
"resourceIds" : [ ]
} ]
}