--- title: "Returns a specific DAIEngine." method: GET path: "/v1/{name_3}" tags: ["DAIEngineService"] --- # Returns a specific DAIEngine. `GET /v1/{name_3}` ## Request - Base URL: `https://docs.h2o.ai` (the document declares no server; this is the origin it was published from) - URL: `https://docs.h2o.ai/v1/{name_3}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `name_3` string, required ## Response `200` A successful response. - V1GetDAIEngineResponse: Response message for DAIEngineService.GetDAIEngine. - `daiEngine` V1DAIEngine - `name` string: DAIEngine resource name. - `uid` string: Globally unique identifier of the resource. - `creator` string: Name of an entity that created the DAIEngine. - `creatorDisplayName` string: Human-readable name of creator. - `profile` string, required: Required. The resource name of the DAIEngineProfile that is assigned to this DAIEngine. Format is `workspaces/*/daiEngineProfiles/*`. - `profileInfo` V1DAIEngineProfileInfo: The original DAIEngineProfile data used by DAIEngine when using the DAIEngineProfile. For more info about each field see the original DAIEngineProfile resource. - `name` string - `displayName` string - `priority` integer - `enabled` boolean - `assignedOidcRolesEnabled` boolean - `assignedOidcRoles` string[] - `maxRunningEngines` integer, nullable - `cpuConstraint` V1ProfileConstraintNumeric: Message representing a constraint on a user-specified numeric value. - `min` string, int64: Minimum (inclusive) allowed value. - `max` string, int64, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string, int64: Default value. It is used as an initial value or when the value is unset by the user. - `cumulativeMax` string, int64, nullable: Maximum cumulative value allowed. Unset is treated as unlimited. - `gpuConstraint` V1ProfileConstraintNumeric: Message representing a constraint on a user-specified numeric value. - `min` string, int64: Minimum (inclusive) allowed value. - `max` string, int64, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string, int64: Default value. It is used as an initial value or when the value is unset by the user. - `cumulativeMax` string, int64, nullable: Maximum cumulative value allowed. Unset is treated as unlimited. - `memoryBytesConstraint` V1ProfileConstraintNumeric: Message representing a constraint on a user-specified numeric value. - `min` string, int64: Minimum (inclusive) allowed value. - `max` string, int64, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string, int64: Default value. It is used as an initial value or when the value is unset by the user. - `cumulativeMax` string, int64, nullable: Maximum cumulative value allowed. Unset is treated as unlimited. - `storageBytesConstraint` V1ProfileConstraintNumeric: Message representing a constraint on a user-specified numeric value. - `min` string, int64: Minimum (inclusive) allowed value. - `max` string, int64, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string, int64: Default value. It is used as an initial value or when the value is unset by the user. - `cumulativeMax` string, int64, nullable: Maximum cumulative value allowed. Unset is treated as unlimited. - `maxIdleDurationConstraint` V1ProfileConstraintDuration: Message representing a constraint on a user-specified duration value. - `min` string: Minimum (inclusive) allowed value. - `max` string, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string: Default value. It is used as an initial value or when the value is unset by the user. - `maxRunningDurationConstraint` V1ProfileConstraintDuration: Message representing a constraint on a user-specified duration value. - `min` string: Minimum (inclusive) allowed value. - `max` string, nullable: Maximum (inclusive) allowed value. Unset is treated as unlimited. - `default` string: Default value. It is used as an initial value or when the value is unset by the user. - `maxNonInteractionDuration` string, nullable - `maxUnusedDuration` string, nullable - `configurationOverride` object - `baseConfiguration` object - `configEditability` 'CONFIG_EDITABILITY_UNSPECIFIED' | 'CONFIG_EDITABILITY_DISABLED' | 'CONFIG_EDITABILITY_BASE_CONFIG_ONLY' | 'CONFIG_EDITABILITY_FULL': All possible DAIEngine.config editability options. - CONFIG_EDITABILITY_UNSPECIFIED: ConfigEditability is unspecified. - CONFIG_EDITABILITY_DISABLED: Specifying DAIEngine.config is not allowed. - CONFIG_EDITABILITY_BASE_CONFIG_ONLY: Specifying DAIEngine.config is allowed only when it overrides values from base_configuration. - CONFIG_EDITABILITY_FULL: Specifying DAIEngine.config is allowed in full. - `yamlPodTemplateSpec` string - `yamlGpuTolerations` string - `tritonEnabled` boolean - `createTime` string, date-time - `updateTime` string, date-time, nullable - `creator` string - `updater` string - `creatorDisplayName` string - `updaterDisplayName` string - `gpuResourceName` string - `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. - `reconciling` boolean: Indicates whether changes to the resource are in progress. If true, current state of the DAIEngine does not match the intended state. - `storageResizing` boolean: 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. - `totalDiskSizeBytes` string, int64, nullable: Total disk size in bytes as reported by DriverlessAI. Available only in 1.10.6 and higher. - `freeDiskSizeBytes` string, int64, nullable: Free disk size in bytes as reported by DriverlessAI. Available only in 1.10.6 and higher. - `createTime` string, date-time: Time when the DAIEngine creation was requested. - `deleteTime` string, date-time, nullable: Time when the DAIEngine was deleted. - `updateTime` string, date-time, nullable: Time when the DAIEngine was last updated. - `resumeTime` string, date-time, nullable: Time when the DAIEngine was last resumed (or started for the first time). - `apiUrl` string: The URL address to access the engine API. - `loginUrl` string: The URL address to initiate login flow. - `annotations` object: 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]([-A-Za-z0-9_.]{0,61}[A-Za-z0-9])?$ - `displayName` string: Human-readable name of the DAIEngine. Must contain at most 63 characters. Does not have to be unique. - `cpu` integer, nullable: The amount of CPU units requested by this DAIEngine. - `gpu` integer, nullable: The amount of GPU units requested by this DAIEngine. - `memoryBytes` string, int64, nullable: The amount of memory in bytes requested by this DAIEngine. - `storageBytes` string, int64, nullable: The amount of storage requested by this DAIEngine. - `config` object: 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). - `maxIdleDuration` string, nullable - `maxRunningDuration` string, nullable: Maximum time the DAIEngine can be running. When exceeded, the DAIEngine will pause. - `upgradeAvailable` boolean: Indicates, whether the used version can be upgraded to a later one. - `currentIdleDuration` string, nullable: Current time the DAIEngine is idle. - `currentRunningDuration` string, nullable: Current time the DAIEngine is running. - `daiEngineVersion` string, required - `daiEngineVersionInfo` V1DAIEngineVersionInfo: The original DAIEngineVersion data used by DAIEngine when using the DAIEngineVersion. For more info about each field see the original DAIEngineVersion resource. - `name` string - `deprecated` boolean - `aliases` string[] - `image` string - `imagePullPolicy` 'IMAGE_PULL_POLICY_UNSPECIFIED' | 'IMAGE_PULL_POLICY_ALWAYS' | 'IMAGE_PULL_POLICY_NEVER' | 'IMAGE_PULL_POLICY_IF_NOT_PRESENT': Policy for downloading an image in K8s. - IMAGE_PULL_POLICY_UNSPECIFIED: Unspecified image pull policy. - IMAGE_PULL_POLICY_ALWAYS: Every time the container is launched, the container image registry is queried to resolve the name to an image digest. - IMAGE_PULL_POLICY_NEVER: Do not try to fetch the image. If the image is already present locally, the container will start. If the image is not present, container startup will fail. - IMAGE_PULL_POLICY_IF_NOT_PRESENT: The image is pulled only if it is not already present locally. - `imagePullSecrets` string[] - `createTime` string, date-time - `updateTime` string, date-time, nullable - `creator` string - `updater` string - `creatorDisplayName` string - `updaterDisplayName` string - `dataDirectoryStorageClass` string: Output only. Immutable. Name of the storage class used by DAIEngine. When unset, the default storage class of the k8s cluster will be used. ## Other responses - `default`: An unexpected error response. --- [API](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto.md) - [All operations](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/revisions/297cfadc1d39?raw)