クラウドランタイムを停止

API リファレンス

クラウドランタイムを停止

Request

プロファイルのアクティブなクラウドランタイムを停止します。成功レスポンスは停止リクエストが受け付けられたことだけを示し、アーカイブとリソースの解放は引き続き進行している場合があります。

force は、現在の実行のアーカイブ状態が FAILED の場合にのみ適用されます。

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

POST

/api/cloudbrowser/stop

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
}