Querying the Expression Calculation Result at a Specified Time Point Using the GET Method

Updated on 2025-01-07 GMT+08:00

View PDF

Function

This API is used to query the calculation result of a PromQL expression at a specified time point using the GET method.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/aom/api/v1/query

**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
query	Yes	String	PromQL expression. For details, see https://prometheus.io/docs/prometheus/latest/querying/basics/.
time	No	String	Timestamp specified for PromQL calculation (Unix timestamp, in seconds).

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Response status.
data	Object	Response data.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
status	String	Response status.
errorType	String	Error type.
error	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
status	String	Response status.
errorType	String	Error type.
error	String	Error message.

Status code: 422

**Table 7** Response body parameters
Parameter	Type	Description
status	String	Response status.
errorType	String	Error type.
error	String	Error message.

Status code: 503

**Table 8** Response body parameters
Parameter	Type	Description
status	String	Response status.
errorType	String	Error type.
error	String	Error message.

Example Requests

Query the calculation result of expression "up" at time point "1630124012".

https://{EndPoint}/v1/{project_id}/aom/api/v1/query?query=up&time=1630124012

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "data" : {
    "resultType" : "vector",
    "result" : [ ]
  }
}

Status code: 400

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

{
  "status" : "error",
  "errorType" : "bad_param",
  "error" : "param is invalid."
}

Status code: 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.

{
  "status" : "error",
  "errorType" : "auth",
  "error" : "auth project_id not pass."
}

Status code: 422

Unprocessable: The expression cannot be executed.

{
  "status" : "error",
  "errorType" : "excution",
  "error" : "expression can't be executed."
}

Status code: 503

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

{
  "status" : "error",
  "errorType" : "timeout",
  "error" : "query timed out in query execution."
}

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.
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.
422	Unprocessable: The expression cannot be executed.
503	Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.