创建专属集成
curl --request POST \
--url 'https://api.flashcat.cloud/channel/integration/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
'import requests
url = "https://api.flashcat.cloud/channel/integration/create?app_key="
payload = {
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
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: 20001,
plugin_type: 'standard.alert',
name: 'Payments alerts',
description: 'Alerts for the payments channel',
settings: {}
})
};
fetch('https://api.flashcat.cloud/channel/integration/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/integration/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' => 20001,
'plugin_type' => 'standard.alert',
'name' => 'Payments alerts',
'description' => 'Alerts for the payments channel',
'settings' => [
]
]),
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/integration/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\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/integration/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/integration/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\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"integration_id": 10001,
"integration_key": "0123456789abcdef0123456789abcdef100"
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestLocked",
"message": "Channel integration is being changed, please try again"
}
}{
"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."
}
}专属集成
创建专属集成
为已启用的协作空间创建专属告警集成。
POST
/
channel
/
integration
/
create
创建专属集成
curl --request POST \
--url 'https://api.flashcat.cloud/channel/integration/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
'import requests
url = "https://api.flashcat.cloud/channel/integration/create?app_key="
payload = {
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
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: 20001,
plugin_type: 'standard.alert',
name: 'Payments alerts',
description: 'Alerts for the payments channel',
settings: {}
})
};
fetch('https://api.flashcat.cloud/channel/integration/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/integration/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' => 20001,
'plugin_type' => 'standard.alert',
'name' => 'Payments alerts',
'description' => 'Alerts for the payments channel',
'settings' => [
]
]),
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/integration/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\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/integration/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/integration/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\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"integration_id": 10001,
"integration_key": "0123456789abcdef0123456789abcdef100"
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestLocked",
"message": "Channel integration is being changed, please try again"
}
}{
"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."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 300 次/分钟;20 次/秒 |
| 权限要求 | 协作空间管理(on-call) |
使用说明
- 这些接口管理协作空间专属集成;公共集成使用
/integration/*。 - App Key 的接口授权范围(
api_scopes)须允许本次操作;权限按 App Key 所属用户判断。 - 您还须拥有目标空间的管理权限:账户所有者、Admin、空间创建者,或管理团队成员。未设置管理团队时,按所属团队判断。
- 创建过这条集成不单独授予空间管理权限;集成中心管理权限也不授予本接口访问权。
- 目标空间必须已启用;集成类型须已启用、属于
event.alert,且您的订阅支持该类型。 - 已知
plugin_type时可直接创建,无需先查询类型。也可选用POST /integration/type/list查询告警类型;该接口支持协作空间查看、管理或集成中心查看权限,App Key 的api_scopes还须允许integration.api:read:typeList。 - 省略
name时使用集成类型的默认名称;省略integration_key时自动生成。自带 Key 须为 35 个字符、匹配账户后缀,且未被其他集成使用。 - 成功后返回
integration_id和integration_key;后续操作使用返回的integration_id。 - 每次调用均记录到账户审计日志。
- 同一空间的集成正在变更时返回
RequestLocked,请稍后重试。
授权
在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。
请求体
application/json
在已启用的协作空间创建专属集成。
目标协作空间 ID,空间须已启用。
必填范围:
x >= 1示例:
20001
已启用的告警集成类型标识,例如 standard.alert。
集成名称,提供时为 2–49 个字符;省略或为空时使用集成类型的默认名称。
集成描述,最多 499 个字符。
Maximum string length:
499可选的自带集成 Key;非空时须为 35 个字符、匹配账户后缀,且未被其他集成使用。
集成类型对应的配置;响应中已保存的密钥类值以 ****** 返回。
此页面对您有帮助吗?