Querying Time Series Objects
Function
This API is used to query the time series objects that can be monitored in the system. You can specify a namespace, name, dimension, and resource ID (format: resType_resId). You can also specify the start position and the maximum number of returned records for a pagination query.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/series
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
String |
Maximum number of returned records. Value range: 1–1000. Default value: 1000. |
offset |
No |
String |
Start position of a pagination query. The value is a non-negative integer. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
series |
Yes |
Array of QuerySeriesOptionParam objects |
Array for querying time series objects. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
namespace |
Yes |
String |
Namespace of time series objects. Options: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, and CUSTOMMETRICS. - PAAS.CONTAINER: namespace of application time series objects.
|
metric_name |
No |
String |
Time series name. Length: 1 to 255 characters. Options: basic time series names (such as cpuUsage and cpuCoreUsed) provided by AOM, and custom time series names. To query time series names, call the API Querying Tag Values. |
dimensions |
No |
Array of DimensionSeries objects |
List of time series dimensions. To query the time series dimension list, call the API Querying Time Series Objects. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
series |
Array of SeriesQueryItemResult objects |
List of time series objects. |
meta_data |
MetaDataSeries object |
Metadata, including pagination information. |
Parameter |
Type |
Description |
---|---|---|
namespace |
String |
Namespace. |
dimensions |
Array of DimensionSeries objects |
List of time series dimensions. |
metric_name |
String |
Time series name. |
unit |
String |
Time series unit. |
dimension_value_hash |
String |
Time series hash value. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Dimension name. |
value |
String |
Dimension value. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Number of returned records. |
offset |
Integer |
Start of the next page, which is used for pagination. null: No more data. |
total |
Integer |
Total number of records. |
nextToken |
Integer |
Offset. |
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 objects by namespace and metric_name.
https://{Endpoint}/v2/{project_id}/series { "series" : [ { "namespace" : "PAAS.CONTAINER", "metric_name" : "aom_process_cpu_usage" } ] }
Example Responses
Status code: 200
OK: The request is successful.
{ "meta_data" : { "count" : 1, "offset" : null, "total" : 1, "nextToken" : 0 }, "series" : [ { "namespace" : "PAAS.CONTAINER", "metric_name" : "cpuUsage", "unit" : "Percent", "dimensions" : [ { "name" : "appName", "value" : "appValue" } ], "dimension_value_hash" : null } ] }
Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{ "error_code" : "AOM.04007101", "error_msg" : "Invalid namespace", "error_type" : "BAD_REQUEST", "trace_id" : "" }
SDK Sample Code
The SDK sample code is as follows.
Java
Query time series objects by namespace and metric_name.
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 |
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 ListSeriesSolution { 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(); ListSeriesRequest request = new ListSeriesRequest(); SeriesAPIQueryItemParam body = new SeriesAPIQueryItemParam(); List<QuerySeriesOptionParam> listbodySeries = new ArrayList<>(); listbodySeries.add( new QuerySeriesOptionParam() .withNamespace("PAAS.CONTAINER") .withMetricName("aom_process_cpu_usage") ); body.withSeries(listbodySeries); request.withBody(body); try { ListSeriesResponse response = client.listSeries(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 objects by namespace and metric_name.
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 |
# 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 = ListSeriesRequest() listSeriesbody = [ QuerySeriesOptionParam( namespace="PAAS.CONTAINER", metric_name="aom_process_cpu_usage" ) ] request.body = SeriesAPIQueryItemParam( series=listSeriesbody ) response = client.list_series(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 objects by namespace and metric_name.
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 |
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.ListSeriesRequest{} metricNameSeries:= "aom_process_cpu_usage" var listSeriesbody = []model.QuerySeriesOptionParam{ { Namespace: "PAAS.CONTAINER", MetricName: &metricNameSeries, }, } request.Body = &model.SeriesApiQueryItemParam{ Series: listSeriesbody, } response, err := client.ListSeries(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