You need to enable JavaScript to run this app.
导航
ListAlertingRules
最近更新时间:2024.09.03 15:42:18首次发布时间:2023.06.30 15:23:34

获取告警规则列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=ListAlertingRules&Version=2021-03-03

请求参数

参数类型是否必选示例值描述
ActionStringListAlertingRules接口名称。当前 API 的名称为 ListAlertingRules
VersionString2021-03-03接口版本。当前 API 的版本为 2021-03-03
PageNumberLong1当前页数,最小值或默认值均为 1。

PageSize

Long

10

单页数量:

  • 取值范围为 0~100。
  • 默认值为 10。
FilterObject of AlertingRuleFilter-告警规则过滤条件。
SortByStringCreatedAt查询结果是否进行排序,取值CreatedAt表示进行排序;不配置该字段表示不进行排序。

SortOrder

String

Asc

查询结果的排序原则,取值:

  • Asc:表示按照升序排序。
  • Desc:表示按照降序排序。

AlertingRuleFilter

参数类型是否必选示例值描述
IdsArray of String["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]按告警规则 ID 过滤,精确查询。
NameStringtest按告警规则名称过滤,模糊查询。
TypeStringvmp/PromQL按告警规则类型过滤,精确查询。
WorkspaceIdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c按工作区 ID 过滤,精确查询。
NotifyPolicyIdsArray of String["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]按通知策略 ID 过滤,精确查询。
NotifyGroupPolicyIdsArray of String["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]按聚合策略 ID 过滤,精确查询。

Status

String

Running

按告警规则状态过滤:

  • Running:监控中
  • Disabled:已停用

请求示例

POST https://open.volcengineapi.com/?Action=ListAlertingRules&Version=2021-03-03
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Name": "test",
        "Type": "vmp/PromQL",
        "Status": "Running",
        "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "NotifyPolicyIds": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "NotifyGroupPolicyIds": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ]
    },
    "SortBy": "CreatedAt",
    "SortOrder": "Asc"
}

返回参数

参数类型示例值描述
TotalLong100告警规则总数。
ItemsArray of AlertingRule-告警规则列表。

AlertingRule

参数类型示例值描述
IdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c告警规则 ID。
CreateTimeString2020-01-01T00:00:00Z告警规则创建时间。
UpdateTimeString2020-01-01T00:00:00Z告警规则更新时间。
NameStringmyRule告警规则名称。
DescriptionString这是一段描述告警规则描述信息。
TypeString这是一段描述告警规则类型,固定取值为vmp/PromQL
QueryObject of AlertingRuleQuery-告警配置。
LevelsArray of AlertingRuleLevel-告警等级。
NotifyPolicyIdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c告警通知策略 ID。
NotifyGroupPolicyIdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c告警聚合策略 ID。

Status

String

Running

告警规则状态:

  • Running:监控中
  • Disabled:已停用

AlertingRuleQuery

参数类型示例值描述
WorkspaceIdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c工作区 ID。
PromQLStringsum(up)查询语句。

AlertingRuleLevel

参数类型示例值描述
LevelStringP0警规则等级,包括:P0、P1 和 P2。

For

String

5m

告警持续时间,取值:

  • 0s:立即触发
  • 1m:1分钟
  • 2m:2分钟
  • 5m:5分钟
  • 10m:10分钟

Comparator

String

>

告警规则比较条件,取值:

  • > :大于
  • >= :大于等于
  • < :小于
  • <= :小于等于
  • == :等于
  • != :不等于
ThresholdDouble1.0告警规则阈值。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListAlertingRules",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "Name": "myRule",
                "Type": "这是一段描述",
                "Query": {
                    "PromQL": "sum(up)",
                    "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
                },
                "Levels": [
                    {
                        "For": "5m",
                        "Level": "P0",
                        "Threshold": 1,
                        "Comparator": ">"
                    }
                ],
                "Status": "Running",
                "CreateTime": "2020-01-01T00:00:00Z",
                "UpdateTime": "2020-01-01T00:00:00Z",
                "Description": "这是一段描述",
                "NotifyPolicyId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "NotifyGroupPolicyId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
            }
        ]
    }
}

错误码

本接口错误码如下表所示,公共错误码请参见 公共错误码

HTTP 状态码错误码错误信息说明
400InvalidParameter.{{parameter}}The specified parameter {{parameter}} is invalid.指定的参数无效。
403ProductUnsubscribedYou are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service当前账号未订阅 VMP 服务。