评论故障
curl --request POST \
--url 'https://api.flashcat.cloud/incident/comment?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"incident_ids": [
"69da451ef77b1b51f40e83ee"
],
"comment": "Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.",
"comment_type_id": "6a5895d672a064bc2d3ddfc2"
}
'import requests
url = "https://api.flashcat.cloud/incident/comment?app_key="
payload = {
"incident_ids": ["69da451ef77b1b51f40e83ee"],
"comment": "Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.",
"comment_type_id": "6a5895d672a064bc2d3ddfc2"
}
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({
incident_ids: ['69da451ef77b1b51f40e83ee'],
comment: 'Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.',
comment_type_id: '6a5895d672a064bc2d3ddfc2'
})
};
fetch('https://api.flashcat.cloud/incident/comment?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/comment?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([
'incident_ids' => [
'69da451ef77b1b51f40e83ee'
],
'comment' => 'Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.',
'comment_type_id' => '6a5895d672a064bc2d3ddfc2'
]),
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/comment?app_key="
payload := strings.NewReader("{\n \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\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/comment?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/incident/comment?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 \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\n}"
response = http.request(request)
puts response.read_body{
"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."
}
}故障信息
评论故障
在故障时间线上添加文字评论。
POST
/
incident
/
comment
评论故障
curl --request POST \
--url 'https://api.flashcat.cloud/incident/comment?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"incident_ids": [
"69da451ef77b1b51f40e83ee"
],
"comment": "Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.",
"comment_type_id": "6a5895d672a064bc2d3ddfc2"
}
'import requests
url = "https://api.flashcat.cloud/incident/comment?app_key="
payload = {
"incident_ids": ["69da451ef77b1b51f40e83ee"],
"comment": "Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.",
"comment_type_id": "6a5895d672a064bc2d3ddfc2"
}
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({
incident_ids: ['69da451ef77b1b51f40e83ee'],
comment: 'Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.',
comment_type_id: '6a5895d672a064bc2d3ddfc2'
})
};
fetch('https://api.flashcat.cloud/incident/comment?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/comment?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([
'incident_ids' => [
'69da451ef77b1b51f40e83ee'
],
'comment' => 'Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.',
'comment_type_id' => '6a5895d672a064bc2d3ddfc2'
]),
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/comment?app_key="
payload := strings.NewReader("{\n \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\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/comment?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/incident/comment?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 \"incident_ids\": [\n \"69da451ef77b1b51f40e83ee\"\n ],\n \"comment\": \"Root cause identified. [@Jane Doe](flashduty://ref/member/2476444212131) please verify the fix.\",\n \"comment_type_id\": \"6a5895d672a064bc2d3ddfc2\"\n}"
response = http.request(request)
puts response.read_body{
"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) |
使用说明
- 要提及成员,在
comment中嵌入形如[@显示名](flashduty://ref/member/<member_id>)的 markdown 链接。被提及的成员会收到专门的个人通知,不受mute_reply影响。 - 不带链接语法的纯
@名字文本不会形成提及。 - 服务端会将每个提及的显示名改写为成员的规范名称。
授权
在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。
请求体
application/json
为故障添加评论的参数。
目标故障 ID 列表,单次最多 100 条。
Required array length:
1 - 100 elementsPattern:
^[0-9a-fA-F]{24}$评论内容。首尾空白会被去除;去除后必须非空,且最多 1024 字符(按 @提及归一化后计数)。
Maximum string length:
1024为 true 时不触发 webhook 回复动作。
可选,附加到评论的账户级评论类型 ID(MongoDB ObjectID)。无效或全零 ID 将返回 400。
Pattern:
^[0-9a-fA-F]{24}$此页面对您有帮助吗?
⌘I