Перейти к содержимому

Остановить облачную среду выполнения

Request

Останавливает облачную среду выполнения, в которой работает профиль.

  • Предварительные условия: для этого профиля должен существовать активный запуск, начатый вами. Вызов в момент, когда среда уже остановлена или освобождается, возвращает успех и ничего не делает.
  • Эффект: прекращает начисление платы, закрывает учёт потребления, снимает блокировку профиля и просит клиент заархивировать профиль и cookie в облако до освобождения среды.
  • Завершение: принято, но не завершено. Опрашивайте /cloudbrowser/page, пока cloudBrowserStatus не станет CLOSED, а cloudBrowserArchiveStatus не достигнет COMPLETED или FAILED.
  • Если архивация не удалась: запуск остаётся тарифицируемым и по-прежнему отображается как RUNNING. force учитывается только в этом состоянии: он пропускает архивацию и освобождает среду, из-за чего изменения профиля в этой сессии теряются.
  • Параллелизм: одновременные остановки одного запуска сериализуются, поэтому дублирующий вызов безопасен.

Задокументированные бизнес-ошибки: 40002, 40006, 40008, 40020. Значения кодов см. в Error Codes. Любая операция может дополнительно вернуть общие коды.

Bodyapplication/jsonrequired
envIdstring(EnvironmentId)^[1-9]\d*$required

Browser profile (environment) ID. Serialized as a decimal string to avoid JavaScript precision loss on 64-bit integers.

Example:"1800000000000001"
forceboolean

Whether to forcibly release the cloud runtime. Only takes effect when the current run has an archive status of FAILED; in that case the archive step is skipped and runtime resources are reclaimed. Ignored in all other cases.

Default:false
Example:false
curl -i -X POST \
  http://127.0.0.1:40000/api/cloudbrowser/stop \
  -H 'Content-Type: application/json' \
  -d '{
    "envId": "1800000000000001",
    "force": false
  }'

Responses

Success

Bodyapplication/json
codeintegerrequired

Return result code. 0 means success; other codes indicate exceptions.

Example:0
msgstring or nullrequired

Error message. Usually null on success.

Example:null
requestIdstring

Operation request ID. This field may be present when the request passes through the API gateway.

Example:"1d4f3ea968664593860b94b35d4ebf5e"
datanull
Example:null
Response
{ "code": 0, "msg": null, "requestId": "1d4f3ea968664593860b94b35d4ebf5e", "data": null }