Compute resources

Choose an API for the resource you need to operate on, then prepare the identity, IDs, and parameters listed on its action page.

Choose a task

Task

Page

Description

Submit an administrative compute resource deletion

Submit an administrative compute resource deletion

Persist the deletion intent and return an acknowledgement. Background processing continues the cleanup.

Compute administration errors and recovery

Compute administration errors and recovery

Classified shared authorization denials return 403/ErrForbidden; unavailability returns 503/ErrServiceUnavailable. Unclassified shared service errors return 500/ErrServer.

List compute resources as an administrator

List compute resources as an administrator

List compute resources across Workspaces in the current administration directory. Filter by Workspace, status, name, or keyword.

Compute administration common objects

Compute administration common objects

An optional declaration does not mean every API populates the field. These list and update APIs do not populate py_deps.

Preflight compute resource deletion

Preflight compute resource deletion

Read current active tasks and workflow bindings before deletion.

Update administrative compute resource configuration

Update administrative compute resource configuration

Update a target compute resource as a configured administrator and return the ordinary resource object.

Compute administration lifecycle errors and recovery

Compute administration lifecycle errors and recovery

Require SUSPENDED and ERROR, respectively.

Get compute resource runtime state as an administrator

Get compute resource runtime state as an administrator

Read a target instance’s Worker types, states, and replica records separately from the parent instance state.

Compute administration runtime and lifecycle common objects

Compute administration runtime and lifecycle common objects

Fields come from current handler DTOs and converters.

Resume a compute resource

Resume a compute resource

Resume a target compute instance as a configured administrator and return the instance reread after the operation.

Retry a compute resource

Retry a compute resource

Retry the target compute instance as a configured administrator and return the instance read again after the operation.

Suspend a compute resource

Suspend a compute resource

Suspend a target compute instance as a configured administrator, then return the instance reread after the operation.

Last updated on