> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# 自定义字段

> 为故障添加自定义元数据，记录特定业务信息

<Tip>**版本要求**：此功能需要 On-call 标准版及以上订阅。[了解更多](https://flashcat.cloud/flashduty/price/)</Tip>

自定义字段用于扩展故障的描述信息。Flashduty On-call 已支持接入大部分常见告警系统，将推送内容放到 Labels 展示。但您可能还需要记录额外信息，比如人工标记故障是否为误报。自定义字段正是为此设计。

## 使用场景

<CardGroup cols={3}>
  <Card title="灵活定义" icon="sliders">
    创建多个自定义字段，定义名称、类型、可选项和默认值。支持文本、单选、多选、复选等类型
  </Card>

  <Card title="信息关联" icon="link">
    将故障与业务数据关联，如受影响系统、地理位置、关联客户、是否误报等
  </Card>

  <Card title="筛选分类" icon="filter">
    按自定义字段筛选和分类故障视图，创建常用筛选项，高效组织和处理故障
  </Card>
</CardGroup>

### 字段定义示例

<Frame caption="自定义字段列表">
  <img src="https://download.flashcat.cloud/flashduty/changelog/20230921/field_list.png" alt="自定义字段列表" />
</Frame>

### 故障信息关联

<Frame caption="在故障详情中设置自定义字段">
  <img src="https://download.flashcat.cloud/flashduty/changelog/20230921/reset_field.png" alt="设置自定义字段" />
</Frame>

### 按字段筛选视图

<Frame caption="按自定义字段筛选故障">
  <img src="https://download.flashcat.cloud/flashduty/changelog/20230921/card_view.png" alt="按字段筛选" />
</Frame>

## 配置字段

### 创建字段

<Note>
  一个账户最多支持创建 **15 个**自定义字段。
</Note>

<Steps>
  <Step title="进入配置页面">
    前往控制台 **故障管理** → **自定义字段**
  </Step>

  <Step title="创建字段">
    点击 **创建自定义字段**，输入以下信息：

    | 配置项      | 说明                 | 约束                                                                |
    | :------- | :----------------- | :---------------------------------------------------------------- |
    | **字段名称** | API 中标识字段，创建后不可修改  | 1-40 字符；仅支持字母、数字、下划线，且不能以数字开头（正则：`^[a-zA-Z_][a-zA-Z0-9_]{0,39}$`） |
    | **展示名称** | 故障详情页中的展示字段，创建后可修改 | 1-40 字符                                                           |
    | **字段描述** | 辅助故障处理人理解和使用该字段    | 最多 200 字符，可选                                                      |
  </Step>

  <Step title="选择字段类型">
    | 类型     | 说明                           |
    | :----- | :--------------------------- |
    | **文本** | 纯文本输入框，最多 3000 字符            |
    | **单选** | 单选下拉框，最多 20 个选项，每项不超过 200 字符 |
    | **多选** | 多选下拉框，最多 20 个选项，每项不超过 200 字符 |
    | **复选** | Checkbox 勾选框                 |
  </Step>

  <Step title="完成创建">
    按需设置可选项和默认值，点击 **提交** 完成。

    <Note>
      单选 / 多选字段的**默认值**必须是当前字段已定义的选项之一；若选项被删除或修改，请同步更新默认值，否则无法保存。
    </Note>
  </Step>
</Steps>

<Tip>
  如果字段设置了默认值，系统将在故障生成时自动写入该字段。注意，字段配置仅对新故障生效，不影响已有故障。
</Tip>

### 更新字段

仅允许更新以下内容：

* 展示名称
* 字段描述
* 字段可选项（仅单选和多选类型）
* 默认值

<Note>
  字段更新后仅对新故障生效，不影响已有故障。
</Note>

### 删除字段

您可以随时在控制台发起删除操作。

<Warning>
  删除是一个耗时操作。系统会扫描历史故障并异步删除字段关联关系。在删除完成前，您无法创建同名字段。
</Warning>

## 常见问题

<AccordionGroup>
  <Accordion title="为什么无法按我创建的字段检索故障？">
    请确认您想要检索的字段类型是否为 **文本** 类型。为保证系统稳定性，目前不支持检索文本类型的字段。

    <Tip>
      如需按字段值筛选故障，建议使用 **单选** 或 **多选** 类型。
    </Tip>
  </Accordion>
</AccordionGroup>

## 延伸阅读

<CardGroup cols={2}>
  <Card title="检索与查看故障" icon="magnifying-glass" href="/zh/on-call/incident/search-view-incident">
    了解故障筛选和查看功能
  </Card>

  <Card title="处理与更新故障" icon="pen-to-square" href="/zh/on-call/incident/handle-update-incident">
    了解故障处理流程
  </Card>
</CardGroup>