H2h2o
SandboxEngineService

Creates and starts a new SandboxEngine within a specified workspace.

Authorization may require the following permission on the engine's parent workspace:

  • actions/enginemanager/sandboxEngines/CREATE
post/v1/{parent}/sandboxEngines

Request

Path parameters

parentstring required

workspace resource name. Format: workspaces/{workspace}

Query parameters

sandboxEngineIdstring required

Specify the SandboxEngine ID, which will become a part of the SandboxEngine resource name.

It must:

  • contain 1-63 characters
  • contain only lowercase alphanumeric characters or hyphen ('-')
  • start with an alphabetic character
  • end with an alphanumeric character

This matches a regular expression: ^a-z?$

Request body

namestring

Identifier. SandboxEngine resource name.

displayNamestring

Optional. Human-readable name of the SandboxEngine. Must contain at most 63 characters. Does not have to be unique.

uidstring

Output only. Globally unique identifier of the resource.

state'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_TERMINATING' | 'STATE_TERMINATED' | 'STATE_FAILED' | 'STATE_DELETING'

All possible SandboxEngine states.

  • STATE_UNSPECIFIED: SandboxEngine state is unspecified or unknown.
  • STATE_STARTING: SandboxEngine is starting.
  • STATE_RUNNING: SandboxEngine is running.
  • STATE_TERMINATING: SandboxEngine is terminating.
  • STATE_TERMINATED: SandboxEngine is terminated.
  • STATE_FAILED: SandboxEngine has failed.
  • STATE_DELETING: SandboxEngine is being deleted.
creatorstring

Output only. Name of an entity that created the SandboxEngine.

creatorDisplayNamestring

Output only. Human-readable name of creator.

createTimestring date-time

Output only. Time when the SandboxEngine creation was requested.

sandboxEngineImagestring required

Required. Immutable. The resource name of the SandboxEngineImage that is assigned to this SandboxEngine. Format is workspaces/*/sandboxEngineImages/*.

sandboxEngineTemplatestring required

Required. Immutable. The resource name of the SandboxEngineTemplate that is assigned to this SandboxEngine. Format is workspaces/*/sandboxEngineTemplates/*.

currentIdleDurationstring nullable

Output only. Current time the SandboxEngine is idle.

annotationsobject

Optional. Additional arbitrary metadata associated with the SandboxEngine.

Annotations are key/value pairs. The key must:

  • be 63 characters or less
  • begin and end with an alphanumeric character ([a-z0-9A-Z])
  • with dashes (-), underscores (_), dots (.), and alphanumerics between
  • regex used for validation is: ^A-Za-z0-9?$
pendingReason'PENDING_REASON_UNSPECIFIED' | 'PENDING_REASON_CREATING_RESOURCES' | 'PENDING_REASON_SCHEDULING' | 'PENDING_REASON_PULLING_IMAGE' | 'PENDING_REASON_CONTAINER_CREATING' | 'PENDING_REASON_WAITING_READINESS' | 'PENDING_REASON_DELETING_RESOURCES'

All possible reasons why a SandboxEngine is in a pending/waiting state.

  • PENDING_REASON_UNSPECIFIED: No pending reason - engine is in a stable state (RUNNING, TERMINATED, FAILED).
  • PENDING_REASON_CREATING_RESOURCES: Kubernetes resources (Pod, Service) are being created.
  • PENDING_REASON_SCHEDULING: Pod is waiting to be scheduled to a node.
  • PENDING_REASON_PULLING_IMAGE: Node is pulling the container image.
  • PENDING_REASON_CONTAINER_CREATING: Container is being created (init containers, volumes, network setup).
  • PENDING_REASON_WAITING_READINESS: Container is running but application is not ready yet.
  • PENDING_REASON_DELETING_RESOURCES: Kubernetes resources are being cleaned up.
pendingMessagestring

Output only. Human-readable message providing details about the current pending state. Contains information from Kubernetes about what the engine is waiting for. Empty when the engine is in a stable state.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.