文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ Prometheus实例/ 查询Prometheus实例
更新时间：2025-08-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询Prometheus实例

功能介绍

该接口用于查询Prometheus实例。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/aom/prometheus

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。
表2 Query参数

参数

是否必选

参数类型

描述

prom_id

否

String

Prometheus实例id(prom_id与prom_type同时存在时，仅prom_id生效)。

prom_type

否

String

Prometheus实例类型（暂时不支持VPC、KUBERNETES）。

枚举值：

  • default

  • ECS

  • VPC

  • CCE

  • REMOTE_WRITE

  • KUBERNETES

  • CLOUD_SERVICE

  • ACROSS_ACCOUNT

cce_cluster_enable

否

String

cce集群开关。

枚举值：

  • true

  • false

prom_status

否

String

Prometheus实例状态。

枚举值：

  • DELETED

  • NORMAL

  • ALL

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

否

String

指定类型为application/json。

Enterprise-Project-Id

是

String

企业项目id。

  • 查询单个企业项目下实例，填写企业项目id。

  • 查询所有企业项目下实例，填写“all_granted_eps”。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

prometheus

Array of PromInstanceEpsModel objects

Prometheus实例名称列表。
表5 PromInstanceEpsModel

参数

参数类型

描述

prom_name

String

Prometheus实例名称 名称不能以下划线或中划线开头结尾，只含有中文、英文、数字、下划线、中划线、长度1-100。

prom_id

String

Prometheus实例id。

prom_type

String

Prometheus实例类型（暂时不支持VPC、KUBERNETES）。

枚举值：

  • default

  • ECS

  • VPC

  • CCE

  • REMOTE_WRITE

  • KUBERNETES

  • CLOUD_SERVICE

  • ACROSS_ACCOUNT

prom_version

String

Prometheus实例版本号。

prom_create_timestamp

Long

Prometheus实例创建时间戳。

prom_update_timestamp

Long

Prometheus实例更新时间戳。

prom_status

String

Prometheus实例状态。

枚举值：

  • DELETED

  • NORMAL

  • ALL

enterprise_project_id

String

Prometheus实例所属的企业项目。

project_id

String

Prometheus实例所属projectId。

is_deleted_tag

Long

删除标记。

deleted_time

Long

删除时间。

prom_spec_config

PromConfigModel object

Prometheus实例所属特定配置。

cce_spec_config

String

Prometheus实例所属CCE特殊配置。

prom_limits

PromLimits object

Prometheus实例限制

limits_update_time

Long

指标存储周期修改时间
表6 PromConfigModel

参数

参数类型

描述

remote_write_url

String

Prometheus实例remote-write地址。

remote_read_url

String

Prometheus实例remote-read地址。

prom_http_api_endpoint

String

Prometheus实例调用url。

dashboard_id

String

Prometheus实例关联dashboard的dashboard id（目前未使用）。

region_id

String

Prometheus实例所属的region。
表7 PromLimits

参数

参数类型

描述

compactor_blocks_retention_period

String

指标存储时长，只支持 15天，30天，60天 ，90天

枚举值：

  • "360h"

  • "720h"

  • "1440h"

  • "2160h"

请求示例

  • 查询Prometheus实例。

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

  • 查询prom_id为08****2a-8b-45-b1-d1******79的Prometheus实例。

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

响应示例

状态码：200

OK 请求响应成功。

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

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码。

父主题： Prometheus实例