Querying Monitoring Data
Function
This API is used to query monitoring data of metrics within a specified period. You can specify a dimension or period to query. (This API will not evolve. You are advised to use Querying Expression Calculation Results in a Specified Period Using the POST Method.)
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/ams/metricdata
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details, see Obtaining a Token. |
Content-Type |
Yes |
String |
Message body type or format. Content type, which is application/json. Enumeration values: |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
metrics |
Yes |
Array of MetricQueryMeritcParam objects |
Metric list. A JSON array can contain up to 20 objects. |
period |
Yes |
Integer |
Monitoring data granularity. Options: |
statistics |
Yes |
Array of strings |
Statistic. Values: maximum, minimum, sum, average, and sampleCount. |
timerange |
Yes |
String |
Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period. Example:
Format: startTimeInMillis.endTimeInMillis.durationInMinutes Parameter description:
For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.
For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.
If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes × 60 × 1000. For example, -1.-1.60 indicates the latest 60 minutes. Constraint: In a single request, the following condition must be met: durationInMinutes × 60/period ≤ 1,440 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dimensions |
Yes |
Array of Dimension objects |
List of time series dimensions. To query the time series dimension list, call the API Querying Time Series Objects. Neither the array nor the name/value of any dimension in the array can be left blank. |
metricName |
Yes |
String |
Metric name. Length: 1 to 255 characters. Options: basic metrics (such as cpuUsage and cpuCoreUsed) provided by AOM, and custom metrics. To query metrics, call the API Querying Tag Values. |
namespace |
Yes |
String |
Metric namespace. Options:
Custom namespaces are also supported. To query namespaces, call the API Querying Tag Values. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
errorCode |
String |
Response code. |
errorMessage |
String |
Response message. |
metrics |
Array of MetricDataValue objects |
Metric list. |
Parameter |
Type |
Description |
---|---|---|
dataPoints |
Array of MetricDataPoints objects |
Key metric. |
metric |
MetricQueryMeritcParam object |
Query parameters. |
Parameter |
Type |
Description |
---|---|---|
statistics |
Array of StatisticValue objects |
Statistic. |
timestamp |
Long |
Timestamp. |
unit |
String |
Time series unit. |
Parameter |
Type |
Description |
---|---|---|
statistic |
String |
Statistic. |
value |
Double |
Statistical result. |
Parameter |
Type |
Description |
---|---|---|
dimensions |
Array of Dimension objects |
List of time series dimensions. To query the time series dimension list, call the API Querying Time Series Objects. Neither the array nor the name/value of any dimension in the array can be left blank. |
metricName |
String |
Metric name. Length: 1 to 255 characters. Options: basic metrics (such as cpuUsage and cpuCoreUsed) provided by AOM, and custom metrics. To query metrics, call the API Querying Tag Values. |
namespace |
String |
Metric namespace. Options:
Custom namespaces are also supported. To query namespaces, call the API Querying Tag Values. |
Example Requests
Query the monitoring data of cpuUsage in the PAAS.CONTAINER namespace in the last five minutes.
https://{Endpoint}/v1/{project_id}/ams/metricdata
{
"metrics" : [ {
"dimensions" : [ {
"name" : "appName",
"value" : "aomApp"
} ],
"metricName" : "cpuUsage",
"namespace" : "PAAS.CONTAINER"
} ],
"period" : 60,
"statistics" : [ "maximum", "minimum", "sum" ],
"timerange" : "-1.-1.5"
}
Example Responses
Status code: 200
OK: The request is successful.
{
"errorCode" : "SVCSTG_AMS_2000000",
"errorMessage" : "success",
"metrics" : [ {
"metric" : {
"namespace" : "PAAS.CONTAINER",
"metricName" : "cpuUsage",
"dimensions" : [ {
"name" : "appName",
"value" : "aomApp"
} ]
},
"dataPoints" : [ {
"timestamp" : "1467892800000",
"unit" : "Percent",
"statistics" : [ {
"statistic" : "maximum",
"value" : "23"
} ]
} ]
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Java
Query the monitoring data of cpuUsage in the PAAS.CONTAINER namespace in the last five minutes.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v2.region.AomRegion;
import com.huaweicloud.sdk.aom.v2.*;
import com.huaweicloud.sdk.aom.v2.model.*;
import java.util.List;
import java.util.ArrayList;
public class ShowMetricsDataSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
AomClient client = AomClient.newBuilder()
.withCredential(auth)
.withRegion(AomRegion.valueOf("<YOUR REGION>"))
.build();
ShowMetricsDataRequest request = new ShowMetricsDataRequest();
QueryMetricDataParam body = new QueryMetricDataParam();
List<String> listbodyStatistics = new ArrayList<>();
listbodyStatistics.add("maximum");
listbodyStatistics.add("minimum");
listbodyStatistics.add("sum");
List<Dimension> listMetricsDimensions = new ArrayList<>();
listMetricsDimensions.add(
new Dimension()
.withName("appName")
.withValue("aomApp")
);
List<MetricQueryMeritcParam> listbodyMetrics = new ArrayList<>();
listbodyMetrics.add(
new MetricQueryMeritcParam()
.withDimensions(listMetricsDimensions)
.withMetricName("cpuUsage")
.withNamespace("PAAS.CONTAINER")
);
body.withTimerange("-1.-1.5");
body.withStatistics(listbodyStatistics);
body.withPeriod(60);
body.withMetrics(listbodyMetrics);
request.withBody(body);
try {
ShowMetricsDataResponse response = client.showMetricsData(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
Python
Query the monitoring data of cpuUsage in the PAAS.CONTAINER namespace in the last five minutes.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = AomClient.new_builder() \
.with_credentials(credentials) \
.with_region(AomRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowMetricsDataRequest()
listStatisticsbody = [
"maximum",
"minimum",
"sum"
]
listDimensionsMetrics = [
Dimension(
name="appName",
value="aomApp"
)
]
listMetricsbody = [
MetricQueryMeritcParam(
dimensions=listDimensionsMetrics,
metric_name="cpuUsage",
namespace="PAAS.CONTAINER"
)
]
request.body = QueryMetricDataParam(
timerange="-1.-1.5",
statistics=listStatisticsbody,
period=60,
metrics=listMetricsbody
)
response = client.show_metrics_data(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Go
Query the monitoring data of cpuUsage in the PAAS.CONTAINER namespace in the last five minutes.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := aom.NewAomClient(
aom.AomClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowMetricsDataRequest{}
var listStatisticsbody = []string{
"maximum",
"minimum",
"sum",
}
var listDimensionsMetrics = []model.Dimension{
{
Name: "appName",
Value: "aomApp",
},
}
var listMetricsbody = []model.MetricQueryMeritcParam{
{
Dimensions: listDimensionsMetrics,
MetricName: "cpuUsage",
Namespace: "PAAS.CONTAINER",
},
}
request.Body = &model.QueryMetricDataParam{
Timerange: "-1.-1.5",
Statistics: listStatisticsbody,
Period: int32(60),
Metrics: listMetricsbody,
}
response, err := client.ShowMetricsData(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
400 |
Bad Request: The request is invalid. The client should not repeat the request without modifications. |
401 |
Unauthorized: The authentication information is incorrect or invalid. |
403 |
Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications. |
500 |
Internal Server Error: The server is able to receive the request but unable to understand the request. |
503 |
Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot