创建故障

手动创建一个新故障并分派处理人员。

POST /incident/create

创建故障

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/incident/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "channel_id": 123,
  "assigned_to": {
    "person_ids": [
      123
    ],
    "escalate_rule_id": "<string>",
    "layer_idx": 123,
    "type": "<string>",
    "emails": [
      "[e-mail]"
    ],
    "notify": {
      "follow_preference": true,
      "personal_channels": [
        "<string>"
      ],
      "template_id": "<string>"
    }
  },
  "fields": {}
}
'

import requests

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

payload = {
    "title": "<string>",
    "description": "<string>",
    "channel_id": 123,
    "assigned_to": {
        "person_ids": [123],
        "escalate_rule_id": "<string>",
        "layer_idx": 123,
        "type": "<string>",
        "emails": ["[e-mail]"],
        "notify": {
            "follow_preference": True,
            "personal_channels": ["<string>"],
            "template_id": "<string>"
        }
    },
    "fields": {}
}
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({
    title: '<string>',
    description: '<string>',
    channel_id: 123,
    assigned_to: {
      person_ids: [123],
      escalate_rule_id: '<string>',
      layer_idx: 123,
      type: '<string>',
      emails: ['[e-mail]'],
      notify: {
        follow_preference: true,
        personal_channels: ['<string>'],
        template_id: '<string>'
      }
    },
    fields: {}
  })
};

fetch('https://api.flashcat.cloud/incident/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/incident/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([
    'title' => '<string>',
    'description' => '<string>',
    'channel_id' => 123,
    'assigned_to' => [
        'person_ids' => [
                123
        ],
        'escalate_rule_id' => '<string>',
        'layer_idx' => 123,
        'type' => '<string>',
        'emails' => [
                '[e-mail]'
        ],
        'notify' => [
                'follow_preference' => true,
                'personal_channels' => [
                                '<string>'
                ],
                'template_id' => '<string>'
        ]
    ],
    'fields' => [
        
    ]
  ]),
  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/incident/create?app_key="

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"channel_id\": 123,\n  \"assigned_to\": {\n    \"person_ids\": [\n      123\n    ],\n    \"escalate_rule_id\": \"<string>\",\n    \"layer_idx\": 123,\n    \"type\": \"<string>\",\n    \"emails\": [\n      \"[e-mail]\"\n    ],\n    \"notify\": {\n      \"follow_preference\": true,\n      \"personal_channels\": [\n        \"<string>\"\n      ],\n      \"template_id\": \"<string>\"\n    }\n  },\n  \"fields\": {}\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/incident/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"channel_id\": 123,\n  \"assigned_to\": {\n    \"person_ids\": [\n      123\n    ],\n    \"escalate_rule_id\": \"<string>\",\n    \"layer_idx\": 123,\n    \"type\": \"<string>\",\n    \"emails\": [\n      \"[e-mail]\"\n    ],\n    \"notify\": {\n      \"follow_preference\": true,\n      \"personal_channels\": [\n        \"<string>\"\n      ],\n      \"template_id\": \"<string>\"\n    }\n  },\n  \"fields\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/incident/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  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"channel_id\": 123,\n  \"assigned_to\": {\n    \"person_ids\": [\n      123\n    ],\n    \"escalate_rule_id\": \"<string>\",\n    \"layer_idx\": 123,\n    \"type\": \"<string>\",\n    \"emails\": [\n      \"[e-mail]\"\n    ],\n    \"notify\": {\n      \"follow_preference\": true,\n      \"personal_channels\": [\n        \"<string>\"\n      ],\n      \"template_id\": \"<string>\"\n    }\n  },\n  \"fields\": {}\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "incident_id": "69db2ef1a0fe7db6448b14f1",
    "title": "API test incident for docs"
  }
}

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

​

使用说明

• 账户的创建表单生效时，必须提供其中可见的自定义字段和必填系统字段。
• 如需在创建时附加图片，请使用 multipart/form-data：在 data 中传 JSON 请求体，在 images 中传文件；完整请求不得超过 50 MiB。
• 已审计 —— 变更会记录到审计日志。

授权

app_key · string · query · 必填

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

请求体

application/jsonmultipart/form-data

手动创建故障所需的参数。

incident_severity · enum<string> · 必填

故障严重程度。

可用选项: Info, Warning, Critical

title · string

故障标题,最多 512 个字符。

Maximum string length: 512

description · string

故障描述,最多 1024 个字符。

Maximum string length: 1024

channel_id · integer<int64>

归属的协作空间 ID,留空表示独立故障。

assigned_to · object

故障处理人员指派目标。person_ids 与 escalate_rule_id 至少设置一项。

Show child attributes

fields · object

以字段名为键的自定义字段值。创建表单生效时，只接受表单中可见的字段。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

手动创建故障的返回结果。

Show child attributes