文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
Namespacestring

云产品的命名空间。

关于云产品的命名空间,请参见云产品监控项

acs_kvstore
Labelsstring

根据标签过滤资源。是一个 JSON 的字符串。

格式:[{"name":"标签键","value":"标签值"},{"name":"标签键","value":"标签值"}] 。已有标签说明如下:

  • metricCategory:监控项分类描述。
  • alertEnable:是否需要报警。
  • alertUnit:建议的报警单位。
  • unitFactor:单位转换系数。
  • minAlertPeriod:最小报警周期。
  • productCategory:产品类型分类。
[{"name":"productCategory","value":"kvstore_old"}]
MetricNamestring

监控项名称。详情请参见云产品监控项

CPUUtilization
PageNumberinteger

分页参数。默认值:1。

1
PageSizeinteger

每页最大数量。默认值:30。

30

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

CDE9EAFF-D54E-4024-BBFC-B0AAC883143B
TotalCountstring

总记录条数。

10
Successboolean

操作是否成功。取值:

  • true:成功。
  • false:失败。
true
Resourcesobject []

资源中监控项的配置信息。

MetricNamestring

监控项名称。

ads.diskSize
Descriptionstring

监控项描述。

The rated disk capacity
Labelsstring

监控项的标签,是一个或多个 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\"}]
Unitstring

监控项的单位。

MB
Dimensionsstring

资源的监控维度。多个监控维度之间用半角逗号(,)分隔。

userId,instanceId,tableSchema,workerId
Namespacestring

云产品的命名空间。

acs_ads
Periodsstring

监控项的所有统计周期。多个统计周期之间用半角逗号(,)分隔。

单位:秒。

300
Statisticsstring

统计方法。多个统计方法之间用半角逗号(,)分隔。

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错误码错误信息描述
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
500InternalErrorThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)