创建协作空间

创建一个新的协作空间用于故障管理。

POST /channel/create

创建协作空间

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/channel/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_id": 3521074710131,
  "channel_name": "Production Alerts",
  "description": "Handles all production environment alerts",
  "group": {
    "method": "p",
    "time_window": 10,
    "window_type": "tumbling"
  },
  "auto_resolve_timeout": 86400,
  "auto_resolve_mode": "trigger"
}
'

import requests

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

payload = {
    "team_id": 3521074710131,
    "channel_name": "Production Alerts",
    "description": "Handles all production environment alerts",
    "group": {
        "method": "p",
        "time_window": 10,
        "window_type": "tumbling"
    },
    "auto_resolve_timeout": 86400,
    "auto_resolve_mode": "trigger"
}
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({
    team_id: 3521074710131,
    channel_name: 'Production Alerts',
    description: 'Handles all production environment alerts',
    group: {method: 'p', time_window: 10, window_type: 'tumbling'},
    auto_resolve_timeout: 86400,
    auto_resolve_mode: 'trigger'
  })
};

fetch('https://api.flashcat.cloud/channel/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/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([
    'team_id' => 3521074710131,
    'channel_name' => 'Production Alerts',
    'description' => 'Handles all production environment alerts',
    'group' => [
        'method' => 'p',
        'time_window' => 10,
        'window_type' => 'tumbling'
    ],
    'auto_resolve_timeout' => 86400,
    'auto_resolve_mode' => 'trigger'
  ]),
  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/create?app_key="

	payload := strings.NewReader("{\n  \"team_id\": 3521074710131,\n  \"channel_name\": \"Production Alerts\",\n  \"description\": \"Handles all production environment alerts\",\n  \"group\": {\n    \"method\": \"p\",\n    \"time_window\": 10,\n    \"window_type\": \"tumbling\"\n  },\n  \"auto_resolve_timeout\": 86400,\n  \"auto_resolve_mode\": \"trigger\"\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/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"team_id\": 3521074710131,\n  \"channel_name\": \"Production Alerts\",\n  \"description\": \"Handles all production environment alerts\",\n  \"group\": {\n    \"method\": \"p\",\n    \"time_window\": 10,\n    \"window_type\": \"tumbling\"\n  },\n  \"auto_resolve_timeout\": 86400,\n  \"auto_resolve_mode\": \"trigger\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/channel/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  \"team_id\": 3521074710131,\n  \"channel_name\": \"Production Alerts\",\n  \"description\": \"Handles all production environment alerts\",\n  \"group\": {\n    \"method\": \"p\",\n    \"time_window\": 10,\n    \"window_type\": \"tumbling\"\n  },\n  \"auto_resolve_timeout\": 86400,\n  \"auto_resolve_mode\": \"trigger\"\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "channel_id": 6294542005131,
    "channel_name": "API Test Channel"
  }
}

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

创建协作空间所需的参数。

team_id · integer<int64> · 必填

所属团队 ID。

channel_name · string · 必填

协作空间名称,1 到 59 个字符。

Required string length: 1 - 59

managing_team_ids · integer<int64>[]

可管理该协作空间的其他团队 ID,最多 3 个。

Maximum array length: 3

description · string

描述信息,最多 500 个字符。

Maximum string length: 500

escalate_rule · object

协作空间的默认分派策略,不需要时可省略。

Show child attributes

group · object

告警聚合配置。

Show child attributes

flapping · object

抖动检测配置。

Show child attributes

auto_resolve_timeout · integer<int64>

自动恢复超时,单位秒。0 表示不自动恢复,最长 30 天。

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

auto_resolve_mode · enum<string>

自动恢复计时重置方式。

可用选项: trigger, update

plugin_ids · integer<int64>[]

订阅该协作空间的集成 ID 列表。

is_private · boolean

为 true 时仅管理团队可见。

disable_outlier_detection · boolean

禁用新奇故障检测。

disable_auto_close · boolean

禁用故障自动关闭。

is_external_report_enabled · boolean

允许外部上报人向该协作空间上报故障。

响应

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