阿里云监控上报监控数据

上报监控数据

自定义监控功能为你提供上报监控数据的接口,方便你将自己采集的时序数据上报到云监控。目前支持OpenAPI和命令行工具CLI的方式进行上报。

OpenAPI上报上报接口描述

  • 接口名称:putMetricData

  • 公网域名

  • 地域域名华北-北京monitor.cn-north-1.cloud-api.com华南-广州monitor.cn-south-1.cloud-api.com华东-宿迁monitor.cn-east-1.cloud-api.com华东-上海monitor.cn-east-2.cloud-api.com

  • 内网域名
  • 地域域名华北-北京monitor.internal.cn-north-1.cloud-api.com华南-广州monitor.internal.cn-south-1.cloud-api.com华东-宿迁monitor.internal.cn-east-1.cloud-api.com华东-上海monitor.internal.cn-east-2.cloud-api.com

  • 支持批量上报方式。单次请求最多包含50个数据点;数据大小不超过256k。

注:OpenAPI入门使用请参看公共说明

请求方式

POSThttps://{域名}/v1/customMetrics

例如:POSThttps://monitor.cn-north-1.cloud-api.com/v1/customMetrics

请求参数名称类型是否必选描述metricDataListMetricDataCm[]False数据参数

MetricDataCm

名称类型是否必选描述dimensionsObjectTrue数据维度,数据类型为map类型,支持最少一个,最多五个标签,总长度不大于255字节,只允许英文、数字、下划线_、点.,[0-9][a-z][A-Z][._],其它会返回errmetricStringTrue监控指标名称,长度不超过255字节,只允许英文、数字、下划线_、点.,[0-9][a-z][A-Z][._],其它会返回errnamespaceStringTrue命名空间,长度不超过255字节,只允许英文、数字、下划线_、点.,[0-9][a-z][A-Z][._],其它会返回errtimestampIntegerTrue上报数据点的时间戳,只支持10位,秒级时间戳,不能写入过去30天的时间typeIntegerTrue数据类型,当前仅支持输入值1,表示原始数据。valuesObjectTrue指标值集合,数据类型必须为map类型,key为数据类型,value为数据值,当前仅支持type=1,且key只能为”value”。返回参数名称类型是否必选errorObject错误信息。requestIdString请求的标识idresultResult

Result

名称类型是否必选errMetricDataListMetricDataList[]successBoolean全部写入成功为true,否则为false

MetricDataList

名称类型是否必选errDetailstring错误数据描述errMetricDatastring错误数据返回码名称类型200OK400invalidparameter500internalservererror429quotaexceed示例代码

注:直接使用该示例时,请替换timestamp参数为最新的10位秒级时间戳,否则会写入失败(禁止写入时间戳超过过去30天的数据)。

请求示例

{"metricDataList":[{"namespace":"test","metric":"vm.mem.usage1","dimensions":{"host":"1.2.3.23","datacenter":"cn-north-1"},"timestamp":1552446075,"type":1,"values":{"value":"12342213"}},{"namespace":"test1","metric":"vm.cpu.usage","dimensions":{"host":"1.2.3.19","tag":"bj"},"timestamp":1552446075,"type":2,"values":{"value":"12342213"}}]}

返回示例

success:{"requestId":"1111","result":{"success":true,"errMetricDataList":[]}}fail:{"requestId":"1111","result":{"success":false,"errMetricDataList":[{"ErrMetricData":"{"namespace":"test1","metric":"vm.cpu.usage","dimensions":{"host":"1.2.3.19","region":"bj","tag":"bj","tag2":"bj","tag3":"bj","tag4":"bj"},"timestamp":1540361379,"type":2,"values":{"avg":"80","max":"32424244120"}}","errDetail":"Invaliddimensions,dimensionsnumlimitedin1to5andnotnull"}]},"error":{"code":400,"message":"INVALID_ARGUMENT","status":"INVALID_ARGUMENT","details":null}}CLI上报安装CLI

如何安装请参看安装说明。

配置环境

配置KEY、所在区域region-id和网关地址endpoint,编辑/root/.c/config

vi~/.c/config[default]access_key=YourAccessKeyIDsecret_key=YourAccessKeySecretregion_id=cn-north-1endpoint=monitor.cn-north-1.cloud-api.comscheme=httpstimeout=20不同地域的region_id和上报的网关endpoint地址如下:地域region_id公网endpoint内网endpoint华北-北京cn-north-1monitor.cn-north-1.cloud-api.commonitor.internal.cn-north-1.cloud-api.com华南-广州cn-south-1monitor.cn-south-1.cloud-api.commonitor.internal.cn-south-1.cloud-api.com华东-宿迁cn-east-1monitor.cn-east-1.cloud-api.commonitor.internal.cn-east-1.cloud-api.com华东-上海cn-east-2monitor.cn-east-2.cloud-api.commonitor.internal.cn-east-2.cloud-api.com
上报监控数据

使用put-metric-data接口上报监控数据,示例如下:

cmonitorput-metric-data--input-json'{"metricDataList":[{"namespace":"test_ns","metric":"vm.cpu.usage1","dimensions":{"host":"10.10.10.23","datacenter":"cn_north_1"},"timestamp":1544425695,"type":1,"values":{"value":"12342213"}}]}'注意:仅能上报近1周的监控数据,请将上边示例中timestamp中的时间戳修改为你当前上报的UNIX时间。

返回成功示例如下:

{"error":null,"result":{"errMetricDataList":[],"success":true},"request_id":"bg9ofp78ikqqgvastas64owpqmoijk77"}