--- title: "Pauses a NotebookEngine." method: POST path: "/v1/{name_1}:pause" tags: ["NotebookEngineService"] --- # Pauses a NotebookEngine. `POST /v1/{name_1}:pause` ## 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_1}:pause` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `name_1` string, required ## Request body - object: Request message for pausing a running NotebookEngine. ## Response `200` A successful response. - V1PauseNotebookEngineResponse: Response for NotebookEngineService.PauseNotebookEngine. - `notebookEngine` V1NotebookEngine - `name` string: Output only. The resource name of the NotebookEngine. Format: `workspaces/*/notebookEngines/*`. - `displayName` string: Optional. Human-readable name. - `profile` string, required: Required. The resource name of the NotebookEngineProfile that is assigned to this NotebookEngine. Format is `workspaces/*/notebookEngineProfiles/*`. - `notebookImage` string, required: Required. Immutable. The resource name of the NotebookEngineImage that is assigned to this NotebookEngine. Format is `workspaces/*/notebookEngineImages/*`. - `cpu` integer, nullable: Non-empty default. The amount of CPU units requested by this NotebookEngine. - `gpu` integer, nullable: Non-empty default. The amount of GPU units requested by this NotebookEngine. - `memoryBytes` string, int64, nullable: Non-empty default. The amount of memory in bytes requested by this NotebookEngine. - `storageBytes` string, int64, nullable: Non-empty default. The amount of storage requested by this NotebookEngine. - `maxIdleDuration` string, nullable: Non-empty default. Maximum time the NotebookEngine can be idle. When exceeded, the NotebookEngine will pause. - `maxRunningDuration` string, nullable: Non-empty default. Maximum time the NotebookEngine can be running. When exceeded, the NotebookEngine will pause. - `state` 'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_TERMINATED': The state of the NotebookEngine. - STATE_UNSPECIFIED: NotebookEngine state is unspecified or unknown. - STATE_STARTING: NotebookEngine is starting. - STATE_RUNNING: NotebookEngine is running and can be used. - STATE_PAUSING: NotebookEngine is pausing. - STATE_PAUSED: NotebookEngine is paused and can be resumed again. - STATE_FAILED: NotebookEngine has failed and can be resumed again. - STATE_DELETING: NotebookEngine is being deleted. - STATE_TERMINATED: NotebookEngine is terminated and cannot be resumed. - `reconciling` boolean: Output only. Indicates whether changes to the resource are in progress. - `uid` string: Output only. Globally unique identifier of the resource. - `notebookImageInfo` V1NotebookEngineImageInfo: The original NotebookEngineImage data used by NotebookEngine when using the NotebookEngineImage. For more info about each field see the original NotebookEngineImage resource. - `image` string - `name` string - `displayName` string - `enabled` boolean - `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 - `profileInfo` V1NotebookEngineProfileInfo: The original NotebookEngineProfile data used by NotebookEngine when using the NotebookEngineProfile. For more info about each field see the original NotebookEngineProfile 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. - `yamlPodTemplateSpec` string - `yamlGpuTolerations` string - `createTime` string, date-time - `updateTime` string, date-time, nullable - `creator` string - `updater` string - `creatorDisplayName` string - `updaterDisplayName` string - `storageClassName` string - `gpuResourceName` string - `syncGitRepositoryEnabled` boolean - `gitRepository` string - `gitRef` string - `gitDirectoryName` string - `creator` string: Output only. Name of entity that created the NotebookEngine. - `updater` string: Output only. Name of entity that last updated the NotebookEngine. - `creatorDisplayName` string: Output only. Human-readable name of entity that created the NotebookEngine. - `updaterDisplayName` string: Output only. Human-readable name of entity that last updated the NotebookEngine. - `createTime` string, date-time: Output only. Time when the NotebookEngine was created. - `updateTime` string, date-time, nullable: Output only. Time when the NotebookEngine was last updated. - `resumeTime` string, date-time, nullable: Output only. Time when the NotebookEngine was last resumed. - `deleteTime` string, date-time, nullable: Output only. Optional. Time when the NotebookEngine was deleted. - `currentIdleDuration` string, nullable: Output only. Optional. Current time the NotebookEngine is idle. - `currentRunningDuration` string, nullable: Output only. Optional. Current time the NotebookEngine is running. - `storageClassName` string: Output only. Immutable. Name of the storage class used by NotebookEngine. - `shared` boolean: Optional. Allows the engine to be shared with all users in the workspace. - `failureReason` 'FAILURE_REASON_UNSPECIFIED' | 'FAILURE_REASON_UNKNOWN' | 'FAILURE_REASON_OOM_KILLED' | 'FAILURE_REASON_PROCESS_FAILED' | 'FAILURE_REASON_PVC_ACCESS_FAILURE': The reason of the failed state for the NotebookEngine. - FAILURE_REASON_UNSPECIFIED: NotebookEngine failure reason is not set. - FAILURE_REASON_UNKNOWN: NotebookEngine failure reason exists, but is unknown. - FAILURE_REASON_OOM_KILLED: NotebookEngine exceeded its memory limit and was killed. - FAILURE_REASON_PROCESS_FAILED: NotebookEngine application crashed. - FAILURE_REASON_PVC_ACCESS_FAILURE: NotebookEngine cannot access the assigned PVC. - `storageResizing` boolean: Output only. Indicates whether the NotebookEngine disk is currently resizing. It make take hours to complete the resizing process, especially if the disk has been resized recently. ## 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)