CreateRuleFile--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateRuleFile

最近更新时间：2024.10.12 15:25:53首次发布时间：2023.06.30 15:23:33

创建 RecordingRule 规则文件。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateRuleFile	接口名称。当前 API 的名称为 `CreateRuleFile`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
WorkspaceId	String	是	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。可以调用 ListWorkspaces 接口，获取工作区 ID。
Name	String	是	test	规则文件名称： Linux 合法文件名，且长度小于 255。工作区内唯一。
Description	String	否	这是一段描述	规则文件描述信息，长度限制为 0～200 个字符。说明一个英文、一个中文、一个符号都定义为一个字符。
Content	String	是	{"groups": [{"name": "my_first_recording_rule", "rules": [{"expr": "up", "record": "up"}], "interval": "30s"}]}	规则文件内容，YAML 格式，内容长度如下：单个`expr`长度不能超过 16 KB。单个`record`不能超过 2,048 Bytes。单个`labelname`不能超过 256 Bytes。单个`labelvalue`不能超过 2,048 Bytes。

请求示例

POST https://open.volcengineapi.com/?Action=CreateRuleFile&Version=2021-03-03
Content-Type: application/json
{
    "WorkspaceId": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
    "Name": "test",
    "Description": "这是一段描述",
    "Content": "{\"groups\": [{\"name\": \"my_first_recording_rule\", \"rules\": [{\"expr\": \"up\", \"record\": \"up\"}], \"interval\": \"30s\"}]}"
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	RecordingRule 规则文件 ID。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateRuleFile",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	QuotaExceeded.RuleGroupCount	Rule Group count has exceeded the quota.	创建 rulefile 个数达到上限。
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 服务。
403	OperationDenied.Create	Operation is denied because RuleFile cannot be created in Workspace`s current status. \| 当前工作区状态下无法创建 rulefile。 \|
404	NotFound.Workspace	The specified Workspace {{id}} is not found.	未找到相应 ID 的工作区。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。