Method: projects.locations.instances.diagnose

Crea un archivo de diagnóstico y ejecuta la herramienta de diagnóstico para una instancia determinada.

Solicitud HTTP

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

Parámetros de ruta

Parámetros
name

string

Obligatorio. Formato: projects/{projectId}/locations/{location}/instances/{instanceId}

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • notebooks.instances.diagnose

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
Campos
diagnosticConfig

object (DiagnosticConfig)

Obligatorio. Define marcas que se usan para ejecutar la herramienta de diagnóstico
timeoutMinutes

integer

Es opcional. Es la cantidad máxima de tiempo en minutos antes de que se agote el tiempo de espera de la operación.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

DiagnosticConfig

Define marcas que se usan para ejecutar la herramienta de diagnóstico

Representación JSON 
{
  "gcsBucket": string,
  "relativePath": string,
  "enableRepairFlag": boolean,
  "enablePacketCaptureFlag": boolean,
  "enableCopyHomeFilesFlag": boolean
}
Campos
gcsBucket

string

Obligatorio. Ubicación del bucket de Cloud Storage del usuario (OBLIGATORIO). Debe tener el formato con el prefijo de ruta (gs://$GCS_BUCKET).

Permisos: Notebooks administrados por el usuario: - storage.buckets.writer: Se debe otorgar a la cuenta de servicio del proyecto conectada a la VM. Notebooks administrados por Google: - storage.buckets.writer: Se debe otorgar a la cuenta de servicio del proyecto o a las credenciales de usuario adjuntas a la VM, según el modo de autenticación.

El archivo de registro del bucket de Cloud Storage se escribirá en gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relativePath

string

Es opcional. Define la ruta de almacenamiento relativa en el bucket de Cloud Storage en el que se escribirán los registros de diagnóstico. La ruta predeterminada será el directorio raíz del bucket de Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Ejemplo de ruta completa en la que se escribirá el archivo de registro: gs://$GCS_BUCKET/$RELATIVE_PATH/
enableRepairFlag

boolean

Es opcional. Habilita la marca para reparar el servicio de la instancia
enablePacketCaptureFlag

boolean

Es opcional. Habilita la marca para capturar paquetes de la instancia durante 30 segundos.
enableCopyHomeFilesFlag

boolean

Es opcional. Habilita la marca para copiar todo el contenido de la carpeta /home/jupyter.