> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # 查询分面列表 > 返回所有可用的 RUM 字段定义，可按 scope 和是否为分面字段过滤。 ## 限制说明 | 项目 | 说明 | | ---- | ------------------------------ | | 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** | | 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 | ## 使用说明 * 使用返回的 `field_key` 作为 `POST /rum/facet/count` 的 `facet_key` 参数。 * 合法的 `scopes` 值为：`session`、`view`、`action`、`error`、`resource`、`long_task`、`vital`、`issue`、`sourcemap`。 * 设置 `is_facet: true` 只返回支持分面查询的字段（即支持值分布统计的字段）。 ## OpenAPI ````yaml /api-reference/rum.openapi.zh.json post /rum/facet/list openapi: 3.1.0 info: title: Flashduty 开放 API description: >- Flashduty 事件管理平台的公开 HTTP API —— 覆盖故障、通知模板、协作空间、值班排班、监控、RUM、以及平台管理。每次调用都需在 query 中携带 `app_key`，该 key 在 Flashduty 控制台 账户 → APP Key 中签发。所有响应使用统一结构：成功时为 `{ request_id, data }`，失败时为 `{ request_id, error }`。 version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: RUM/应用管理 description: 管理前端性能监控（RUM）应用。 - name: RUM/RUM 数据查询 description: 对 RUM 事件数据执行分析查询。 - name: RUM/RUM 问题跟踪 description: 查询和管理 RUM 异常追踪 Issue 及预设严重性规则。 - name: RUM/RUM 自定义字段 description: 查询 RUM 自定义字段及其值分布，用于构建分析过滤条件。 - name: RUM/RUM Sourcemap description: 管理和查询用于 Browser、Android、iOS 错误符号化的 RUM Sourcemap 文件。 paths: /rum/facet/list: post: tags: - RUM/RUM 自定义字段 summary: 查询分面列表 description: 返回所有可用的 RUM 字段定义，可按 scope 和是否为分面字段过滤。 operationId: rum-read-facet-list requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RumFacetListRequest' example: scopes: - error is_facet: true responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/RumFacetListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: items: - account_id: 0 field_key: error.type field_name: Error type group: Error description: 错误类型。 value_type: string show_type: list unit_family: '' unit_name: '' edit_able: false is_facet: true enum_values: [] scopes: - error status: active queryable: true '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: RumFacetListRequest: type: object description: RUM 字段定义列表的过滤参数。 properties: scopes: type: array items: type: string description: >- 按 RUM 数据 scope 过滤。合法值：`session`、`view`、`action`、`error`、`resource`、`long_task`、`vital`、`issue`、`sourcemap`。 is_facet: type: boolean description: 为 true 时只返回支持分面查询的字段；为 false 或不传时返回所有字段。 SuccessEnvelope: type: object description: >- 成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id` 响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。 properties: request_id: type: string description: 本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。 example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: 每个接口自己的业务 payload，详见各接口的 200 响应 schema。 required: - request_id - data RumFacetListResponse: type: object description: RUM 字段定义列表。 required: - items properties: items: type: array items: $ref: '#/components/schemas/RumFieldItem' RumFieldItem: type: object description: 一条 RUM 字段定义。 required: - account_id - field_key - field_name - group - description - value_type - show_type - unit_family - unit_name - edit_able - is_facet - enum_values - scopes - status - queryable properties: account_id: type: integer format: int64 description: 账户 ID。内置字段为 0。 field_key: type: string description: 唯一字段键，如 `error.type`。 field_name: type: string description: 人类可读的字段名称。 group: type: string description: 字段的展示分组。 description: type: string description: 该字段捕获内容的描述。 value_type: type: string description: 字段值的数据类型。 enum: - string - number - boolean - array - array - array show_type: type: string description: 在分析 UI 中的展示类型。 enum: - list - range unit_family: type: string description: 计量单位族，如 `time`、`bytes`。无量纲字段为空。 unit_name: type: string description: 具体计量单位，如 `millisecond`、`byte`。 edit_able: type: boolean description: 是否为用户可编辑的自定义字段。 is_facet: type: boolean description: 是否支持值分布统计查询。 enum_values: type: array description: >- 该字段的预定义枚举值。元素类型与 `value_type` 对应：字符串类型为 `string`，数字类型为 `number`，布尔类型为 `boolean`。无固定值集合时为空数组。 items: oneOf: - type: string - type: number - type: boolean scopes: type: array items: type: string description: 该字段所属的 RUM scope 列表。 status: type: string description: 字段状态，如 `active`。 queryable: type: boolean description: 是否可在 DQL/SQL 查询中使用。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error DutyError: type: object description: 响应结构中的错误 payload，仅在非 2xx 响应时出现。 properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: 用户可读的错误描述，语言会跟随调用方的 Accept-Language。可能包含字段名、ID 等请求上下文。 example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- Flashduty 错误码枚举。每个失败响应的 `error.code` 都是下列稳定值之一，HTTP 状态码仅作参考。 | 错误码 | HTTP | 含义 | |---|---|---| | `OK` | 200 | 保留值，正常错误响应不会返回。 | | `InvalidParameter` | 400 | 必填参数缺失或未通过校验。 | | `BadRequest` | 400 | 通用的 400 错误，通常是请求本身不合法。 | | `InvalidContentType` | 400 | 请求头 `Content-Type` 不是 `application/json`。 | | `ResourceNotFound` | 400 | 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。 | | `NoLicense` | 400 | 功能需要有效授权，但未找到可用的 license。 | | `ReferenceExist` | 400 | 该资源仍被其他实体引用，无法删除。 | | `Unauthorized` | 401 | `app_key` 缺失、无效或已过期。 | | `BalanceNotEnough` | 402 | 账户余额不足，无法执行需要计费的操作。 | | `AccessDenied` | 403 | 身份认证通过，但 RBAC 权限不足以执行该操作。 | | `RouteNotFound` | 404 | 请求的 URL 路径不是已知路由。 | | `MethodNotAllowed` | 405 | 当前路径不接受所使用的 HTTP 方法。 | | `UndonedOrderExist` | 409 | 账户存在未完成的订单，请稍后重试。 | | `RequestLocked` | 423 | 因连续失败被临时锁定。 | | `EntityTooLarge` | 413 | 请求体超过允许的最大长度。 | | `RequestTooFrequently` | 429 | 命中限流（全局、账户级或集成级）。 | | `RequestVerifyRequired` | 428 | 操作需要二次验证码，但未提供。 | | `DangerousOperation` | 428 | 危险操作，需要进行 MFA 验证。 | | `InternalError` | 500 | 服务端未预期错误。反馈问题请附上 `request_id`。 | | `ServiceUnavailable` | 503 | 后端依赖不可用，请稍后重试。 | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: 保留值，正常错误响应不会返回。 InvalidParameter: 必填参数缺失或未通过校验。 BadRequest: 通用的 400 错误，通常是请求本身不合法。 InvalidContentType: 请求头 `Content-Type` 不是 `application/json`。 ResourceNotFound: 目标资源不存在。注意 HTTP 状态码是 400 而非 404（历史设计）。 NoLicense: 功能需要有效授权，但未找到可用的 license。 ReferenceExist: 该资源仍被其他实体引用，无法删除。 Unauthorized: '`app_key` 缺失、无效或已过期。' BalanceNotEnough: 账户余额不足，无法执行需要计费的操作。 AccessDenied: 身份认证通过，但 RBAC 权限不足以执行该操作。 RouteNotFound: 请求的 URL 路径不是已知路由。 MethodNotAllowed: 当前路径不接受所使用的 HTTP 方法。 UndonedOrderExist: 账户存在未完成的订单，请稍后重试。 RequestLocked: 因连续失败被临时锁定。 EntityTooLarge: 请求体超过允许的最大长度。 RequestTooFrequently: 命中限流（全局、账户级或集成级）。 RequestVerifyRequired: 操作需要二次验证码，但未提供。 DangerousOperation: 危险操作，需要进行 MFA 验证。 InternalError: 服务端未预期错误。反馈问题请附上 `request_id`。 ServiceUnavailable: 后端依赖不可用，请稍后重试。 example: InvalidParameter responses: BadRequest: description: 请求非法 — 通常是参数缺失或格式不正确。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: app_key 缺失或无效。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: 命中限流。可能是全局 API 限流、账户级限流或集成级限流。限流按账户聚合。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: 服务端未预期错误。反馈问题时请携带 request_id。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- 在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````