本文导读

展开导读

文档首页/ Web3节点引擎服务 NES/ API参考/ API/ 专享版/ 节点监控/ 获取节点相关告警

获取节点相关告警

更新时间：2024-01-31 GMT+08:00

查看PDF

功能介绍

通过内置告警规则，进行节点相关告警

URI

POST /v1/{project_id}/node-provider/nodes/{node_id}/alarms/{alert_type}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID 最小长度：32 最大长度：32
node_id	是	String	节点ID 最小长度：36 最大长度：45
alert_type	是	String	查询类型，active_alert代表查询活动告警，history_alert代表查询历史告警最小长度：1 最大长度：15

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token 最小长度：1 最大长度：65535

表3 请求Body参数
参数	是否必选	参数类型	描述
time_range	是	String	用于指标查询时间范围，主要用于解决客户端时间和服务端时间不一致情况下，查询最近N分钟的数据。另可用于精确查询某一段时间的数据.查询时间范围，-1.-1.30(表示最近30分钟) 最小长度：0 最大长度：100
sort	否	Sort object	返回列表的排序方式

表4 Sort
参数	是否必选	参数类型	描述
order_by	否	Array of strings	排序字段列表数组长度：0 - 100
order	否	String	排序方式枚举值。asc代表正序，desc代表倒叙最小长度：0 最大长度：100

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
data	Array of AlarmInfo objects	告警列表数组长度：0 - 1000
count	Integer	总数最小值：0 最大值：1000

表6 AlarmInfo
参数	参数类型	描述
id	String	事件或者告警id，系统会自动生成，上报无须填写该字段最小长度：0 最大长度：100
starts_at	Long	事件或者告警产生的时间，CST毫秒级时间戳最小值：0 最大值：9223372036854775807
ends_at	Long	事件或者告警清除的时间，CST毫秒级时间戳，为0时表示未删除最小值：0 最大值：9223372036854775807
timeout	Long	告警自动清除时间。毫秒数，例如一分钟则填写为60000。默认清除时间为3天,对应数字为 4320 * 1000（即：3天 * 24小时 * 60分钟 * 1000毫秒）最小值：0 最大值：9223372036854775807
metadata	Object	事件或者告警的详细信息
annotations	Object	告警详情

状态码： 400

表7 响应Body参数
参数	参数类型	描述
code	String	状态码最小长度：3 最大长度：3
error_code	String	错误码最小长度：12 最大长度：12
error_msg	String	错误信息最小长度：1 最大长度：65535
message	String	错误详细信息最小长度：0 最大长度：65535

状态码： 401

表8 响应Body参数
参数	参数类型	描述
code	String	状态码最小长度：3 最大长度：3
error_code	String	错误码最小长度：12 最大长度：12
error_msg	String	错误信息最小长度：1 最大长度：65535
message	String	错误详细信息最小长度：0 最大长度：65535

状态码： 500

表9 响应Body参数
参数	参数类型	描述
code	String	状态码最小长度：3 最大长度：3
error_code	String	错误码最小长度：12 最大长度：12
error_msg	String	错误信息最小长度：1 最大长度：65535
message	String	错误详细信息最小长度：0 最大长度：65535

请求示例

{
  "time_range" : "-1.-1.30",
  "sort" : {
    "order_by" : [ "starts_at" ],
    "order" : "desc"
  }
}

响应示例

状态码： 200

请求成功

{
  "data" : [ {
    "id" : "3512004942693961460",
    "starts_at" : 1671518362723,
    "ends_at" : 1671518362723,
    "timeout" : 1440000,
    "metadata" : "string",
    "annotations" : "string"
  } ],
  "count" : 1
}

状态码： 400

请求参数校验不通过

{
  "code" : 400,
  "error_code" : "BCS.03400001",
  "error_msg" : "Invalid request.",
  "message" : "unmarshal request data error"
}

状态码： 401

鉴权失败

{
  "code" : 401,
  "error_code" : "BCS.03401001",
  "error_msg" : "Authorization failed.",
  "message" : "request token is not valid"
}

状态码： 500

服务内部执行错误

{
  "code" : 500,
  "error_code" : "BCS.03500001",
  "error_msg" : "Internal error.",
  "message" : "project [xxx] node [xxx] get service bearer user token error"
}

状态码

状态码	描述
200	请求成功
400	请求参数校验不通过
401	鉴权失败
500	服务内部执行错误

错误码

请参见错误码。

父主题： 节点监控

上一篇：获取节点监控信息

下一篇：获取节点某段时间的API调用信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消