Sign in

v1

latestOpenAPI 3.1.02026-07-26102158206.8 KB
CVMs

Handle Get Cvm State

Get CVM state. Supports two modes:

  1. Immediate mode (no target): Returns current state immediately
  2. SSE mode (with target): Streams state updates until status matches target or timeout

Example: GET /cvms/{cvm_id}/state - Returns current state GET /cvms/{cvm_id}/state?target=running - Streams until status becomes 'running'

SSE connection limit: 5 concurrent connections per user

get/api/v1/cvms/{cvm_id}/state

Path parameters

cvm_idstring required

Query parameters

targetstring nullable

Target status to wait for. If specified, returns SSE stream.

Target status to wait for. If specified, returns SSE stream.

intervalinteger

Polling interval in seconds (5-30)

Polling interval in seconds (5-30)

timeoutinteger

Maximum wait time in seconds (10-600)

Maximum wait time in seconds (10-600)

Response

Successful Response

{"stackTrail":"paths:/api/v1/cvms/{cvm_id}/state:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}