文档首页/ 应用运维管理 AOM/ API参考/ 历史API/ 监控(即将下线)/ 查询阈值规则列表(即将下线)
更新时间:2023-11-30 GMT+08:00
分享

查询阈值规则列表(即将下线)

功能介绍

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

URI

GET /v1/{project_id}/ams/alarms

替换接口请参考查询阈值规则列表

请求消息

请求参数

请求参数如表1所示。

表1 请求参数

参数

是否必选

参数类型

取值范围

描述

project_id

String

-

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

limit

Integer

(0,1000]

取值范围(0,1000],默认值为1000。

用于限制结果数据条数。

start

String

-

分页信息

Header说明

请求消息头(Header)如表2所示。

表2 Header说明

名称

是否必选

说明

X-Auth-Token

从IAM服务获取的用户Token。

Content-Type

指定类型为application/json。

响应消息

响应参数

响应参数如表3所示。

表3 响应参数

参数名称

类型

描述

errorCode

String

响应码。

errorMessage

String

响应信息描述。

metaData

Object

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

metaData.count

Integer

当前返回结果条数。

metaData.total

Integer

总条数。

metaData.start

String

下一个开始的标记,用于分页。

thresholds

Array

阈值规则列表。

响应示例

{ 
    "errorCode": "SVCSTG.AMS.2000", 
    "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 
    } 
    ] 
}

状态码

  • 正常

    状态码如表4所示。

    表4 状态码

    状态码

    编码

    描述

    200

    OK

    请求响应成功。

  • 异常

    状态码如表5所示。更多状态码请见状态码

    表5 状态码

    状态码

    编码

    描述

    400

    BadRequest

    非法请求。

    建议直接修改该请求,不要重试该请求。

    401

    Unauthorized

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

    403

    Forbidden

    请求被拒绝访问。

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

    500

    InternalServerError

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

    503

    ServiceUnavailable

    被请求的服务无效。

    建议直接修改该请求,不要重试该请求。

错误码

表6 错误码

错误码

错误信息

处理措施

SVCSTG_AMS_4000109

Invalid project ID.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000110

Invalid limit.

请检查对应的参数是否符合要求。

SVCSTG_AMS_4000111

Invalid start.

请检查对应的参数是否符合要求。

SVCSTG_AMS_5030001

The Cassandra session is null.

请联系技术支持工程师解决。

SVCSTG_AMS_5030002

The Cassandra execution is abnormal.

请联系技术支持工程师解决。

相关文档