Зупинити хмарне середовище виконання

Довідник API

Зупинити хмарне середовище виконання

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
}