Help Center> Application Operations Management> API Reference> API> Monitoring> Querying Monitoring Data
View PDF

Querying Monitoring Data

Function

This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query.

URI

POST /v1/{project_id}/ams/metricdata

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

fillValue

No

String

Value filled for breakpoints in monitoring 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.

Default: -1

Enumeration values:

  • -1

  • 0

  • null

  • average

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json.

Enumeration values:

  • application/json
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

metrics

Yes

Array of MetricQueryMeritcParam objects

Metric list. A JSON array can contain up to 20 objects.

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.

statistics

Yes

Array of strings

Statistic. Values: maximum, minimum, sum, average, and sampleCount.

timerange

Yes

String

Time range specified for query. The following requirement must be met: Time range/period ≤ 1440 During calculation, the time range and period must be converted to the same unit. Format: start time (UTC, in ms).end time (UTC, in ms).number of minutes in the time period. If both the start time and end time are -1, it indicates the latest N minutes. For example, –1.–1.5 indicates the latest 5 minutes. 1501545600000.1501632000000.1440 indicates the fixed time period from 08:00:00 on August 1, 2017 to 08:00:00 on August 2, 2017.
Table 5 MetricQueryMeritcParam

Parameter

Mandatory

Type

Description

dimensions

Yes

Array of Dimension objects

List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank.

metricName

Yes

String

Metric name. Length: 1–255 characters.

namespace

Yes

String

Metric namespace. Values: PAAS.CONTAINER PAAS.NODE PAAS.SLA PAAS.AGGR CUSTOMMETRICS
Table 6 Dimension

Parameter

Mandatory

Type

Description

name

Yes

String

Dimension name.

value

Yes

String

Dimension value.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

errorCode

String

Response code.

errorMessage

String

Response message.

metrics

Array of MetricDataValue objects

Metric list.
Table 8 MetricDataValue

Parameter

Type

Description

dataPoints

Array of MetricDataPoints objects

Key metric.

metric

MetricQueryMeritcParam object

Query parameters.
Table 9 MetricDataPoints

Parameter

Type

Description

statistics

Array of StatisticValue objects

Statistic.

timestamp

Long

Timestamp.

unit

String

Time series unit.
Table 10 StatisticValue

Parameter

Type

Description

statistic

String

Statistic.

value

Double

Statistical result.
Table 11 MetricQueryMeritcParam

Parameter

Type

Description

dimensions

Array of Dimension objects

List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank.

metricName

String

Metric name. Length: 1–255 characters.

namespace

String

Metric namespace. Values: PAAS.CONTAINER PAAS.NODE PAAS.SLA PAAS.AGGR CUSTOMMETRICS
Table 12 Dimension

Parameter

Type

Description

name

String

Dimension name.

value

String

Dimension value.

Example Requests

Query the monitoring data of a specified metric in the last 5 minutes.

https://{Endpoint}/v1/{project_id}/ams/metricdata

{
  "metrics" : [ {
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "demo1"
    } ],
    "metricName" : "def",
    "namespace" : "abc"
  } ],
  "period" : 60,
  "statistics" : [ "maximum", "minimum", "sum" ],
  "timerange" : "-1.-1.5"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "errorCode" : "SVCSTG.AMS.2000",
  "errorMessage" : "success",
  "metrics" : [ {
    "metric" : {
      "namespace" : "abc",
      "metricName" : "def",
      "dimensions" : [ {
        "name" : "ghi",
        "value" : "lmn"
      } ]
    },
    "dataPoints" : [ {
      "timestamp" : "1467892800000",
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "maximum",
        "value" : "23"
      } ]
    } ]
  } ]
}

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

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

Error Codes

See Error Codes.

Parent topic: Monitoring