DescribeMetricMetaList - 查询云监控开放的监控项详情 - 云监控

调用DescribeMetricMetaList接口查询云监控开放的监控项详情。

接口说明

通常配合查询监控数据接口 DescribeMetricList 和 DescribeMetricLast 一起使用，详情请参见 DescribeMetricList 和 DescribeMetricLast 。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Namespace	string	否	云产品的命名空间。关于云产品的命名空间，请参见云产品监控项。	acs_kvstore
Labels	string	否	根据标签过滤资源。是一个 JSON 的字符串。格式：`[{"name":"标签键","value":"标签值"},{"name":"标签键","value":"标签值"}]` 。已有标签说明如下： metricCategory：监控项分类描述。 alertEnable：是否需要报警。 alertUnit：建议的报警单位。 unitFactor：单位转换系数。 minAlertPeriod：最小报警周期。 productCategory：产品类型分类。	[{"name":"productCategory","value":"kvstore_old"}]
MetricName	string	否	监控项名称。详情请参见云产品监控项。	CPUUtilization
PageNumber	integer	否	分页参数。默认值：1。	1
PageSize	integer	否	每页最大数量。默认值：30。	30

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The Request is not authorization.
RequestId	string	请求 ID。	CDE9EAFF-D54E-4024-BBFC-B0AAC883143B
TotalCount	string	总记录条数。	10
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Resources	object
Resource	array<object>	资源中监控项的配置信息。
	object	资源中监控项的配置信息。
MetricName	string	监控项名称。	ads.diskSize
Description	string	监控项描述。	The rated disk capacity
Labels	string	监控项的标签，是一个或多个 JSON 字符串。格式：`[{"name":"标签键","value":"标签值"}]`，`name`可以重复，已有标签说明如下： metricCategory：监控项分类描述。 alertEnable：是否需要报警。 alertUnit：建议的报警单位。 unitFactor：单位转换系数。 minAlertPeriod：最小报警周期。 productCategory：产品类型分类。	[{\"name\":\"minAlertPeriod\",\"value\":\"300\"},{\"name\":\"alertDefault\",\"value\":\"\"},{\"name\":\"unitFactor\",\"value\":\"1\"},{\"name\":\"alertUnit\",\"value\":\"Mbytes\"},{\"name\":\"productCategory\",\"value\":\"ads\"},{\"name\":\"is_alarm\",\"value\":\"true\"},{\"name\":\"metricCategory\",\"value\":\"workerId\"}]
Unit	string	监控项的单位。	MB
Dimensions	string	资源的监控维度。多个监控维度之间用半角逗号（,）分隔。	userId,instanceId,tableSchema,workerId
Namespace	string	云产品的命名空间。	acs_ads
Periods	string	监控项的所有统计周期。多个统计周期之间用半角逗号（,）分隔。单位：秒。	300
Statistics	string	统计方法。多个统计方法之间用半角逗号（,）分隔。	Average,Minimum,Maximum

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "CDE9EAFF-D54E-4024-BBFC-B0AAC883143B",
  "TotalCount": "10",
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "ads.diskSize",
        "Description": "The rated disk capacity",
        "Labels": "[{\\\"name\\\":\\\"minAlertPeriod\\\",\\\"value\\\":\\\"300\\\"},{\\\"name\\\":\\\"alertDefault\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"unitFactor\\\",\\\"value\\\":\\\"1\\\"},{\\\"name\\\":\\\"alertUnit\\\",\\\"value\\\":\\\"Mbytes\\\"},{\\\"name\\\":\\\"productCategory\\\",\\\"value\\\":\\\"ads\\\"},{\\\"name\\\":\\\"is_alarm\\\",\\\"value\\\":\\\"true\\\"},{\\\"name\\\":\\\"metricCategory\\\",\\\"value\\\":\\\"workerId\\\"}]",
        "Unit": "MB",
        "Dimensions": "userId,instanceId,tableSchema,workerId",
        "Namespace": "acs_ads",
        "Periods": "300",
        "Statistics": "Average,Minimum,Maximum"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Parameter invalid.	非法参数
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

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

变更历史

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