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

CreateRuleFile

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

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

我的收藏

创建 RecordingRule 规则文件。

请求说明

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

请求参数

参数名称类型是否必选示例值描述
ActionString是CreateRuleFile公共参数，本接口值：CreateRuleFile。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
WorkspaceIdString是e28ae750-bbb8-4ff4-abf4-1e0e0f88808c工作区 ID。

Name

String

是

test

规则文件名称：

  • Linux 合法文件名，且长度小于 255。
  • 工作区内唯一。

Description

String

否

这是一段描述

规则文件描述信息，长度限制为 0～200 个字符。

说明

一个英文、一个中文、一个符号都定义为一个字符。

Content

String

是

groups:
- name: example
  interval：60s
  rules:
    - record: <string>
      expr: <string>
      labels:
        [ <labelname>: <labelvalue> ]

规则文件内容:

  • 单个expr长度不能超过 16 KB。

  • 单个record不能超过 2,048 Bytes。

  • 单个labelname不能超过 256 Bytes。

  • 单个labelvalue不能超过 2,048 Bytes。

请求示例

POST /?Action=CreateRuleFile&Version=2021-03-03
Content-Type:application/json
{
    "WorkspaceId": " e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
    "Name": " test",
    "Description": "这是一段描述",
    "Content": "xxxxxxxx"
}

返回参数

参数名称类型示例值描述
IdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808cRecordingRule 规则文件 ID。

返回示例

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

错误码

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

HTTP 状态码错误码错误信息描述
400QuotaExceeded.RuleGroupCountRule Group count has exceeded the quota.创建 RuleFile 个数达到上限。产品限制说明，请参见 使用限制。
403OperationDenied.CreateOperation is denied because RuleFile cannot be created in Workspace`s current status.当前工作区状态下无法创建 RuleFile。
404NotFound.IdThe specified Workspace {{id}} is not found.未找到指定的工作区。
409Conflict.NameThe specified name conflicts with existing RuleFile.同一工作区下，不能有相同名称的规则文件。