Method: projects.locations.instances.diagnose

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

HTTP request

POST https://notebooks.googleapis.com/v2/{name}:diagnose

Path parameters

Parameters
name

string

Required. Format: projects/{projectId}/locations/{location}/instances/{instanceId}

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

  • notebooks.instances.diagnose

Request body

The request body contains data with the following structure:

JSON representation 
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
Fields
diagnosticConfig

object (DiagnosticConfig)

Required. Defines flags that are used to run the diagnostic tool
timeoutMinutes

integer

Optional. Maximum amount of time in minutes before the operation times out.

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.

DiagnosticConfig

Defines flags that are used to run the diagnostic tool

JSON representation 
{
  "gcsBucket": string,
  "relativePath": string,
  "enableRepairFlag": boolean,
  "enablePacketCaptureFlag": boolean,
  "enableCopyHomeFilesFlag": boolean
}
Fields
gcsBucket

string

Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (gs://$GCS_BUCKET).

Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode.

Cloud Storage bucket Log file will be written to gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relativePath

string

Optional. Defines the relative storage path in the Cloud Storage bucket where the diagnostic logs will be written: Default path will be the root directory of the Cloud Storage bucket (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz) Example of full path where Log file will be written: gs://$GCS_BUCKET/$RELATIVE_PATH/
enableRepairFlag

boolean

Optional. Enables flag to repair service for instance
enablePacketCaptureFlag

boolean

Optional. Enables flag to capture packets from the instance for 30 seconds
enableCopyHomeFilesFlag

boolean

Optional. Enables flag to copy all /home/jupyter folder contents