创建分派策略

创建分派策略，定义故障发生时通知谁以及何时通知。

POST /channel/escalate/rule/create

创建分派策略

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/channel/escalate/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_id": 3521074710131,
  "rule_name": "On-call escalation",
  "template_id": "6321aad26c12104586a88916",
  "description": "Notify primary on-call, then escalate to secondary after 30 minutes",
  "layers": [
    {
      "target": {
        "person_ids": [
          3790925372131
        ],
        "by": {
          "follow_preference": true
        }
      },
      "max_times": 3,
      "notify_step": 10,
      "escalate_window": 30,
      "force_escalate": false
    }
  ]
}
'

import requests

url = "https://api.flashcat.cloud/channel/escalate/rule/create?app_key="

payload = {
    "channel_id": 3521074710131,
    "rule_name": "On-call escalation",
    "template_id": "6321aad26c12104586a88916",
    "description": "Notify primary on-call, then escalate to secondary after 30 minutes",
    "layers": [
        {
            "target": {
                "person_ids": [3790925372131],
                "by": { "follow_preference": True }
            },
            "max_times": 3,
            "notify_step": 10,
            "escalate_window": 30,
            "force_escalate": False
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    channel_id: 3521074710131,
    rule_name: 'On-call escalation',
    template_id: '6321aad26c12104586a88916',
    description: 'Notify primary on-call, then escalate to secondary after 30 minutes',
    layers: [
      {
        target: {person_ids: [3790925372131], by: {follow_preference: true}},
        max_times: 3,
        notify_step: 10,
        escalate_window: 30,
        force_escalate: false
      }
    ]
  })
};

fetch('https://api.flashcat.cloud/channel/escalate/rule/create?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/channel/escalate/rule/create?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel_id' => 3521074710131,
    'rule_name' => 'On-call escalation',
    'template_id' => '6321aad26c12104586a88916',
    'description' => 'Notify primary on-call, then escalate to secondary after 30 minutes',
    'layers' => [
        [
                'target' => [
                                'person_ids' => [
                                                                3790925372131
                                ],
                                'by' => [
                                                                'follow_preference' => true
                                ]
                ],
                'max_times' => 3,
                'notify_step' => 10,
                'escalate_window' => 30,
                'force_escalate' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/channel/escalate/rule/create?app_key="

	payload := strings.NewReader("{\n  \"channel_id\": 3521074710131,\n  \"rule_name\": \"On-call escalation\",\n  \"template_id\": \"6321aad26c12104586a88916\",\n  \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n  \"layers\": [\n    {\n      \"target\": {\n        \"person_ids\": [\n          3790925372131\n        ],\n        \"by\": {\n          \"follow_preference\": true\n        }\n      },\n      \"max_times\": 3,\n      \"notify_step\": 10,\n      \"escalate_window\": 30,\n      \"force_escalate\": false\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/channel/escalate/rule/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"channel_id\": 3521074710131,\n  \"rule_name\": \"On-call escalation\",\n  \"template_id\": \"6321aad26c12104586a88916\",\n  \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n  \"layers\": [\n    {\n      \"target\": {\n        \"person_ids\": [\n          3790925372131\n        ],\n        \"by\": {\n          \"follow_preference\": true\n        }\n      },\n      \"max_times\": 3,\n      \"notify_step\": 10,\n      \"escalate_window\": 30,\n      \"force_escalate\": false\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/channel/escalate/rule/create?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channel_id\": 3521074710131,\n  \"rule_name\": \"On-call escalation\",\n  \"template_id\": \"6321aad26c12104586a88916\",\n  \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n  \"layers\": [\n    {\n      \"target\": {\n        \"person_ids\": [\n          3790925372131\n        ],\n        \"by\": {\n          \"follow_preference\": true\n        }\n      },\n      \"max_times\": 3,\n      \"notify_step\": 10,\n      \"escalate_window\": 30,\n      \"force_escalate\": false\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "rule_id": "69db2f72a0fe7db6448b1506",
    "rule_name": "Test escalation rule"
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	协作空间管理（on-call）

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json

创建分派策略所需的参数。

channel_id · integer<int64> · 必填

所属协作空间 ID。

template_id · string · 必填

通知模板 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$

rule_name · string · 必填

策略名称,1 到 39 个字符。

Required string length: 1 - 39

layers · object[] · 必填

分派环节列表,至少包含一个环节。

Show child attributes

priority · integer | null

匹配优先级,数值越小越优先。

必填范围: 0 <= x <= 200

aggr_window · integer

聚合窗口,单位秒,0 表示不聚合。

必填范围: 0 <= x <= 3600

description · string

策略描述,最多 500 个字符。

Maximum string length: 500

time_filters · object[]

可选的周期性生效时间窗口。

Show child attributes

filters · object[][]

或-与组合条件树。每个外层元素为一组 AND 条件,组内所有条件需同时满足。

Show child attributes

响应

200

application/json

成功

成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。

request_id · string · 必填

本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。

Show child attributes