> ## 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 应用，返回生成的 `application_id` 和 `client_token`。 ## 限制说明 | 项目 | 说明 | | ---- | ------------------------------ | | 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** | | 权限要求 | **应用管理**（`rum`） | ## 使用说明 * `type` 须为以下之一：`browser`、`ios`、`android`、`react-native`、`flutter`、`kotlin-multiplatform`、`roku`、`unity`。 * `links.systems[].url` 必须以 `http` 或 `https` 开头；`${var}` 变量会根据 RUM 事件上下文解析。 * `links.systems[].event_types` 支持：`crash`、`error`、`view`、`action`、`resource`、`session`、`all`。 * `client_token` 自动生成，用于初始化 RUM SDK。 * 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。 ## OpenAPI ````yaml /api-reference/rum.openapi.zh.json post /rum/application/create 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/application/create: post: tags: - RUM/应用管理 summary: 创建应用 description: 创建新的 RUM 应用，返回生成的 `application_id` 和 `client_token`。 operationId: rum-application-write-create requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RumApplicationCreateRequest' example: application_name: 我的 Web 应用 type: browser team_id: 2477033058131 is_private: false links: enabled: true systems: - id: s3-crash-logs name: S3 Crash Logs icon_text: S3 icon_color: '#0F766E' url: >- https://s3.example.com/logs?app=${application_id}&trace=${trace_id} event_types: - crash - error enabled: true responses: '200': description: 成功 content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/RumApplicationCreateResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: application_id: qLpu24Dz4CAzWsESPbJYWA application_name: 我的 Web 应用 client_token: e090078724855a4ca168c3884880dfbc131 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: RumApplicationCreateRequest: type: object required: - application_name - type - team_id description: 创建 RUM 应用的参数。 properties: application_name: type: string description: 应用名称，1–40 个字符。 type: type: string enum: - browser - ios - android - react-native - flutter - kotlin-multiplatform - roku - unity description: 应用类型。 team_id: type: integer format: int64 description: 所属团队 ID。 is_private: type: boolean description: 是否仅限团队成员访问。 no_ip: type: boolean description: 不采集 IP 地址。 no_geo: type: boolean description: 不推断地理位置。 alerting: $ref: '#/components/schemas/RumApplicationAlerting' tracing: $ref: '#/components/schemas/RumApplicationTracing' links: $ref: '#/components/schemas/RumApplicationLinks' 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 RumApplicationCreateResponse: type: object description: 创建 RUM 应用的结果。 properties: application_id: type: string description: 自动生成的唯一应用 ID。 application_name: type: string description: 应用显示名称。 client_token: type: string description: 用于 RUM SDK 初始化的令牌。 RumApplicationAlerting: type: object description: 应用的告警配置。 properties: enabled: type: boolean description: 是否启用告警。 channel_ids: type: array items: type: integer format: int64 description: 接收告警的协作空间 ID 列表。 integration_id: type: integer format: int64 description: 关联的 On-call 集成 ID（只读，自动分配）。 RumApplicationTracing: type: object description: APM 链路追踪集成配置。 properties: enabled: type: boolean description: 是否启用链路追踪集成。 open_type: type: string enum: - popup - tab description: 链路链接的打开方式。 endpoint: type: string description: 链路 Endpoint URL（http 或 https）。 RumApplicationLinks: type: object description: 应用的外部链接集成配置。 properties: enabled: type: boolean description: 是否启用外部链接集成。 systems: type: - array - 'null' items: $ref: '#/components/schemas/RumApplicationLink' description: 可从匹配 RUM 事件打开的外部系统 URL 模板列表。 ErrorResponse: type: object description: 错误响应结构。`error` 必填，`data` 不存在。 properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error RumApplicationLink: type: object description: 在匹配的 RUM 事件详情页展示的外部系统链接。 required: - name - url - event_types properties: id: type: string description: 外部系统的稳定客户端标识。 name: type: string description: 外部系统显示名称。 icon_text: type: string description: 链接图标中显示的短文本。 icon_color: type: string description: 链接图标显示颜色。 url: type: string format: uri description: HTTP 或 HTTPS URL 模板，`${var}` 变量会根据 RUM 事件上下文解析。 event_types: type: array minItems: 1 items: type: string enum: - crash - error - view - action - resource - session - all description: 展示该外部系统链接的 RUM 事件类型。 enabled: type: boolean description: 是否启用该外部系统链接。 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 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。 ````