首页 云监控 开发参考 API参考 API目录 云产品监控 DescribeMetricMetaList - 查询云监控开放的监控项详情

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

更新时间: 2023-09-05 15:22:30

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

指标所属的Namespace,用于区分每个产品配置。

详情请参见云产品监控项

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。

0CCE0AF0-053C-4B13-A583-DC9A85785D49
TotalCountstring

总记录条数。

12
Successboolean

操作是否成功。true表示成功,false表示失败。

true
Resourcesobject []

指定监控项的配置信息。

MetricNamestring

监控项名称。

CPUUtilization
Descriptionstring

监控项描述。

CPUUtilization
Labelsstring

监控项的标签,是一个或多个JSON字符串。格式:[{"name":"标签名","value":"标签的值"}]name可以重复, 已有标签说明如下:

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

监控项的单位。

%
Dimensionsstring

监控项的Dimensions。多个用英文逗号(,)分隔。

instanceId
Namespacestring

用于区分产品类型。通常的命名方式为acs_产品名。

acs_kvstore
Periodsstring

监控项的所有统计周期。多个用英文逗号(,)分隔。

60,300
Statisticsstring

统计方法。多个用英文逗号(,)分隔。

Average,Minimum,Maximum

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "0CCE0AF0-053C-4B13-A583-DC9A85785D49",
  "TotalCount": "12",
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "CPUUtilization",
        "Description": "CPUUtilization",
        "Labels": "[{\\\"name\\\":\\\"alertUnit\\\",\\\"value\\\":\\\"Bytes\\\"},{\\\"name\\\":\\\"minAlertPeriod\\\",\\\"value\\\":\\\"60\\\"},{\\\"name\\\":\\\"metricCategory\\\",\\\"value\\\":\\\"instanceId\\\"},{\\\"name\\\":\\\"instanceType\\\",\\\"value\\\":\\\"disaster\\\"},{\\\"name\\\":\\\"is_alarm\\\",\\\"value\\\":\\\"true\\\"},{\\\"name\\\":\\\"productCategory\\\",\\\"value\\\":\\\"kvstore_old\\\"}]",
        "Unit": "%",
        "Dimensions": "instanceId",
        "Namespace": "acs_kvstore",
        "Periods": "60,300",
        "Statistics": "Average,Minimum,Maximum"
      }
    ]
  }
}

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "0CCE0AF0-053C-4B13-A583-DC9A85785D49",
  "TotalCount": "12",
  "Success": true,
  "Resources": {
    "Resource": [
      {
        "MetricName": "CPUUtilization",
        "Description": "CPUUtilization",
        "Labels": "[{\\\"name\\\":\\\"alertUnit\\\",\\\"value\\\":\\\"Bytes\\\"},{\\\"name\\\":\\\"minAlertPeriod\\\",\\\"value\\\":\\\"60\\\"},{\\\"name\\\":\\\"metricCategory\\\",\\\"value\\\":\\\"instanceId\\\"},{\\\"name\\\":\\\"instanceType\\\",\\\"value\\\":\\\"disaster\\\"},{\\\"name\\\":\\\"is_alarm\\\",\\\"value\\\":\\\"true\\\"},{\\\"name\\\":\\\"productCategory\\\",\\\"value\\\":\\\"kvstore_old\\\"}]",
        "Unit": "%",
        "Dimensions": "instanceId",
        "Namespace": "acs_kvstore",
        "Periods": "60,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.-

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

阿里云首页 云监控 相关技术圈