添加监控数据
功能介绍
该接口用于向服务端添加一条或多条监控数据。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/ams/report/metricdata
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
Content-Type |
是 |
String |
消息体的类型(格式)。指定类型为“application/json”。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of MetricDataItem objects |
待添加的监控数据项。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
collect_time |
是 |
Long |
数据收集时间,仅支持过去1天和未来半小时范围内的数据上报。即数据收集时间需要满足过去24小时到未来30分内。 取值范围:UNIX时间戳,单位毫秒。例如:2024-10-16 16:03:01需要通过工具转换成UNIX毫秒级时间戳:1702759381000。 如果数据上报时间早于当天8点,则指标监控页面只显示当天8点后的数据。 |
metric |
是 |
MetricItemInfo object |
指标详细信息。 |
values |
是 |
Array of ValueData objects |
指标数据的值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dimensions |
是 |
Array of Dimension2 objects |
指标维度列表。如果想使用已有的维度,可通过调用查询时间序列接口,查询当前监控指标的指标维度列表。最多允许传入 50组维度数据,单个维度为json对象。 |
namespace |
是 |
String |
指标命名空间。如果想使用已有的命名空间,可通过调用查询标签值接口获取指标命名空间。如果自定义命名空间,命名空间的值必须满足以下条件: 命名空间中不允许存在":"符号,取值格式为service.item。service和item必须是字符串,且以字母开头,只能包含0-9/a-z/A-Z/_。长度范围为3到32字符串,service不能为“PAAS”。 最小长度:3 最大长度:32 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。