Workloads

Read retained checkpoint and freeze state

Read retained freeze state for a workload on your account. Retained storage is not separately metered and no storage charge is reported.

get/v1/workloads/{id}/freeze

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Read retained checkpoint and freeze state

idstring required
workload_idstring required
stage_idstring required
manifest_idstring
reasonstring
generationinteger required
state'requested' | 'releasing' | 'frozen' | 'resuming' | 'resumed' | 'failed' required
requested_atstring date-time required
frozen_atstring date-time nullable required
retained_bytesinteger required
storage_charge_microsinteger nullable required

Null while retained storage is not separately metered. Do not infer a zero charge.

storage_billing_status'retained_storage_not_separately_metered' required

Changes

No recorded changes to this operation across all 70 revisions of this API.