Help Center> Application Operations Management> API Reference> API> Monitoring> Querying Time Series Objects
View PDF

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

Time series objects' namespace. Values: PAAS.CONTAINER: time series of an application. PAAS.NODE: time series of a node. PAAS.SLA: SLA time series. PAAS.AGGR: time series of a cluster. CUSTOMMETRICS: custom time series.

metric_name

No

String

Time series name. Length: 1 to 255 characters.

dimensions

No

Array of DimensionSeries objects

List of time series dimensions.
Table 5 DimensionSeries

Parameter

Mandatory

Type

Description

name

No

String

Name.

value

No

String

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.

dimension_value_hash

String

Time series hash value.
Table 8 DimensionSeries

Parameter

Type

Description

name

String

Name.

value

String

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, appName, and clusterName.

https://{Endpoint}/v2/{project_id}/series

{
  "series" : [ {
    "namespace" : "PAAS.CONTAINER",
    "dimensions" : [ {
      "name" : "appName",
      "value" : "demo"
    }, {
      "name" : "clusterName",
      "value" : "test"
    } ]
  } ]
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "meta_data" : {
    "count" : 1,
    "offset" : null,
    "total" : 1
  },
  "series" : [ {
    "namespace" : "abc",
    "metric_name" : "cpuUsage",
    "unit" : "Percent",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "demo1"
    } ]
  } ]
}

Status code: 400

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

{
  "error_code" : "AOM.04007500",
  "error_msg" : "internal server error",
  "error_type" : "INTERNAL_SERVER_ERROR"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

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

401

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 unavailable. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

Parent topic: Monitoring