文档首页> 应用运维管理 AOM> API参考> API> Prometheus实例> 批量获取指标属性信息
更新时间：2024-05-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量获取指标属性信息

功能介绍

批量获取CCE&云服务&default普罗实例预制指标的属性信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/aom/metric-properties

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

prom_type

否

String

Prometheus实例类型。不同Prometheus实例预制不同指标。不传则返回预制的全量指标属性信息（Prometheus_AOM_Default，Prometheus for 云服务，Prometheus for CCE）大小写不敏感。

缺省值：ALL

枚举值：

  • DEFAULT

  • CLOUD_SERVICE

  • CCE

  • ALL

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

最小长度：0

最大长度：40960

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

{自定义key}

Map<String,MetricProperty>

OK 请求响应成功。
表5 MetricProperty

参数

参数类型

描述

metric

String

指标。

name

String

指标名称。

category

String

指标分类。

description

String

指标含义。

type

String

指标类型。BASE：基础指标；CUSTOM：自定义指标。

枚举值：

  • BASE

  • CUSTOM

source

String

指标来源。

source_name

String

指标来源名称。

unit

String

指标单位。

prom_category

String

指标的Prometheus实例类型。CLOUD_SERVICE：云服务Prometheus实例；CCE：CCE Prometheus实例；DEFAULT：默认Prometheus实例。

枚举值：

  • DEFAULT

  • CCE

  • CLOUD_SERVICE

ranges

String

指标取值范围。

请求示例

查询应属于Prometheus_AOM_Default实例预制指标信息。

https://{end_point}/v2/{project_id}/aom/metric-properties

https://{end_point}/v2/{project_id}/aom/metric-properties?prom_type=DEFAULT

响应示例

状态码： 200

OK 请求响应成功。

{
  "aom_container_cpu_usage" : {
    "category" : "容器指标",
    "description" : "该指标用于统计测量对象的CPU使用率。服务实际使用的与限制的CPU核数量比率。",
    "metric" : "aom_container_cpu_usage",
    "name" : "CPU使用率",
    "prom_category" : "DEFAULT",
    "ranges" : "0～100",
    "source" : "ICAgent",
    "source_name" : "ICAgent",
    "type" : "BASE",
    "unit" : "百分比"
  }
}

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码。

父主题： Prometheus实例
分享：

    相关文档

    相关产品