快速入门
Open API 用于访问和操作 FlashDuty 的实体数据,比如查看和管理配置等,使用 API 与您登录 FlashDuty 控制台 后进行页面操作本质上是相同的。
:::tip
如果您想把自研监控系统的告警推送到 FlashDuty,请移步 快速入门。
:::
如何访问
请求地址
所有 API 只接受 HTTPS 协议进行访问,且只有一个 Endpoint:
api.flashcat.cloud
Headers
大部分请求使用了 POST 方法,并且使用 JSON Payload 传参。在这种情况下,请不要忘记设置 Content-Type 这个 Header。
Content-Type: application/json
字符编码
所有 API 均使用 UTF-8 编码。
认证方式
所有 Open API 使用 APP Key 进行鉴权,您可以按如下步骤获取到 APP Key:
- 登录 FlashDuty 控制台
- 进入
账户设置 - APP Key
页面,输入名称,点击添加按钮完成创建
:::caution
每一个 APP Key 都代表一个独立用户,拥有该用户的全部操作权限,请妥善保存,避免泄露。
:::
使用示例
将 APP Key 作为 query string 参数传入即可,假设您申请的 APP Key 是5e8fbfcdbf14d00696153,则请求地址为:
https://api.flashcat.cloud/path?app_key=5e8fbfcdbf14d00696153
响应结构
几乎所有请求响应都是 JSON 格式,并遵循以下结构:
字段名称 | 必选 | 类型 | 描述 |
---|---|---|---|
request_id | 是 | string | 请求 ID,用于链路追踪 |
error | 否 | Error | 错误描述,仅当出现错误时返回 |
data | 否 | interface{} | 数据内容,可能为任何格式,具体参考 API 定义 |
Error:
字段名称 | 必选 | 类型 | 描述 |
---|---|---|---|
code | 是 | string | 错误码,枚举值参考 Code |
message | 否 | string | 错误描述 |
Code:
错误码 | HTTP Status | 描述 |
---|---|---|
InvalidParameter | 400 | 参数错误 |
InvalidContentType | 400 | Conten-Type 不支持 |
MethodNotAllowed | 400 | HTTP Method 不支持 |
Unauthorized | 401 | 登录认证未通过 |
AccessDenied | 403 | 权限认证未通过 |
RequestTooFrequently | 429 | 请求过于频繁 |
RouteNotFound | 404 | 请求 Method+Path 未匹配 |
ResourceNotFound | 400 | 账户未购买资源,先前往费用中心线操作下单 |
NoLicense | 400 | 账户无充足订阅 License,先前往费用中心升级或购买订阅 |
InternalError | 500 | 内部或未知错误 |
最后修改时间: 1 年前