文档首页 > > API参考> API> 监控>

查询阈值规则列表

查询阈值规则列表

分享
更新时间:2020/12/24 GMT+08:00

功能介绍

该接口用于查询阈值规则列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/alarm-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

分页信息。

limit

Integer

取值范围[0,1000],默认值为1000。用于限制结果数据条数。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

Content-Type

String

指定类型为application/json。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

meta_data

MetaData object

查询结果元数据信息,包括分页信息等。

thresholds

Array of QueryAlarmResult objects

阈值规则列表。

表5 MetaData

参数

参数类型

描述

count

Integer

当前返回结果条数。

offset

String

下一个开始的标记,用于分页,null表示无更多数据。

total

Integer

总条数。

表6 QueryAlarmResult

参数

参数类型

描述

id_turn_on

Boolean

阈值规则是否启用。

type

String

阈值规则类型。

policy_name

String

阈值规则模板名称。

alarm_rule_name

String

阈值规则名称。

alarm_rule_id

String

阈值规则ID。

alarm_description

String

阈值规则描述。

action_enabled

Boolean

是否启用通知。

ok_actions

Array of strings

正常状态通知列表。

alarm_actions

Array of strings

告警状态通知列表。

insufficient_data_actions

Array of strings

数据不足通知列表。

state_value

String

服务状态。

state_reason

String

原因描述。

state_updated_timestamp

String

状态更新时间戳。

metric_name

String

时间序列名称。

namespace

String

时间序列命名空间。

statistic

String

统计方式。

dimensions

Array of Dimension objects

时间序列维度。

resources

String

资源信息(已废弃)。

period

Integer

统计周期。

evaluation_periods

Integer

间隔周期。

unit

String

阈值单元。

threshold

String

临界值。

comparison_operator

String

极限条件。

alarm_advice

String

告警清除建议。

alarm_level

Integer

告警级别。

表7 Dimension

参数

参数类型

描述

name

String

名称。

value

String

具体数值。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

error_type

String

错误类型。

请求示例

响应示例

状态码: 200

编码 OK 请求响应成功。

{
  "meta_data" : [ {
    "count" : 10,
    "offset" : null,
    "total" : 100
  } ],
  "thresholds" : [ {
    "alarm_rule_id" : 2137,
    "id_turn_on" : true,
    "type" : "single,",
    "policy_name" : "23,",
    "alarm_rule_name" : "aaaaaaaa",
    "alarm_description" : null,
    "ok_actions" : null,
    "alarm_actions" : null,
    "insufficient_data_actions" : null,
    "state_value" : "alarm",
    "state_reason" : null,
    "state_updated_timestamp" : null,
    "metric_name" : "cpuCoreLimit",
    "namespace" : "PAAS.CONTAINER",
    "statistic" : "average",
    "dimensions" : [ {
      "name" : "appName"
    }, {
      "value" : "rhm-broker"
    } ],
    "resources" : [ ],
    "period" : 60000,
    "evaluation_periods" : 1,
    "unit" : "Core",
    "threshold" : 0,
    "comparison_operator" : ">=",
    "alarm_advice" : null,
    "alarm_level" : 3
  } ]
}

状态码: 400

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

{
  "error_code" : "AOM.02003500",
  "error_msg" : "internal server error",
  "error_type" : "INTERNAL_SERVER_ERROR"
}

状态码

状态码

描述

200

编码 OK 请求响应成功。

400

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

401

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

403

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

500

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

503

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

错误码

请参见错误码

分享:

    相关文档

    相关产品