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

查询单条阈值规则

功能介绍

该接口用于查询单条阈值规则。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/alarm-rules/{alarm_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

alarm_rule_id

是

String

阈值规则ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

meta_data

MetaData object

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

thresholds

Array of QueryAlarmResult objects

阈值规则列表。
表4 MetaData

参数

参数类型

描述

count

Integer

当前返回结果条数。

start

String

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

total

Integer

总条数。
表5 QueryAlarmResult

参数

参数类型

描述

action_enabled

Boolean

是否启用通知。

alarm_actions

Array of strings

告警状态通知列表。

alarm_advice

String

告警清除建议。

alarm_description

String

阈值规则描述。

alarm_level

String

告警级别。

alarm_rule_id

String

阈值规则ID。

alarm_rule_name

String

阈值规则名称。

comparison_operator

String

极限条件。

dimensions

Array of Dimension objects

时间序列维度。

evaluation_periods

Integer

间隔周期。

id_turn_on

Boolean

阈值规则是否启用。

insufficient_data_actions

Array of strings

数据不足通知列表。

metric_name

String

时间序列名称。

namespace

String

时间序列命名空间。

ok_actions

Array of strings

正常状态通知列表。

period

Integer

统计周期。

policy_name

String

阈值规则模板名称。

resources

Array of strings

资源信息(已废弃)。

state_reason

String

原因描述。

state_updated_timestamp

String

状态更新时间戳。

state_value

String

服务状态。

statistic

String

统计方式。

threshold

String

临界值。

type

String

阈值规则类型。

unit

String

阈值单元。
表6 Dimension

参数

参数类型

描述

name

String

维度名称。

value

String

维度取值。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息描述。

error_type

String

错误类型。

trace_id

String

跟踪编号。主要用于开发人员快速搜索日志，定位问题。当返回的状态码为2xx时，trace_id为空；当返回4xx的状态码时，trace_id不为空。

请求示例

获取一条告警规则ID为 “alarm_rule_id” 的告警规则的详细内容。

https://{Endpoint}/v2/{project_id}/alarm-rules/{alarm_rule_id}

响应示例

状态码： 200

OK 请求响应成功。

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

状态码： 400

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

{
  "error_code" : "AOM.02004115",
  "error_msg" : "Invalid request parameter",
  "error_type" : "BAD_REQUEST",
  "trace_id" : ""
}

状态码

状态码

描述

200

OK 请求响应成功。

400

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

401

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

403

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

500

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

503

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

错误码

请参见错误码。

父主题： 监控