Method: projects.locations.runtimes.stop

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

HTTP request

POST https://notebooks.googleapis.com/v1/{name}:stop

Path parameters

Parameters
name

string

Required. Format: projects/{projectId}/locations/{location}/runtimes/{runtimeId}

Authorization requires the following IAM permission on the specified resource name:

  • notebooks.runtimes.stop

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestId": string
}
Fields
requestId

string

Idempotent request UUID.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.