Аутентификация

Каждый запрос, который отправляет CLI, несёт API-ключ вашего проекта. Сохраните ключи один раз командой status200 login, по контексту на каждое окружение, или передайте их команде во флагах или переменных окружения, как это делают скрипты. Эта страница показывает каждый способ и то, какой из них команда использует, когда их несколько.

Перед началом#

Вам нужен API-ключ вашего проекта. Создайте его в Настройки проекта → Расширенный → Ключи API кнопкой Создать: API-ключ и дайте ему доступ, который нужен вашим командам: см. Создайте API-ключ. Ключ делает то, что разрешают его права: ключ, которому можно только читать записи, может выводить и читать их, но не изменять.

В Status200 Cloud API-ключи работают только пока проект на плане Growth или выше. Ниже него каждая команда отвечает 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

Показываются только первые четыре и последние четыре символа ключа. Строка Context появляется, только когда URL и ключ принадлежат самому контексту, а не заменены флагом или переменной окружения. whoami читает ваши настройки, не обращаясь к Status200: она показывает, что отправит команда, а не примет ли это Status200. Если ничего не сохранено и не задано, она отвечает:

Not authenticated. Run `status200 login` to authenticate.

Файл конфигурации#

status200 login сохраняет контексты в ~/.oneuptime/config.json, в вашей домашней папке (%USERPROFILE%\.oneuptime\config.json в Windows). 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 каждой команде.

Устранение неполадок#

Дальнейшие шаги#