You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

ListRules

最近更新时间：2024.04.19 11:53:53

首次发布时间：2023.06.30 15:23:34

我的收藏

获取 RecordingRule 规则列表。

请求说明

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

请求参数

参数名称类型是否必选示例值描述
ActionString是ListRules公共参数，本接口值：ListRules。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
PageNumberInteger否1当前页数，最小值或默认值均为 1。

PageSize

Integer

否

10

单页数量：

  • 取值范围为 0～100。
  • 默认值为 10。
FilterObject RuleFilter是-规则过滤条件。

RuleFilter

参数名称类型是否必选示例值描述
WorkspaceIdString是e28ae750-bbb8-4ff4-abf4-1e0e0f88808c按工作区 ID 过滤，精确查询。
KindString是Recording按规则类型过滤，固定取值为Recording。
NameString否test按规则名称过滤，模糊查询。
RuleFileNamesArray of String否["test"]按规则文件名称过滤，模糊查询。
RuleGroupNamesArray of String否["test"]按规则组名称过滤，模糊查询。

Status

Array of String

否

["Running"]

按规则状态过滤，精确查询。取值：

  • Running：运行中
  • Updating：更新中
  • OverdueShutted：欠费关停
  • Resuming：恢复中
  • Error：异常
  • Pending：挂起

请求示例

POST /?Action=ListRules&Version=2021-03-03
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "WorkspaceId": " e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "Kind": "Recording",
        "Name": "test",
        "RuleFileNames": ["test"],
        "RuleGroupNames": ["test"],
        "Status": ["Running"]
    }
}

返回参数

参数名称类型示例值描述
TotalInteger100规则总数。
ItemsArray of Rule-规则列表。

Rule

参数名称类型示例值描述
NameStringmy_first_recording_rule规则名称，支持模糊搜索。
RuleFileNameStringtest所属规则文件名称。
RuleGroupNameStringtest所属规则组名称。
KindStringRecording规则类型，固定值为Recording。
ExprStringsum(rate(container_cpu_usage_seconds_total[5m])) by (pod)规则中的 PromQL 表达式。
LabelsArray of LabelKeyValuePair在存储指标之前添加或覆盖的标签。

Status

String

Running

规则文件状态：

  • Running：运行中
  • Updating：更新中
  • OverdueShutted：欠费关停
  • Resuming：恢复中
  • Error：异常
  • Pending：挂起
LastEvaluationString2022-01-01T00:00:00Z最后执行时间，RFC3339 格式。
ReasonStringinternal error状态转为错误时的原因。

LabelKeyValuePair

参数名称类型示例值描述
KeyStringteam键
ValueStringoperations值

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListRules",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Name": "my_first_recording_rule",
                "RuleFileName": "test",
                "RuleGroupName": "test",
                "Kind": "Recording",
                "Expr": "sum(rate(container_cpu_usage_seconds_total[5m])) by (pod)",
                "Labels": [
                    {
                        "Key": " team",
                        "Value": " operations"
                    }
                ],
                "Status": "Running",
                "LastEvaluation": "2022-01-01T00:00:00Z",
                "Reason": "internal error"
            }
        ]
    }
}

错误码

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

HTTP 状态码错误码错误信息描述
404NotFound.IdThe specified Workspace {{id}} is not found.未找到指定的工作区。