ListRules--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListRules

最近更新时间：2024.09.03 15:42:17首次发布时间：2023.06.30 15:23:34

获取 RecordingRule 规则列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListRules	接口名称。当前 API 的名称为 `ListRules`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量：取值范围为 0～100。默认值为 10。
Filter	Object of RuleFilter	否	-	规则过滤条件。

RuleFilter

参数	类型	是否必选	示例值	描述
WorkspaceId	String	是	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	按工作区 ID 过滤，精确查询。
Kind	String	是	Recording	按规则类型过滤，固定取值为`Recording`。
Name	String	否	test	按规则名称过滤，模糊查询。
RuleFileNames	Array of String	否	["test"]	按规则文件名称过滤，模糊查询。
RuleGroupNames	Array of String	否	["test"]	按规则组名称过滤，模糊查询。
Status	Array of String	否	["Running"]	按规则状态过滤，精确查询。取值： Running：运行中 Updating：更新中 OverdueShutted：欠费关停 Resuming：恢复中 Error：异常 Pending：挂起

请求示例

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

返回参数

参数	类型	示例值	描述
Total	Long	100	规则总数。
Items	Array of Rule	-	规则列表。

Rule

参数	类型	示例值	描述
Name	String	my_first_recording_rule	规则名称，支持模糊搜索。
RuleFileName	String	test	所属规则文件名称。
RuleGroupName	String	test	所属规则组名称。
Kind	String	Recording	规则类型，固定值为`Recording`。
Expr	String	sum(rate(container_cpu_usage_seconds_total[5m])) by (pod)	规则中的 PromQL 表达式。
Labels	Array of LabelKeyValuePair	-	在存储指标之前添加或覆盖的标签。
Status	String	Running	规则文件状态： Running：运行中 Updating：更新中 OverdueShutted：欠费关停 Resuming：恢复中 Error：异常 Pending：挂起
LastEvaluation	String	2022-01-01T00:00:00Z	最后执行时间，RFC3339 格式。
Reason	String	internal error	状态转为错误时的原因。

LabelKeyValuePair

参数	类型	示例值	描述
Key	String	key	键
Value	String	value	值

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
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 服务。
404	NotFound.Workspace	The specified Workspace {{id}} is not found.	未找到相应 ID 的工作区。