Method: projects.locations.instances.diagnose

Cria um arquivo de diagnóstico e executa a ferramenta de diagnóstico com base em uma instância.

Solicitação HTTP

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Formato: projects/{projectId}/locations/{location}/instances/{instanceId}

A autorização requer a seguinte permissão do IAM no recurso especificado name:

  • notebooks.instances.diagnose

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
Campos
diagnosticConfig

object (DiagnosticConfig)

Obrigatório. Define flags usadas para executar a ferramenta de diagnóstico

timeoutMinutes

integer

Opcional. Tempo máximo em minutos antes de a operação atingir o tempo limite.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

DiagnosticConfig

Define flags usadas para executar a ferramenta de diagnóstico

Representação JSON
{
  "gcsBucket": string,
  "relativePath": string,
  "enableRepairFlag": boolean,
  "enablePacketCaptureFlag": boolean,
  "enableCopyHomeFilesFlag": boolean
}
Campos
gcsBucket

string

Obrigatório. Local do bucket do Cloud Storage do usuário (OBRIGATÓRIO). Precisa ser formatado com o prefixo do caminho (gs://$GCS_BUCKET).

Permissões: notebooks gerenciados pelo usuário: - storage.buckets.writer: precisa ser concedida à conta de serviço do projeto anexada à VM. Notebooks gerenciados pelo Google: - storage.buckets.writer: precisa ser concedido à conta de serviço do projeto ou às credenciais do usuário anexadas à VM, dependendo do modo de autenticação.

O arquivo de registro do bucket do Cloud Storage será gravado em gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz

relativePath

string

Opcional. Define o caminho de armazenamento relativo no bucket do Cloud Storage em que os registros de diagnóstico serão gravados. O caminho padrão é o diretório raiz do bucket do Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Exemplo de caminho completo em que o arquivo de registro será gravado: gs://$GCS_BUCKET/$RELATIVE_PATH/

enableRepairFlag

boolean

Opcional. Ativa a flag para reparar o serviço da instância.

enablePacketCaptureFlag

boolean

Opcional. Ativa a flag para capturar pacotes da instância por 30 segundos

enableCopyHomeFilesFlag

boolean

Opcional. Ativa a flag para copiar todo o conteúdo da pasta /home/jupyter.