查询阈值规则列表
功能介绍
该接口用于查询阈值规则列表。
URI
GET /v1/{project_id}/ams/alarms
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户从IAM申请到的projectid，一般为32位字符串。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
取值范围(0,1000]，默认值为1000。 用于限制结果数据条数。 |
|
start |
否 |
Long |
分页信息。从当前条数开始查询数据 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM获取的用户Project级别Token。 |
|
Content-Type |
是 |
String |
指定类型为application/json。 枚举值：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
响应码。 |
|
errorMessage |
String |
响应信息描述。 |
|
metaData |
MetaData object |
查询结果元数据信息，包括分页信息等。 |
|
thresholds |
Array of AlarmAPIQueryAlarmResult objects |
阈值规则列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
当前返回结果条数。 |
|
start |
String |
下一个开始的标记，用于分页，null表示无更多数据。 |
|
total |
Integer |
总条数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
idTurnOn |
Boolean |
阈值规则是否启用。 |
|
type |
String |
阈值规则类型。 |
|
policyName |
String |
阈值规则模板名称。 |
|
alarmName |
String |
阈值规则名称。 |
|
id |
String |
阈值规则ID。 |
|
alarmDescription |
String |
阈值规则描述。 |
|
actionEnabled |
Boolean |
是否启用通知。 |
|
okActions |
Array of strings |
恢复动作。 |
|
alarmActions |
Array of strings |
告警动作。 |
|
insufficientDataActions |
Array of strings |
数据不足动作。 |
|
stateValue |
String |
服务状态。 |
|
stateReason |
String |
原因描述。 |
|
stateUpdatedTimestamp |
String |
状态更新时间戳。 |
|
metricName |
String |
时间序列名称。 |
|
namespace |
String |
时间序列命名空间。 |
|
statistic |
String |
统计方式。 |
|
dimensions |
Array of Dimension objects |
时间序列维度。 |
|
resources |
Array of strings |
资源信息（已废弃）。 |
|
period |
Integer |
统计周期。 |
|
evaluationPeriods |
Integer |
持续周期个数。 |
|
unit |
String |
阈值单元。 |
|
threshold |
String |
临界值。 |
|
comparisonOperator |
String |
极限条件。 |
|
alarmAdvice |
String |
告警清除建议。 |
|
alarmLevel |
String |
告警级别。 |
请求示例
查询阈值规则列表
GET https://{Endpoint}/v1/{project_id}/ams/alarms
响应示例
状态码： 200
OK
请求响应成功。
{
"errorCode" : "SVCSTG_AMS_2000000",
"errorMessage" : "success",
"metaData" : {
"count" : 10,
"start" : null,
"total" : 100
},
"thresholds" : [ {
"id" : "2137",
"alarmName" : "aaaaaaaa",
"alarmDescription" : "",
"actionEnabled" : false,
"okActions" : [ ],
"alarmActions" : [ ],
"insufficientDataActions" : [ ],
"stateValue" : "alarm",
"stateReason" : "",
"stateUpdatedTimestamp" : null,
"metricName" : "cpuCoreLimit",
"namespace" : "PAAS.CONTAINER",
"statistic" : "average",
"dimensions" : [ {
"name" : "appName",
"value" : "rhm-broker"
} ],
"period" : 60000,
"evaluationPeriods" : 1,
"unit" : "Core",
"threshold" : "0",
"comparisonOperator" : ">=",
"alarmAdvice" : "",
"alarmLevel" : 3
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
|
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
|
503 |
ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。
