4.1 监控
4.1.10 查询阈值规则列表
功能介绍
该接口用于查询阈值规则列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/alarm-rules
表4-85 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户从IAM申请到的projectid,一 般为32位字符串。
表4-86 Query 参数
参数 是否必选 参数类型 描述
offset 否 String 分页信息。
limit 否 Integer 用于限制结果数据条数。 取值
范围(0,1000],默认值为1000。
请求参数
表4-87 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 从IAM服务获取的用户Token。
Content-Type 是 String 指定类型为application/json。
响应参数
状态码： 200
表4-88 响应 Body 参数
参数 参数类型 描述
meta_data MetaData
object 查询结果元数据信息，包括分页信息等。
thresholds Array of QueryAlarmR esult objects
阈值规则查询参数。
表4-89 MetaData
参数 参数类型 描述
count Integer 当前返回结果条数。
start String 下一个开始的标记，用于分页，null表示无更多 数据。
total Integer 总条数。
表4-90 QueryAlarmResult
参数 参数类型 描述
action_enable
d Boolean 是否启用通知。
alarm_actions Array of
strings 告警状态通知列表。
alarm_advice String 告警清除建议。
alarm_descrip
tion String 阈值规则描述。
参数 参数类型 描述 alarm_level String 告警级别。
alarm_rule_id String 阈值规则ID。
alarm_rule_na
me String 阈值规则名称。
comparison_o
perator String 极限条件。
dimensions Array of Dimension objects
时间序列维度。
evaluation_pe
riods Integer 间隔周期。
id_turn_on Boolean 阈值规则是否启用。
insufficient_d
ata_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 阈值单元。
表4-91 Dimension
参数 参数类型 描述
name String 维度名称。
value String 维度取值。
状态码： 400
表4-92 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误信息描述。
error_type String 错误类型。
trace_id String 跟踪编号
请求示例
无
响应示例
状态码： 200 OK 请求响应成功。
{ "meta_data" : [ { "count" : 10, "offset" : null, "total" : 100 } ],
"thresholds" : [ { "alarm_actions" : null, "alarm_advice" : null, "alarm_description" : null, "alarm_level" : 3, "alarm_rule_id" : 2137,
"alarm_rule_name" : "aaaaaaaa", "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, "state_value" : "alarm",
"statistic" : "average", "threshold" : 0, "type" : "single,", "unit" : "Core"
} ] }
状态码： 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 被请求的服务无效。建议直接修改该请求,不要重试 该请求。
错误码
请参见错误码。