跳转到主要内容
POST
/
field
/
info
查看自定义字段
curl --request POST \
  --url 'https://api.flashcat.cloud/field/info?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_id": "66e9d3a4f7c2b04a1c8a91b3"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "account_id": 80001,
    "field_id": "66e9d3a4f7c2b04a1c8a91b3",
    "field_name": "severity_class",
    "display_name": "Severity Class",
    "description": "Business severity tier.",
    "field_type": "single_select",
    "value_type": "string",
    "options": [
      "Critical",
      "High",
      "Medium",
      "Low"
    ],
    "default_value": "Medium",
    "status": "enabled",
    "creator_id": 80011,
    "updated_by": 80011,
    "created_at": 1710000000,
    "updated_at": 1710000000
  }
}

调用限制

速率限制每账户 1,000 次/分钟50 次/秒
权限故障可读 (on-call) 或 故障可管理 (on-call)

使用说明

  • 仅返回非删除状态的字段;field_id 已删除或不存在时会返回 400。
  • optionsdefault_value 的形态随 field_type 变化,详见 FieldItem

授权

app_key
string
query
必填

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

请求体

application/json
field_id
string
必填

字段 ID,24 位十六进制 ObjectID。

Pattern: ^[a-f0-9]{24}$

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

故障自定义字段配置。