Compute Engine API (compute:v1)

Deletions

Methods


• ▼ ▲ compute.instances.suspend

  HTTP Method: POST

  Path: projects/{project}/zones/{zone}/instances/{instance}/suspend

  Parameter Order:

  • project
  • zone
  • instance

  Description: This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.

  Scopes:

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

  Parameters:

  instance

  Required: Yes

  Type: string

  Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

  Location: path

  Description: Name of the instance resource to suspend.

  requestId

  Location: query

  Type: string

  Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

  zone

  Type: string

  Required: Yes

  Description: The name of the zone for this request.

  Location: path

  Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

  project

  Location: path

  Description: Project ID for this request.

  Required: Yes

  Type: string

  Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

  Flat Path: projects/{project}/zones/{zone}/instances/{instance}/suspend

• ▼ ▲ compute.instances.resume

  Scopes:

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

  Description: Resumes an instance that was suspended using the instances().suspend method.

  Path: projects/{project}/zones/{zone}/instances/{instance}/resume

  Parameter Order:

  • project
  • zone
  • instance

  Flat Path: projects/{project}/zones/{zone}/instances/{instance}/resume

  HTTP Method: POST

  Parameters:

  instance

  Required: Yes

  Location: path

  Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

  Description: Name of the instance resource to resume.

  Type: string

  requestId

  Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

  Location: query

  Type: string

  zone

  Type: string

  Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

  Location: path

  Description: The name of the zone for this request.

  Required: Yes

  project

  Required: Yes

  Type: string

  Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

  Location: path

  Description: Project ID for this request.