# 开始使用 Instatus API

Source: https://instatus.com/help/zh/api

所有端点都在 `https://api.instatus.com` 之下，整体遵循 REST 架构。

所有请求都必须编码为 JSON，并带上 `Content-Type: application/json` 请求头。

Instatus API 的响应（包括错误）同样以 JSON 编码。

## 认证

调用 Instatus API 的请求必须通过 Authorization 请求头提供 API 令牌：

你可以在用户设置 → [开发者设置](https://dashboard.instatus.com/developer)中获取你的 API 密钥

```bash
Authorization: Bearer <API_KEY>
```

## 获取你的页面 ID
按以下步骤可以在控制台中找到页面 ID：
1. 进入你的控制台。
2. 右键点击左上角的项目，打开菜单。
3. 点击 **Copy Project ID**，页面 ID 就会复制到剪贴板。

![页面 ID](https://instatus.com/help/page_id.png)

## 错误

所有 API 端点的错误响应中都包含 code 和 message。

```json
{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}
```

## 状态取值

可能的页面状态。这是当前 API（v2 及之后）返回的细粒度 `status`。旧的 `summary.json` 端点和 [webhook 通知](https://instatus.com/help/zh/webhooks)使用的是精简形式，只有 `UP`、`HASISSUES` 和 `UNDERMAINTENANCE`。

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

可能的组件状态：

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

可能的事件状态：

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

可能的维护状态：

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## 跳转到端点：

- [状态页](https://instatus.com/help/zh/api/status-pages)
- [工作区](https://instatus.com/help/zh/api/workspaces)
- [组件](https://instatus.com/help/zh/api/components)
- [事件](https://instatus.com/help/zh/api/incidents)
- [事件更新](https://instatus.com/help/zh/api/incident-updates)
- [维护](https://instatus.com/help/zh/api/maintenances)
- [维护更新](https://instatus.com/help/zh/api/maintenance-updates)
- [模板](https://instatus.com/help/zh/api/templates)
- [通用通知](https://instatus.com/help/zh/api/generic-notices)
- [故障](https://instatus.com/help/zh/api/outages)
- [团队成员](https://instatus.com/help/zh/api/teammates)
- [订阅者](https://instatus.com/help/zh/api/subscribers)
- [指标](https://instatus.com/help/zh/api/metrics)
- [用户资料](https://instatus.com/help/zh/api/user-profile)
- [公开数据](https://instatus.com/help/zh/api/public-data)
- [私有页面](https://instatus.com/help/zh/api/private-pages)
- [受众分组](https://instatus.com/help/zh/api/audience-groups)
- [监控](https://instatus.com/help/zh/api/monitors)
- [监控集成](https://instatus.com/help/zh/api/monitoring-integrations)
- [路由规则](https://instatus.com/help/zh/api/routing-rules)
- [升级策略](https://instatus.com/help/zh/api/escalation-policies)
- [值班排期](https://instatus.com/help/zh/api/on-call-schedules)