H2h2o
DAIEngineService

Updates a DAIEngine.

patch/v1/{daiEngine.name}

Request

Path parameters

daiEngine.namestring required

DAIEngine resource name.

Query parameters

updateMaskstring required

The list of paths referencing which fields to update. Update mask must be non-empty.

Allowed field paths are: {"profile", "cpu", "gpu", "memory_bytes", "config", "annotations", "display_name", "max_idle_duration", "max_running_duration"}. Paths are case sensitive (must match exactly).

To update all allowed fields, specify exactly one path with value "*".

allowMissingboolean

When set and the DAIEngine is not found, a new one is created. In this situation, update_mask is ignored, i.e. all fields are applied regardless of any provided update mask; but the update mask must be still present.

validateOnlyboolean

When set, request is validated but no changes are made.

Request body

uidstring

Globally unique identifier of the resource.

creatorstring

Name of an entity that created the DAIEngine.

creatorDisplayNamestring

Human-readable name of creator.

profilestring required

Required. The resource name of the DAIEngineProfile that is assigned to this DAIEngine. Format is workspaces/*/daiEngineProfiles/*.

state'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_CONNECTING'

All possible DAIEngine states.

  • STATE_UNSPECIFIED: DAIEngine state is unspecified or unknown.
  • STATE_STARTING: DAIEngine is starting.
  • STATE_RUNNING: DAIEngine is running and can be used.
  • STATE_PAUSING: DAIEngine is pausing.
  • STATE_PAUSED: DAIEngine is paused and can be resumed again.
  • STATE_FAILED: DAIEngine has failed and can be resumed again.
  • STATE_DELETING: DAIEngine is being deleted.
  • STATE_CONNECTING: DAIEngine is establishing a connection with the AI Engine Manager.
reconcilingboolean

Indicates whether changes to the resource are in progress. If true, current state of the DAIEngine does not match the intended state.

storageResizingboolean

Indicates whether the DAIEngine disk is currently resizing. It make take hours to complete the resizing process, especially if the disk has been resized recently.

totalDiskSizeBytesstring int64 nullable

Total disk size in bytes as reported by DriverlessAI. Available only in 1.10.6 and higher.

freeDiskSizeBytesstring int64 nullable

Free disk size in bytes as reported by DriverlessAI. Available only in 1.10.6 and higher.

createTimestring date-time

Time when the DAIEngine creation was requested.

deleteTimestring date-time nullable

Time when the DAIEngine was deleted.

updateTimestring date-time nullable

Time when the DAIEngine was last updated.

resumeTimestring date-time nullable

Time when the DAIEngine was last resumed (or started for the first time).

apiUrlstring

The URL address to access the engine API.

loginUrlstring

The URL address to initiate login flow.

annotationsobject

Additional arbitrary metadata associated with the DAIEngine.

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?$
displayNamestring

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

cpuinteger nullable

The amount of CPU units requested by this DAIEngine.

gpuinteger nullable

The amount of GPU units requested by this DAIEngine.

memoryBytesstring int64 nullable

The amount of memory in bytes requested by this DAIEngine.

storageBytesstring int64 nullable

The amount of storage requested by this DAIEngine.

configobject

Additional Driverless AI configuration.

Temporary: Some config keys are reserved and their value cannot be changed. Attempting to set or override a reserved key will have no effect, no error will be raised. Entries with reserved keys will not be available in this field (they are hidden).

maxIdleDurationstring nullable
maxRunningDurationstring nullable

Maximum time the DAIEngine can be running. When exceeded, the DAIEngine will pause.

upgradeAvailableboolean

Indicates, whether the used version can be upgraded to a later one.

currentIdleDurationstring nullable

Current time the DAIEngine is idle.

currentRunningDurationstring nullable

Current time the DAIEngine is running.

daiEngineVersionstring required
dataDirectoryStorageClassstring

Output only. Immutable. Name of the storage class used by DAIEngine. When unset, the default storage class of the k8s cluster will be used.

Response

A successful response.

Changes

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