CVMs
Handle Get Cvm State
Get CVM state. Supports two modes:
- Immediate mode (no target): Returns current state immediately
- 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
Request
- Base URLhttps://cloud-api.phala.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
cvm_idstring required
Query parameters
targetstring nullable
Target status to wait for. If specified, returns SSE stream.
intervalinteger
Polling interval in seconds (5-30)
timeoutinteger
Maximum wait time in seconds (10-600)
Response
Successful Response
unknown required
Changes
No recorded changes to this operation across all 3 revisions of this API.