文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ 监控/ 添加监控数据
更新时间：2024-08-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加监控数据

功能介绍

该接口用于向服务端添加一条或多条监控数据。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/ams/report/metricdata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json
表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

是

Array of MetricDataItem objects

指标参数信息。
表4 MetricDataItem

参数

是否必选

参数类型

描述

collect_time

是

Long

数据收集时间支持过去1天和未来半小时范围内的数据上报。数据收集时间需要满足：

当前UTC时间减去collect_time小于等于24小时或者collect_time减去当前UTC时间小于等于30分钟。

若数据上报时间早于当天8点，则指标监控页面只显示当天8点后的数据。取值范围： UNIX时间戳，单位毫秒。

metric

是

MetricItemInfo object

指标详细信息。

values

是

Array of ValueData objects

指标数据的值。
表5 MetricItemInfo

参数

是否必选

参数类型

描述

dimensions

是

Array of Dimension2 objects

指标维度列表。维度最多允许50个，单个维度为json对象，结构说明如下 dimension.name：长度最短为1，最大为32。 dimension.value：长度最短为1，最大为64。

namespace

是

String

指标命名空间。namespace中不允许存在":"符号，取值范围格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，总长度最短为3，最大为32，service不能为“PAAS”。

最小长度：3

最大长度：32
表6 Dimension2

参数

是否必选

参数类型

描述

name

是

String

维度名称。

最小长度：1

最大长度：32

value

是

String

维度取值。

最小长度：1

最大长度：64
表7 ValueData

参数

是否必选

参数类型

描述

metric_name

是

String

指标名称。长度1~255。

type

否

String

数据的类型。取值范围只能是"int"或"float"。

枚举值：

  • int

  • float

unit

否

String

数据的单位。长度不超过32个字符。

value

是

Double

指标数据的值。取值范围有效的数值类型。

最小值：0

响应参数

状态码： 200

表8 响应Body参数

参数

参数类型

描述

errorCode

String

响应码。

errorMessage

String

响应信息描述。

请求示例

向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据（下述例子中，"collect_time"应填写为最新的时间戳）。

https://{Endpoint}/v1/{project_id}/ams/report/metricdata

[ {
  "metric" : {
    "namespace" : "NOPAAS.ESC",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "instance-101"
    } ]
  },
  "values" : [ {
    "unit" : "percent",
    "metric_name" : "cpu_util",
    "type" : "int",
    "value" : 35
  } ],
  "collect_time" : 1467787152000
} ]

响应示例

状态码： 200

OK 请求响应成功。

{
  "errorCode" : "SVCSTG_AMS_2000000",
  "errorMessage" : "success"
}

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

503

ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： 监控