获取告警规则列表。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListAlertingRules | 接口名称。当前 API 的名称为 ListAlertingRules 。 |
Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03 。 |
PageNumber | Long | 否 | 1 | 当前页数,最小值或默认值均为 1。 |
PageSize | Long | 否 | 10 | 单页数量:
|
Filter | Object of AlertingRuleFilter | 否 | - | 告警规则过滤条件。 |
SortBy | String | 否 | CreatedAt | 查询结果是否进行排序,取值CreatedAt 表示进行排序;不配置该字段表示不进行排序。 |
SortOrder | String | 否 | Asc | 查询结果的排序原则,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Ids | Array of String | 否 | ["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"] | 按告警规则 ID 过滤,精确查询。 |
Name | String | 否 | test | 按告警规则名称过滤,模糊查询。 |
Type | String | 否 | vmp/PromQL | 按告警规则类型过滤,精确查询。 |
WorkspaceId | String | 否 | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 按工作区 ID 过滤,精确查询。 |
NotifyPolicyIds | Array of String | 否 | ["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"] | 按通知策略 ID 过滤,精确查询。 |
NotifyGroupPolicyIds | Array of String | 否 | ["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"] | 按聚合策略 ID 过滤,精确查询。 |
Status | String | 否 | Running | 按告警规则状态过滤:
|
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" }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Total | Long | 100 | 告警规则总数。 |
Items | Array of AlertingRule | - | 告警规则列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 告警规则 ID。 |
CreateTime | String | 2020-01-01T00:00:00Z | 告警规则创建时间。 |
UpdateTime | String | 2020-01-01T00:00:00Z | 告警规则更新时间。 |
Name | String | myRule | 告警规则名称。 |
Description | String | 这是一段描述 | 告警规则描述信息。 |
Type | String | 这是一段描述 | 告警规则类型,固定取值为vmp/PromQL 。 |
Query | Object of AlertingRuleQuery | - | 告警配置。 |
Levels | Array of AlertingRuleLevel | - | 告警等级。 |
NotifyPolicyId | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 告警通知策略 ID。 |
NotifyGroupPolicyId | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 告警聚合策略 ID。 |
Status | String | Running | 告警规则状态:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
WorkspaceId | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 工作区 ID。 |
PromQL | String | sum(up) | 查询语句。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Level | String | P0 | 警规则等级,包括:P0、P1 和 P2。 |
For | String | 5m | 告警持续时间,取值:
|
Comparator | String | > | 告警规则比较条件,取值:
|
Threshold | Double | 1.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 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.{{parameter}} | The specified parameter {{parameter}} is invalid. | 指定的参数无效。 |
403 | ProductUnsubscribed | You 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 服务。 |