全部产品
Search
文档中心

云监控:DescribeCustomMetricList - 查询上报的自定义监控数据

更新时间:Jul 26, 2024

调用DescribeCustomMetricList接口查询上报的自定义监控数据。

接口说明

说明 建议您通过 DescribeMetricList 接口查询监控数据。更多信息,请参见 DescribeMetricList

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeCustomMetricListget
  • 全部资源
    *

请求参数

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

应用分组 ID。

关于如何获取应用分组 ID,请参见 DescribeMonitorGroups

7378****
MetricNamestring

自定义监控项名称。

cpu_total
Dimensionstring

维度 Map,用于查询指定资源的监控数据。

{sampleName1=value1&sampleName2=value2}
Md5string

消息摘要算法,可以产生一个 128 位(16 字节)的散列值,用来校验上报的自定义监控数据的唯一性。

97c25982d9745a231276bff27469****
PageNumberstring

页码。

起始值:1。默认值:1。

1
PageSizestring

分页时每页显示的数据行数。

起始值:1。默认值:10。

10

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

success
RequestIdstring

请求 ID。

1AF425E4-1DEA-54F2-910A-8117C9686140
Resultstring

自定义监控数据查询结果。

{\"all\":0,\"size\":10,\"param\":{\"metric\":\"{\\\"metricName\\\":\\\"cpu_total\\\",\\\"groupId\\\":7378****,\\\"project\\\":\\\"acs_customMetric_120886317861****\\\",\\\"dimension\\\":\\\"sampleName1=value1&sampleName2=value2\\\",\\\"status\\\":1}\",\"service\":\"metric-center.aliyun-inc.com\"},\"page\":1,\"list\":[]}

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "success",
  "RequestId": "1AF425E4-1DEA-54F2-910A-8117C9686140",
  "Result": "{\\\"all\\\":0,\\\"size\\\":10,\\\"param\\\":{\\\"metric\\\":\\\"{\\\\\\\"metricName\\\\\\\":\\\\\\\"cpu_total\\\\\\\",\\\\\\\"groupId\\\\\\\":7378****,\\\\\\\"project\\\\\\\":\\\\\\\"acs_customMetric_120886317861****\\\\\\\",\\\\\\\"dimension\\\\\\\":\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\",\\\\\\\"status\\\\\\\":1}\\\",\\\"service\\\":\\\"metric-center.aliyun-inc.com\\\"},\\\"page\\\":1,\\\"list\\\":[]}"
}

JSON格式

{
  "Code": "200",
  "Message": "success",
  "RequestId": "1AF425E4-1DEA-54F2-910A-8117C9686140",
  "Result": "{\\\"all\\\":0,\\\"size\\\":10,\\\"param\\\":{\\\"metric\\\":\\\"{\\\\\\\"metricName\\\\\\\":\\\\\\\"cpu_total\\\\\\\",\\\\\\\"groupId\\\\\\\":7378****,\\\\\\\"project\\\\\\\":\\\\\\\"acs_customMetric_120886317861****\\\\\\\",\\\\\\\"dimension\\\\\\\":\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\",\\\\\\\"status\\\\\\\":1}\\\",\\\"service\\\":\\\"metric-center.aliyun-inc.com\\\"},\\\"page\\\":1,\\\"list\\\":[]}"
}

错误码

HTTP status code错误码错误信息
400%s%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
暂无变更历史