Перейти к содержимому
RU
Ключ API
Обзор документации

Руководства

Развертывание рабочих нагрузок FlashData

Запустите задачи CLI вашего приложения или агента на Linux или Docker, а затем проверьте доступ и получите повторное использование после перезагрузки.

На этой странице

1. Выберите время выполнения

Используйте хост Linux с Bash и jq, а также ключ API владельца с разрешением google_search. Запустите настройку в качестве пользователя OS, который выполнит задачу. Создайте эту частную папку задач для шагов 1–4; на ярлыках файлов отображаются любые подпапки.

Создайте папку задач
umask 077
mkdir -p "$HOME/flashdata-tasks/deployment-check"
cd "$HOME/flashdata-tasks/deployment-check"

Сначала установите нативный CLI. Запустите команду -v flashdata, чтобы найти его абсолютный путь, а затем установите FLASHDATA_BIN на этот путь в runtime.sh. Установите имя профиля и постоянный путь состояния здесь, а затем сохраните файл.

runtime.sh
# runtime.sh — edit the executable and persistent state paths.
export FLASHDATA_BIN=/usr/local/bin/flashdata
export FLASHDATA_PROFILE=research
export FLASHDATA_STATE_DIR="$HOME/.local/state/flashdata-research"

run_flashdata() {
  env -u FLASHDATA_API_KEY "$FLASHDATA_BIN" "$@" \
    --profile "$FLASHDATA_PROFILE" \
    --state-dir "$FLASHDATA_STATE_DIR"
}

Проверьте выбранное время выполнения

run_flashdata - это помощник, сохраненный в runtime.sh; все последующие команды используют его профиль и каталог состояния. Он игнорирует FLASHDATA_API_KEY, поэтому ключ окружения не может заменить сохраненный профиль. В качестве примера можно привести версии CLI и jq.

Подготовить постоянное состояние · без запроса API
set -euo pipefail
umask 077
. ./runtime.sh
mkdir -p "$FLASHDATA_STATE_DIR"
chmod 700 "$FLASHDATA_STATE_DIR"
run_flashdata --version
jq --version

2. Установить доступ к владельцу один раз

Если профиль уже имеет доступ к владельцу, пропустите импорт и запустите чек ниже. В противном случае установите секретный файл ключа владельца, который может быть считан пользователем сервиса, и замените путь примера его местоположением. Импорт считывает его через stdin; Docker не копирует изображение.

Укажите на развернутый секретный файл
export FLASHDATA_KEY_FILE='/run/secrets/flashdata_api_key'
Импорт и проверка в выбранном времени выполнения
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Set the path to your mounted owner-key secret}"
run_flashdata auth login --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

Подтвердите аккаунт и разрешение

Проверка печатает учетную запись ID, разрешенные источники и защиту учетных данных, затем true. Подтвердите, что учетная запись ID является предполагаемым владельцем, прежде чем продолжить. access.json остается в папке задач для проверки.

Доступ для владельцев · Бесплатный чек
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata auth status --json --non-interactive > access.json
jq '{accountId: .data.identity.identity.accountId,
     sources: .data.identity.permittedSources,
     credentialProtection: .data.credentialProtection}' access.json
jq -e '.ok and .data.accessVerified
  and (.data.identity.identity.recurringAllowed == true)
  and (.data.identity.permittedSources | index("google_search") != null)' access.json

Полное хранилище и постоянные файлы

Проверьте data.credentialProtection в auth status. Linux может использовать разблокированную Секретную службу; безголовый хост или контейнер выше может использовать файл с открытым текстом только владельца. Держите государственный каталог частным и постоянным. Предоставьте развернутому пользователю отдельно от зашифрованного профиля вашего ноутбука.

ДержитеМестоположение
Полномочия и вести дневникFLASHDATA_STATE_DIR
Ввод, поступления и результатыПапка задач; установлена как /work в Docker.

3. Проверить запрос и стоимость

Сохраните request.json рядом с runtime.sh. Следующая проверка проверяет повторяющийся доступ и запрос, считывает текущие цены и сравнивает их с имеющимся балансом. Он не осуществляет поиск и не резервирует кредиты. Продолжайте только тогда, когда фильтр печатает true.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Проверка перед первым платным заданием
set -euo pipefail
umask 077
. ./runtime.sh
run_flashdata account balance --json --non-interactive > balance.json
run_flashdata query --input request.json --mode realtime --dry-run --recurring \
  --run-id deployment-first-task --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
  .ok and .data.dryRun and .data.estimateAvailable
  and ($balance[0].ok == true)
  and any(.data.estimate.prices[]?;
    .source == "google_search" and .available == true
    and (.estimatedCredits | type == "number")
    and ($balance[0].data.availableCredits | type == "number")
    and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json

4. Запустите один раз и проверьте повторное использование

Сохраните deployment-check.sh ниже. С новой задачей развертывания ID, первое исполнение отправляет один платный поиск; второе запускает новый процесс и считывает сохраненный результат. Если этот ID уже завершен в одном профиле, обе попытки повторно использовать его.

Скачать deployment-check.sh

Создайте deployment-check.sh рядом с runtime.sh и request.json в папке приватных задач на хосте. Скопируйте полный сценарий ниже и сохраните его.

deployment-check.sh
#!/usr/bin/env bash
set -euo pipefail
umask 077
cd -- "$(dirname -- "$0")"
. ./runtime.sh
attempt=$(mktemp -d ./deployment-check.XXXXXX)
printf 'Attempt files: %s\n' "$attempt" >&2
cp -- request.json "$attempt/request.json"
if ! run_flashdata query --input "$attempt/request.json" --mode realtime --recurring \
  --run-id deployment-first-task --timeout 2m --json --non-interactive \
  --output "$attempt/result.json" \
  > "$attempt/receipt.json" 2> "$attempt/error.json"; then
  cat "$attempt/error.json" >&2
  exit 1
fi
jq -e '.ok == true' "$attempt/receipt.json" >/dev/null
jq -e '.source == "google_search" and .status == "done"
  and (.results[0].organic | type == "array")' "$attempt/result.json" >/dev/null
jq '{runId, cached, usage}' "$attempt/receipt.json"
printf 'Saved result: %s\n' "$attempt/result.json"

Дважды проверяйте сохраненный чек

Запустите эту папку задач хоста как тот же пользователь службы. Оба процесса загружают runtime.sh, сохраненный на этапе 1.

Бегите, затем перезапустите процесс
# A new run ID submits one paid search; a completed ID reuses its result.
bash deployment-check.sh

# New process; Docker uses a new container with the same mounts.
# Same account, input and state: cached: true, no new search.
bash deployment-check.sh

Проверьте вторую квитанцию

Для нового запуска, ожидайте cached: false, а затем cached: true. Каждая попытка печатает свою папку deployment-check.XXXXXX и сохраняет request.json, receipt.json и error.json, а также result.json. В кэшированной квитанции сообщается о первоначальном использовании. Неудачная попытка сохраняет файлы для восстановления.

Вторая квитанция · выдержка
{
  "ok": true,
  "runId": "deployment-first-task",
  "cached": true
}

Прочитайте сохраненный результат поиска

Установите ATTEMPT_DIR во вторую успешную папку, напечатанную выше, например, экспортируйте ATTEMPT_DIR='./deployment-check.ABC123'. Эти команды читают только локальные файлы.

Получать и исходные ссылки
# Use one attempt folder printed by deployment-check.sh.
: "${ATTEMPT_DIR:?Set a saved deployment-check.XXXXXX folder}"
jq '{runId, cached, usage}' "$ATTEMPT_DIR/receipt.json"
jq '.results[0].organic[] | {title, link, snippet}' "$ATTEMPT_DIR/result.json"

Переход от проверки развертывания к повторяющейся задаче

Эта проверка имеет фиксированный запуск ID. Для повторяющейся работы, дайте каждому предполагаемому вступлению свой собственный ID и сохраните выбранное время выполнения, учетную запись, снимки ввода и крепления состояния. Адаптируйте команду запроса бегуна, чтобы использовать run_flashdata, чтобы задачи Docker оставались внутри контейнера.

Проверка доступа к GitHub Actions

Используйте надежный, постоянный бегун Linux с Bash, jq и профилем CLI, уже установленным под пользователем бегуна OS. Сохраните этот рабочий процесс в хранилище вашего приложения. Он проверяет хост CLI без выполнения платной задачи.

  1. Назначьте ярлык поиска флешданных этому бегуну.
  2. Установите переменные репозитория FLASHDATA_BIN и FLASHDATA_STATE_DIR на свои абсолютные пути, а FLASHDATA_PROFILE на установленное имя профиля.
.github/workflows/flashdata-check.yml
name: FlashData access check
on: workflow_dispatch
permissions: {}
concurrency:
  group: flashdata-research
  cancel-in-progress: false
jobs:
  verify:
    runs-on: [self-hosted, linux, flashdata-research]
    timeout-minutes: 5
    steps:
      - name: Verify the installed profile without a paid query
        shell: bash
        env:
          FLASHDATA_BIN: ${{ vars.FLASHDATA_BIN }}
          FLASHDATA_STATE_DIR: ${{ vars.FLASHDATA_STATE_DIR }}
          FLASHDATA_PROFILE: ${{ vars.FLASHDATA_PROFILE }}
          FLASHDATA_API_KEY: ""
        run: |
          set -euo pipefail
          : "${FLASHDATA_BIN:?Set the absolute CLI path}"
          : "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
          : "${FLASHDATA_PROFILE:?Set the installed profile name}"
          test -d "$FLASHDATA_STATE_DIR"
          "$FLASHDATA_BIN" auth status --profile "$FLASHDATA_PROFILE" \
            --state-dir "$FLASHDATA_STATE_DIR" --json --non-interactive |
            jq -e '.ok and .data.accessVerified
              and (.data.identity.identity.recurringAllowed == true)
              and (.data.identity.permittedSources | index("google_search") != null)'

Проверить доступ

После сохранения рабочего процесса в отделении репозитория по умолчанию откройте Actions → FlashData проверка доступа → Запустите рабочий процесс. Ожидайте true и успешной проверки. Отсутствие доступа или разрешения не позволяет выполнить работу без отправки поиска.

Сохраняйте исполнительное государство на рабочих местах

Эфемерный бегун начинается без оригинального журнала. Используйте устойчивое состояние приложения или постоянный бегун для оплачиваемой повторяющейся работы. Переустановка только ключа не может идентифицировать предыдущую работу. Держите государственный каталог и выходы задач частными; не загружайте их в качестве артефактов CI.

Вращать или отменять развернутый доступ

Отправьте паузу. В папке задач наведите FLASHDATA_KEY_FILE на замену ключа для той же учетной записи и требуемых источников, затем запустите команды ниже. Повторите проверку доступа и deployment-check.sh; ожидайте cached: true. Отмените старый ключ после проверки и сохраните профиль и государственный каталог.

Заменить ключ через stdin
set -euo pipefail
. ./runtime.sh
: "${FLASHDATA_KEY_FILE:?Point to the mounted replacement key for the same account}"
run_flashdata auth login --replace --api-key-stdin --non-interactive \
  < "$FLASHDATA_KEY_FILE"
run_flashdata auth status --json --non-interactive

Прекратить доступ полностью

Приостановите планировщик, отмените соединение ключа или агента в консоли, а затем повторите проверку свободного доступа. Это должно провалиться. Локальный выход из системы сам по себе не отменяет учетные данные сервера; уже экспортированные файлы остаются на диске.

Проверка развертывания, которая не удалась

симптомисправлять
Командный код не найден / неправильная версия CLIПроверьте команду -v flashdata и FLASHDATA_BIN в runtime.sh. Для Docker перестраивайте и запускайте проверку изображения --version.
Пропавшая гора или отказано в разрешенииСоздание папок состояния и задач на хосте Docker, принадлежащем сервису UID/GID. Держите их пути стабильными.
replacement_requires_flagПрофиль имеет другой сохраненный ключ. Сначала проверьте существующий доступ; используйте процедуру ротации для предполагаемой замены.
Невозможно расшифровать сохраненный доступРаботайте как пользователь, который предоставил его, в той же среде хранилища учетных данных. Предоставление доступа к новому пункту назначения вместо копирования зашифрованного профиля ноутбука.
Проверка стоимости falseПроверить balance.json и preflight.json. Требуйте доступную цену, разрешение источника и достаточный баланс перед отправкой.
run_account_mismatchПроверьте выбранный аккаунт и происхождение API. Восстановите исходный доступ; не переименовывайте пробег в обход восстановления.
run_id_input_conflictВосстановите первоначальный запрос от request.json. Используйте новый запуск ID только для предполагаемой новой платной задачи.
CI остается в очередиУбедитесь, что бегун находится в сети и имеет все ярлыки. Этот рабочий процесс требует постоянного самостоятельного бегуна Linux.