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.

URI¶

POST /v2/{project_id}/series

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID obtained from IAM. Generally, a project ID contains 32 characters.

**Table 2** Query Parameters¶
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¶

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
series	Yes	Array of QuerySeriesOptionParam objects	Array for querying time series objects.

**Table 4** QuerySeriesOptionParam¶
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.
metric_name	No	String	Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names.
dimensions	No	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.

**Table 5** DimensionSeries¶
Parameter	Mandatory	Type	Description
name	No	String	Dimension name.
value	No	String	Dimension value.

Response Parameters¶

Status code: 200

**Table 6** Response body parameters¶
Parameter	Type	Description
series	Array of SeriesQueryItemResult objects	List of time series objects.
meta_data	MetaDataSeries object	Metadata, including pagination information.

**Table 7** SeriesQueryItemResult¶
Parameter	Type	Description
namespace	String	Namespace.
dimensions	Array of DimensionSeries objects	Dimension list.
metric_name	String	Time series name.
unit	String	Time series unit.

**Table 8** DimensionSeries¶
Parameter	Type	Description
name	String	Dimension name.
value	String	Dimension value.

**Table 9** MetaDataSeries¶
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

**Table 10** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_type	String	Error type.

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"
    } ]
  } ]
}

Status code: 400

Bad Request: The request is invalid. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.04007001",
  "error_msg" : "please check request param",
  "error_type" : "BAD_REQUEST"
}

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.

last updated: 2024-11-04 09:05 UTC - commit: a1770d9577f10e8e4a303a67db98ef77c989cadc