GetRuleFile--托管 Prometheus-火山引擎

文档中心

立即注册

导航

GetRuleFile

最近更新时间：2025.05.22 15:52:58首次发布时间：2023.06.30 15:23:34

查询 RecordingRule 规则文件详情。

请求说明

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

请求参数

说明

Id 和 WorkspaceId + Name 不能同时配置，但至少需要选择一种：

可以通过 Id 直接指定需要查询的规则文件。
可以通过 WorkspaceId + Name 在工作区内，通过名称指定需要查询的规则文件。

参数	类型	是否必选	示例值	描述
Action	String	是	GetRuleFile	接口名称。当前 API 的名称为 `GetRuleFile`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Id	String	否	1c3f6e48-b5e1-4832-8564-10eaac12a22c	规则文件 ID。
WorkspaceId	String	否	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID，必须和`Name`同时配置。
Name	String	否	test	规则文件名称，必须和`WorkspaceId`同时配置。

请求示例

POST https://open.volcengineapi.com/?Action=GetRuleFile&Version=2021-03-03
Content-Type: application/json
{
    "Id": "1c3f6e48-b5e1-4832-8564-10eaac12a22c",
    "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
    "Name": "test"
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	规则文件 ID。
CreateTime	String	2022-01-01T00:00:00Z	规则文件创建时间，RFC3339 格式。
LastUpdateTime	String	2022-01-01T00:00:00Z	规则文件最近更新时间，RFC3339 格式。
Name	String	test	规则文件名称。
Description	String	这是一段描述	规则文件描述信息。
Content	String	`groups: - name: example rules: - record: test expr: up`	规则文件内容。
Status	String	Running	规则文件状态： Creating：创建中 Running：运行中 Updating：更新中 OverdueShutted：欠费关停 Resuming：恢复中
RuleCount	Long	2	规则文件中的规则数。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "GetRuleFile",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": " 1c3f6e48-b5e1-4832-8564-10eaac12a22c",
        "CreateTime": "2022-01-01T00:00:00Z",
        "LastUpdateTime": "2022-01-01T00:00:00Z",
        "Name": "test",
        "Description": "这是一段描述",
        "content": "groups:\n- name: example\n  rules:\n  - expr: up\n    record: test\n",
        "Status": "Running",
        "RuleCount": 2
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
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 的工作区。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。