DescribeMetricMetaList - 查询云监控开放的监控项详情-云监控(CMS)-阿里云帮助中心

查询元数据meta

接口说明

查询云监控指标元数据详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:DescribeMetricMetaList

none

*全部资源

*

无

请求语法

GET /describe-metric-meta-list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
namespace	string	否	命名空间，用于区分产品。	acs_ecs_dashboard
metaFormat	string	否	元数据来源，可选为基础云监控指标 CMS，Promtheus 云监控基础指标 PROM_BASIC	CMS
metricName	string	否	指标名称	CPUUtilization
labels	array<object>	否	根据标签过滤资源。已有标签说明如下： metricCategory：监控项分类描述。 alertEnable：是否需要报警。 alertUnit：建议的报警单位。 unitFactor：单位转换系数。 minAlertPeriod：最小报警周期。 productCategory：产品类型分类。
	object	否	标签键。
name	string	否	标签名称	productCategory
value	string	否	标签的值。	ecs
pageNumber	integer	否	页码，默认 1。	1
pageSize	integer	否	每页大小，默认 2000。	2000
keywords	string	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
totalCount	integer	总条数	6370
pageNumber	integer	页码，默认 1。	1
pageSize	integer	分页大小。	2000
resources	array<object>	资源中监控项的配置信息。
	array<object>	资源中监控项的配置信息。
namespace	string	命名空间。	acs_ecs_dashboard
metricName	string	指标名称。	CPUUtilization
description	string	描述	ECS CPU Utilization
unit	string	单位。	%
labels	object	云监控标签，仅当 metaFormat=CMS 时返回。
	string	云监控标签内容。	{ "DefaultTemplate": "false", "alertDefault": "80", "alertUnit": "%", "is_alarm": "true", "metricCategory": "instanceId", "minAlertPeriod": "60", "productCategory": "ecs", "unitFactor": "1" }
dimensions	array	基础云监控的资源过滤维度
	string	基础云监控的资源过滤维度	["userId","instanceId"]
type	string	指标类型。	Gauge
dimensionDescription	array<object>	维度信息描述。
	object
name	string	名称	user_id
statistics	string	监控项的统计方法。取值示例： Maximum：最大值。 Minimum：最小值。 Average：平均值。	Maximum
periods	string	周期。	60
metaFormat	string

示例

正常返回示例

JSON格式

{
  "requestId": "264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC",
  "totalCount": 6370,
  "pageNumber": 1,
  "pageSize": 2000,
  "resources": [
    {
      "namespace": "acs_ecs_dashboard",
      "metricName": "CPUUtilization",
      "description": "ECS CPU Utilization",
      "unit": "%",
      "labels": {
        "key": "{\n         \"DefaultTemplate\": \"false\",\n          \"alertDefault\": \"80\",\n          \"alertUnit\": \"%\",\n          \"is_alarm\": \"true\",\n          \"metricCategory\": \"instanceId\",\n          \"minAlertPeriod\": \"60\",\n          \"productCategory\": \"ecs\",\n          \"unitFactor\": \"1\"\n}"
      },
      "dimensions": [
        "[\"userId\",\"instanceId\"]"
      ],
      "type": "Gauge",
      "dimensionDescription": [
        {
          "name": "user_id"
        }
      ],
      "statistics": "Maximum",
      "periods": "60",
      "metaFormat": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。