文档

PutCustomMetric - 上报自定义监控数据

更新时间:

调用PutCustomMetric接口上报自定义监控数据。

接口说明

说明 推荐您使用企业云监控中的接口 PutHybridMonitorMetricData

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
MetricListobject []

监控数据列表。

Typestring

上报数值类型。N 的取值范围:1~21。取值:

  • 0:原始数据。
  • 1:聚合数据。
说明 当上报聚合数据时,建议周期为 60 秒和 300 秒的数据均上报,否则无法正常查询跨度大于 7 天的监控数据。
0
MetricNamestring

监控项名称。N 的取值范围:1~21。详情请参见云服务监控项

cpu_total
Timestring

指标发生的时间。N 的取值范围:1~21。支持以下两种类型:

  • UTC 时间。格式:YYYY-MM-DDThh:mm:ssZ,例如:20171012T132456.888+0800。
  • Long 型时间戳。例如:1508136760000。
1508136760000
GroupIdstring

应用分组 ID。N 的取值范围:1~21。

说明 如果监控项不属于任何应用分组, 则输入 0。
12345
Valuesstring

指标值集合。N 的取值范围:1~21。

说明 如果上报数值的类型为 0,则上报的是原始值,云监控会按周期将原始值聚合为多个值,例如:最大、计数、求和等。
{"value":10.5}
Dimensionsstring

维度 Map,用于查询指定资源的监控数据。N 的取值范围:1~21。

格式:key-value 键值对形式的集合,常用的 key-value 集合为:{"Key":"Value"}

Key 和 Value 的长度为 1~64 个字符,超过 64 个字符时截取前 64 个。

Key 和 Value 的取值可包含英文字母、数字、点号(.)、短划线(-)、下划线(_)、正斜线(/)和反斜线(\)。

说明 Dimensions 传入时需要使用 JSON 字符串表示该 Map 对象,必须按顺序传入。
{"sampleName1":"value1","sampleName2":"value2"}
Periodstring

聚合周期。N 的取值范围:1~21。单位:秒,取值:60 或 300。

说明 如果上报数值的类型为 1,则需要设置该参数。
60

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The request has failed due to a temporary failure of the server.
RequestIdstring

请求 ID。

05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The request has failed due to a temporary failure of the server.",
  "RequestId": "05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0"
}

错误码

HTTP status code错误码错误信息
400%s%s
500InternalError%s

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

变更历史

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