--- title: "Returns a specific H2OEngine." method: GET path: "/v1/{name_6}" tags: ["H2OEngineService"] --- # Returns a specific H2OEngine. `GET /v1/{name_6}` ## 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_6}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `name_6` string, required ## Response `200` A successful response. - V1GetH2OEngineResponse: Response message for H2OEngineService.GetH2OEngine. - `h2oEngine` V1H2OEngine - `name` string: H2OEngine resource name. - `uid` string: Globally unique identifier of the resource. - `creator` string: Name of na entity that created the H2OEngine. - `creatorDisplayName` string: Human-readable name of creator. - `profile` string, required: Required. The resource name of the H2OEngineProfile that is used by this H2OEngine. Format is `workspaces/*/h2oEngineProfiles/*`. - `profileInfo` V1H2OEngineProfileInfo: The original H2OEngineProfile data used by H2OEngine when using the H2OEngineProfile. For more info about each field see the original H2OEngineProfile resource. - `name` string - `displayName` string - `priority` integer - `enabled` boolean - `assignedOidcRolesEnabled` boolean - `assignedOidcRoles` string[] - `maxRunningEngines` integer, nullable - `nodeCountConstraint` 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. - `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. - `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. - `yamlPodTemplateSpec` string - `yamlGpuTolerations` string - `createTime` string, date-time - `updateTime` string, date-time, nullable - `creator` string - `updater` string - `creatorDisplayName` string - `updaterDisplayName` string - `gpuResourceName` string - `javaClasspath` string - `javaOptions` string - `h2oOptions` string - `state` 'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_CONNECTING' | 'STATE_TERMINATING' | 'STATE_TERMINATED': All possible H2OEngine states. - STATE_UNSPECIFIED: H2OEngine state is unspecified or unknown. - STATE_STARTING: H2OEngine is starting. - STATE_RUNNING: H2OEngine is running and can be used. - STATE_PAUSING: H2OEngine is pausing. Deprecated, use STATE_TERMINATING. - STATE_PAUSED: H2OEngine is paused and CANNOT be resumed again. Deprecated, use STATE_TERMINATED. - STATE_FAILED: H2OEngine has failed. - STATE_DELETING: H2OEngine is being deleted. - STATE_CONNECTING: H2OEngine is establishing a connection with the AI Engine Manager. - STATE_TERMINATING: H2OEngine is terminating. - STATE_TERMINATED: H2OEngine is terminated. This is a final state. - `reconciling` boolean: Indicates whether changes to the resource are in progress. If true, current state of the H2OEngine does not match the intended state. - `createTime` string, date-time: Time when the H2OEngine creation was requested. - `deleteTime` string, date-time, nullable: Time when the H2OEngine was deleted. - `updateTime` string, date-time, nullable: Time when the H2OEngine was last updated. - `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 H2OEngine. 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 H2OEngine. Must contain at most 63 characters. Does not have to be unique. - `cpu` integer, nullable: The amount of CPU units per node requested by this H2OEngine. - `gpu` integer, nullable: The amount of GPU units per node requested by this H2OEngine. - `memoryBytes` string, int64, nullable: The amount of memory in bytes per node requested by this H2OEngine. - `maxIdleDuration` string, nullable: Maximum time an H2OEngine can be idle. When exceeded, the H2OEngine will terminate. - `maxRunningDuration` string, nullable: Maximum time an H2OEngine can be running. When exceeded, the H2OEngine will terminate. - `currentIdleDuration` string, nullable: Current time the H2OEngine is idle. - `currentRunningDuration` string, nullable: Current time the H2OEngine is running. - `nodeCount` integer, nullable: The number of nodes requested by this H2OEngine. - `h2oEngineVersion` string, required - `h2oEngineVersionInfo` V1H2OEngineVersionInfo: The original H2OEngineVersion data used by H2OEngine when using the H2OEngineVersion. For more info about each field see the original H2OEngineVersion 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 ## 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)