创建或更新路由规则

创建或更新集成的路由规则，将告警导向特定协作空间。cases 与 default 至少需要提供其一。

POST /route/upsert

创建或更新路由规则

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/route/upsert?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": 6113996590131,
  "cases": [
    {
      "if": [
        {
          "key": "severity",
          "oper": "IN",
          "vals": [
            "Critical"
          ]
        }
      ],
      "channel_ids": [
        3521074710131
      ],
      "fallthrough": false,
      "routing_mode": "standard"
    }
  ],
  "default": {
    "channel_ids": [
      3521074710131
    ]
  }
}
'

import requests

url = "https://api.flashcat.cloud/route/upsert?app_key="

payload = {
    "integration_id": 6113996590131,
    "cases": [
        {
            "if": [
                {
                    "key": "severity",
                    "oper": "IN",
                    "vals": ["Critical"]
                }
            ],
            "channel_ids": [3521074710131],
            "fallthrough": False,
            "routing_mode": "standard"
        }
    ],
    "default": { "channel_ids": [3521074710131] }
}
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({
    integration_id: 6113996590131,
    cases: [
      {
        if: [{key: 'severity', oper: 'IN', vals: ['Critical']}],
        channel_ids: [3521074710131],
        fallthrough: false,
        routing_mode: 'standard'
      }
    ],
    default: {channel_ids: [3521074710131]}
  })
};

fetch('https://api.flashcat.cloud/route/upsert?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/route/upsert?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([
    'integration_id' => 6113996590131,
    'cases' => [
        [
                'if' => [
                                [
                                                                'key' => 'severity',
                                                                'oper' => 'IN',
                                                                'vals' => [
                                                                                                                                'Critical'
                                                                ]
                                ]
                ],
                'channel_ids' => [
                                3521074710131
                ],
                'fallthrough' => false,
                'routing_mode' => 'standard'
        ]
    ],
    'default' => [
        'channel_ids' => [
                3521074710131
        ]
    ]
  ]),
  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/route/upsert?app_key="

	payload := strings.NewReader("{\n  \"integration_id\": 6113996590131,\n  \"cases\": [\n    {\n      \"if\": [\n        {\n          \"key\": \"severity\",\n          \"oper\": \"IN\",\n          \"vals\": [\n            \"Critical\"\n          ]\n        }\n      ],\n      \"channel_ids\": [\n        3521074710131\n      ],\n      \"fallthrough\": false,\n      \"routing_mode\": \"standard\"\n    }\n  ],\n  \"default\": {\n    \"channel_ids\": [\n      3521074710131\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/route/upsert?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_id\": 6113996590131,\n  \"cases\": [\n    {\n      \"if\": [\n        {\n          \"key\": \"severity\",\n          \"oper\": \"IN\",\n          \"vals\": [\n            \"Critical\"\n          ]\n        }\n      ],\n      \"channel_ids\": [\n        3521074710131\n      ],\n      \"fallthrough\": false,\n      \"routing_mode\": \"standard\"\n    }\n  ],\n  \"default\": {\n    \"channel_ids\": [\n      3521074710131\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/route/upsert?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  \"integration_id\": 6113996590131,\n  \"cases\": [\n    {\n      \"if\": [\n        {\n          \"key\": \"severity\",\n          \"oper\": \"IN\",\n          \"vals\": [\n            \"Critical\"\n          ]\n        }\n      ],\n      \"channel_ids\": [\n        3521074710131\n      ],\n      \"fallthrough\": false,\n      \"routing_mode\": \"standard\"\n    }\n  ],\n  \"default\": {\n    \"channel_ids\": [\n      3521074710131\n    ]\n  }\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {}
}

{
  "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

创建或更新集成路由规则的参数。当指定集成尚无规则时执行创建,否则覆盖原有规则。cases 与 default 至少需要提供其一。

integration_id · integer<int64> · 必填

所属集成 ID。

cases · object[]

有序的 case 分支列表,自上而下依次匹配。

Show child attributes

sections · object[]

可选的分区,用于将连续的 case 进行视觉分组。

Show child attributes

default · object

默认分支。当所有 case 均未命中(或命中的 case 没有有效协作空间)时使用。

Show child attributes

version · integer<int64>

用于乐观并发控制的当前版本号,传入最近一次读取时返回的值。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

空响应体。成功时服务端返回 data: null。