Skip to content

查詢環境是否執行 ​

根據環境 ID 查詢當前執行狀態。

介面定義:ApiFox GET · 核對日期:2026-10-21。

請求 ​

http
GET /api/isBrowserRunning

使用客戶端 API 頁面顯示的服務地址和 api-key。示例埠 9000 僅作演示,必須替換為實際埠;認證說明見 概述。

Query 引數 ​

引數型別必填說明
idstring否環境 ID

cURL 示例 ​

bash
curl --request GET 'http://127.0.0.1:9000/api/isBrowserRunning?id=1' \
  --header 'api-key: YOUR_API_KEY'

響應示例 ​

json
true

當前客戶端返回及相容讀取 ​

json
{
  "success": true,
  "data": false
}
javascript
function readRunningState(body) {
  if (typeof body === 'boolean') return body;
  if (body?.success === true && typeof body.data === 'boolean') return body.data;
  throw new Error(body?.error || 'Unexpected running-state response');
}

呼叫說明 ​

  • ApiFox 將成功響應定義為 JSON 布林值 true / false;當前客戶端實現返回 { "success": true, "data": true }。相容呼叫應支援這兩種形態,不能把整個響應物件強轉為布林值。
  • ApiFox 將 id 標為可選,但查詢具體環境時請始終傳入;當前客戶端缺少此引數會返回引數錯誤。

請求失敗時同時檢查 HTTP 狀態碼與響應中的錯誤資訊,見 錯誤碼與排查。