Help Center/ Application Operations Management/ API Reference/ APIs/ Prometheus Instance/ Querying a Prometheus Instance
Updated on 2025-11-06 GMT+08:00
View PDF

Querying a Prometheus Instance

Function

This API is used to query a Prometheus instance.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/aom/prometheus

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

prom_id

No

String

Prometheus instance ID. If both prom_id and prom_type exist, only prom_id takes effect.

prom_type

No

String

Prometheus instance type (VPC and KUBERNETES are not supported).

Enumeration values:

  • default

  • ECS

  • VPC

  • CCE

  • REMOTE_WRITE

  • KUBERNETES

  • CLOUD_SERVICE

  • ACROSS_ACCOUNT

cce_cluster_enable

No

String

Whether to enable a CCE cluster.

Enumeration values:

  • true

  • false

prom_status

No

String

Prometheus instance status.

Enumeration values:

  • DELETED

  • NORMAL

  • ALL

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

No

String

Content type, which is application/json.

Enterprise-Project-Id

Yes

String

Enterprise project ID.

  • To query instances in an enterprise project, enter the enterprise project ID.

  • To query instances in all enterprise projects, enter all_granted_eps.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

prometheus

Array of PromInstanceEpsModel objects

Prometheus instance list.
Table 5 PromInstanceEpsModel

Parameter

Type

Description

prom_name

String

Prometheus instance name. Enter 1–100 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, underscores, and hyphens are allowed.

prom_id

String

Prometheus instance ID.

prom_type

String

Prometheus instance type. Options:

  • default: default Prometheus instance.

  • ECS: Prometheus for ECS.

  • CCE: Prometheus for CCE.

  • REMOTE_WRITE: common Prometheus instance.

  • CLOUD_SERVICE: Prometheus for cloud services.

  • ACROSS_ACCOUNT: Prometheus for multi-account aggregation (not supported currently).

prom_version

String

Prometheus instance version.

prom_create_timestamp

Long

Timestamp when the Prometheus instance is created.

prom_update_timestamp

Long

Timestamp when the Prometheus instance is updated.

prom_status

String

Prometheus instance status.

Enumeration values:

  • DELETED

  • NORMAL

  • ALL

enterprise_project_id

String

Enterprise project that the Prometheus instance belongs to.

project_id

String

ID of the project that the Prometheus instance belongs to.

is_deleted_tag

Long

Whether an instance has been deleted.

deleted_time

Long

Deletion time.

prom_spec_config

PromConfigModel object

Special configuration of the Prometheus instance.

cce_spec_config

String

Special configuration of the Prometheus instance in the CCE scenario.

prom_limits

PromLimits object

Prometheus instance limitations.

limits_update_time

Long

Time when the metric storage duration was modified.

application

ApplicationModel object

Application details.
Table 6 PromConfigModel

Parameter

Type

Description

remote_write_url

String

Remote write address of the Prometheus instance.

remote_read_url

String

Remote read address of the Prometheus instance.

prom_http_api_endpoint

String

URL for calling the Prometheus instance.

dashboard_id

String

ID of the dashboard associated with the Prometheus instance (not used currently).

region_id

String

Region that the Prometheus instance belongs to.
Table 7 PromLimits

Parameter

Type

Description

compactor_blocks_retention_period

String

Metric storage duration. Only 15, 30, 60, and 90 days are supported.

Enumeration values:

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"
Table 8 ApplicationModel

Parameter

Type

Description

app_id

String

Application ID.

app_name

String

Application name.

app_type

String

Application source.

Example Requests

  • Query a Prometheus instance.

    https://{Endpoint}/v1/{project_id}/aom/prometheus

  • Query the Prometheus instance whose prom_id is 08****2a-8b-45-b1-d1******79.

    https://{Endpoint}/v1/{project_id}/aom/prometheus?prom_id=08****2a-8**b-4**5-b**1-d1********79

Example Responses

Status code: 200

OK: The request is successful.

{
  "prometheus" : [ {
    "deleted_time" : 0,
    "enterprise_project_id" : "0",
    "project_id" : "2a4***56cc***7f837***891***c1cf",
    "prom_create_timestamp" : 1691718171483,
    "prom_id" : "08****2a-8**b-4**5-b**1-d1********79",
    "prom_name" : "aom_prometheus",
    "prom_spec_config" : {
      "prom_http_api_endpoint" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79",
      "region_id" : "cn-****-*",
      "remote_read_url" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79/api/v1/read",
      "remote_write_url" : "aom-internal.cn-****-*.***.com:***/v1/2a4***56cc***7f837***891***c1cf/08****2a-8**b-4**5-b**1-d1********79/push"
    },
    "prom_type" : "CCE",
    "prom_update_timestamp" : 1691718171483
  } ]
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Prometheus Instance