ListAlertingRules

获取告警规则列表。

请求说明

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

请求参数

AlertingRuleFilter

请求示例

POST /?Action=ListAlertingRules&Version=2021-03-03
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Ids": ["90b5a3da-3464-4718-92e4-039bf41d3cff"],
        "Name": "test",
        "Type": "vmp/PromQL",
        "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "NotifyPolicyIds": ["8cd7b480-6387-44e5-aea4-db4ca2c4b47a"],
        "NotifyGroupPolicyIds": ["ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf"],
        "Status": "Running"
    }
}

返回参数

AlertingRule

AlertingRuleQuery

AlertingRuleLevel

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListAlertingRules",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "90b5a3da-3464-4718-92e4-039bf41d3cff",
                "CreateTime": "2020-01-01T00:00:00Z",
                "UpdateTime": "2020-01-01T00:00:00Z",
                "Name": "myRule",
                "Description": "这是一段描述",
                "Type": "vmp/PromQL",
                "Query": {
                    "WorkspaceId": " e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                    "PromQL": " sum(up)"
                },
                "Levels": [
                    {
                        "Level": " P0",
                        "For": " 5m",
                        "Comparator": " >",
                        "Threshold": 
                    }
                ],
                "NotifyPolicyId": "8cd7b480-6387-44e5-aea4-db4ca2c4b47a",
                "NotifyGroupPolicyId": "ce4d942a-bac3-4ef6-b3a0-b7845b3b53bf",
                "Status": "Running"
            }
        ]
    }
}

错误码

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