认证

CLI 发送的每个请求都带有你项目的 API 密钥。可以用 status200 login 一次保存密钥，每个环境一个上下文；也可以像脚本那样，通过标志或环境变量把密钥交给命令。本页介绍每种方式，以及同时存在多种时命令使用哪一种。

开始之前#

你需要项目的 API 密钥。在 项目设置 → 高级 → API 密钥 中通过 创建API 密钥 创建一个，并赋予它命令所需的访问权限：参见 创建 API 密钥。密钥只能做其权限允许的事：只能读取记录的密钥可以列出和读取记录，但不能更改它们。

在 Status200 Cloud 上，只有当项目处于 Growth 套餐或更高时，API 密钥才有效。低于该套餐时，每条命令都会返回 API error (402) 以及一条指明套餐的消息，直到项目升级；之后同一个密钥会重新生效。参见 低于其套餐时的 API 密钥和 SCIM。

登录#

status200 login 将 API 密钥和你的 Status200 地址保存为上下文，并将其设为当前上下文：

status200 login <api-key> <instance-url> [--context-name <name>]

例如，一个名为 production 的上下文：

status200 login <api-key> https://status200.ru --context-name production

它回答 Logged in successfully. Context "production" is now active.。地址末尾的斜杠会被去掉，用同一名称再次登录会替换该上下文。

上下文#

上下文就是保存下来的登录：一个名称、一个地址和一个 API 密钥。为每个项目或环境保存一个，然后为之后的所有命令或单条命令选择一个。

1. 为每个环境保存一个上下文#

   Bash

   status200 login <production-api-key> https://status200.ru --context-name production
   status200 login <staging-api-key> https://status200.example.com --context-name staging

   每次登录都会把它的上下文设为当前上下文，所以现在 staging 是当前上下文。

2. 列出它们#

   Bash

   status200 context list

   ┌───┬────────────┬───────────────────────────────┐
   │   │ Name       │ URL                           │
   ├───┼────────────┼───────────────────────────────┤
   │   │ production │ https://status200.ru          │
   ├───┼────────────┼───────────────────────────────┤
   │ * │ staging    │ https://status200.example.com │
   └───┴────────────┴───────────────────────────────┘

   * 标出当前上下文。API 密钥永远不会被列出。

3. 切换到另一个上下文#

   Bash

   status200 context use production

   它回答 Switched to context "production".，之后的命令都使用它。

4. 为单条命令使用上下文#

   Bash

   status200 incident list --context staging

   当前上下文保持不变。

命令使用哪些凭据#

命令需要一个 API 密钥和一个 URL。它从以下位置中第一个有值的位置分别获取这两者：

所以可以混合使用：例如，API 密钥来自环境变量，URL 来自当前上下文。环境变量适合没有已保存上下文的脚本和 CI 作业：

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

对单条命令而言，标志优先于其他一切：

status200 --api-key <api-key> --url https://status200.ru incident list

检查 CLI 将使用什么#

status200 whoami 显示下一条命令将使用的 URL 和 API 密钥，以及它们来自的上下文：

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

只显示密钥的前四个和后四个字符。只有当 URL 和密钥是该上下文自己的值，而不是被标志或环境变量替换的值时，才会显示 Context 这一行。whoami 读取你的设置时不调用 Status200：它显示命令将发送什么，而不是 Status200 是否接受。如果什么都没有保存或设置，它回答：

Not authenticated. Run `status200 login` to authenticate.

配置文件#

status200 login 将上下文保存在你主目录下的 ~/.oneuptime/config.json 中（在 Windows 上是 %USERPROFILE%\.oneuptime\config.json）。CLI 创建该文件时，只有你的用户可以读写它（模式 0600）：

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

该文件原样保存 API 密钥：不要把它放进共享文件夹、备份或代码仓库。要退出一个上下文，用 status200 context delete <name> 删除它；要退出所有上下文，删除该文件。可能已泄露的密钥会一直有效，直到你在 Status200 的 项目设置 → 高级 → API 密钥 中删除它。

输出格式和列表大小不保存在这里：请为每条命令传入 -o 和 --limit。

故障排除#

后续步骤#