Querying Time Series Data
Function
This API is used to query time series data within a specified period. You can specify a dimension or period to query.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/samples
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fill_value |
No |
String |
Value filled for breakpoints in time series data. Default value: –1. –1: Breakpoints are filled with –1. 0: Breakpoints are filled with 0. null: Breakpoints are filled with null. average: Breakpoints are filled with the average value of the adjacent valid data. If there is no valid data, breakpoints are filled with null. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
samples |
Yes |
Array of QuerySample objects |
List of time series objects. A JSON array can contain up to 20 objects. |
statistics |
Yes |
Array of strings |
Statistic. Values: maximum, minimum, sum, average, and sampleCount. |
period |
Yes |
Integer |
Granularity for monitoring data, which is an enumerated value. Values: 60: The data monitoring granularity is 1 minute. 300: The data monitoring granularity is 5 minutes. 900: The data monitoring granularity is 15 minutes. 3600: The data monitoring granularity is 1 hour. |
time_range |
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:
Constraint: In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
namespace |
Yes |
String |
Namespace of time series objects. Value range: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, or CUSTOMMETRICS. PAAS.CONTAINER: namespace of application time series objects. PAAS.NODE: namespace of node time series objects. PAAS.SLA: namespace of SLA time series objects. PAAS.AGGR: namespace of cluster time series objects. CUSTOMMETRICS: namespace of custom time series objects. |
dimensions |
Yes |
Array of DimensionSeries objects |
List of time series dimensions.You can call the /v2/{project_id}/series API to query the time series dimension list by namespace and metric_name. |
metric_name |
Yes |
String |
Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
samples |
Array of SampleDataValue objects |
List of time series objects. |
Parameter |
Type |
Description |
---|---|---|
sample |
QuerySample object |
List of time series objects. |
data_points |
Array of MetricDataPoints objects |
Time series data. |
Parameter |
Type |
Description |
---|---|---|
namespace |
String |
Namespace of time series objects. Value range: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, or CUSTOMMETRICS. PAAS.CONTAINER: namespace of application time series objects. PAAS.NODE: namespace of node time series objects. PAAS.SLA: namespace of SLA time series objects. PAAS.AGGR: namespace of cluster time series objects. CUSTOMMETRICS: namespace of custom time series objects. |
dimensions |
Array of DimensionSeries objects |
List of time series dimensions.You can call the /v2/{project_id}/series API to query the time series dimension list by namespace and metric_name. |
metric_name |
String |
Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Dimension name. |
value |
String |
Dimension value. |
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. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
error_type |
String |
Error type. |
trace_id |
String |
Request ID. |
Example Requests
Query time series data in the last five minutes by namespace, metric_name, and dimensions.
https://{Endpoint}/v2/{project_id}/samples { "samples": [ { "namespace": "PAAS.CONTAINER", "metric_name": "aom_process_cpu_usage", "dimensions": [ { "name": "appName", "value": "aomApp" } ] } ], "period": 60, "time_range": "-1.-1.5",// Last 5 minutes "statistics": [ "sum" ] }
Example Responses
Status code: 200
OK: The request is successful.
{ "samples" : [ { "sample" : { "namespace" : "PAAS.CONTAINER", "metric_name" : "aom_process_cpu_usage", "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ] }, "data_points" : [ { "timestamp" : 1694673300000, "unit" : "Percent", "statistics" : [ { "statistic" : "sum", "value" : "23" } ] } ] } ] }
Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{ "error_code" : "AOM.04008105", "error_msg" : "Query metric data samples is invalid", "error_type" : "BAD_REQUEST", "trace_id" : "" }
SDK Sample Code
The SDK sample code is as follows.
Java
Query time series data in the last five minutes by namespace, metric_name, and dimensions.
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 |
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 ListSampleSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ListSampleRequest request = new ListSampleRequest(); request.withFillValue("<fill_value>"); QuerySampleParam body = new QuerySampleParam(); List<String> listbodyStatistics = new ArrayList<>(); listbodyStatistics.add("sum"); List<DimensionSeries> listSamplesDimensions = new ArrayList<>(); listSamplesDimensions.add( new DimensionSeries() .withName("appName") .withValue("aomApp") ); List<QuerySample> listbodySamples = new ArrayList<>(); listbodySamples.add( new QuerySample() .withNamespace("PAAS.CONTAINER") .withDimensions(listSamplesDimensions) .withMetricName("aom_process_cpu_usage") ); body.withTimeRange("-1.-1.5"); body.withPeriod(60); body.withStatistics(listbodyStatistics); body.withSamples(listbodySamples); request.withBody(body); try { ListSampleResponse response = client.listSample(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 time series data in the last five minutes by namespace, metric_name, and dimensions.
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSampleRequest() request.fill_value = "<fill_value>" listStatisticsbody = [ "sum" ] listDimensionsSamples = [ DimensionSeries( name="appName", value="aomApp" ) ] listSamplesbody = [ QuerySample( namespace="PAAS.CONTAINER", dimensions=listDimensionsSamples, metric_name="aom_process_cpu_usage" ) ] request.body = QuerySampleParam( time_range="-1.-1.5", period=60, statistics=listStatisticsbody, samples=listSamplesbody ) response = client.list_sample(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 time series data in the last five minutes by namespace, metric_name, and dimensions.
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSampleRequest{} fillValueRequest:= "<fill_value>" request.FillValue = &fillValueRequest var listStatisticsbody = []string{ "sum", } nameDimensions:= "appName" valueDimensions:= "aomApp" var listDimensionsSamples = []model.DimensionSeries{ { Name: &nameDimensions, Value: &valueDimensions, }, } var listSamplesbody = []model.QuerySample{ { Namespace: "PAAS.CONTAINER", Dimensions: listDimensionsSamples, MetricName: "aom_process_cpu_usage", }, } request.Body = &model.QuerySampleParam{ TimeRange: "-1.-1.5", Period: int32(60), Statistics: listStatisticsbody, Samples: listSamplesbody, } response, err := client.ListSample(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