Method: projects.locations.instances.diagnose

Crée un fichier de diagnostic et exécute l'outil de diagnostic pour une instance donnée.

Requête HTTP

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

Paramètres de chemin

Paramètres
name

string

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

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • notebooks.instances.diagnose

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
Champs
diagnosticConfig

object (DiagnosticConfig)

Obligatoire. Définit les indicateurs utilisés pour exécuter l'outil de diagnostic
timeoutMinutes

integer

Facultatif. Durée maximale en minutes avant l'expiration de l'opération.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

DiagnosticConfig

Définit les indicateurs utilisés pour exécuter l'outil de diagnostic

Représentation JSON 
{
  "gcsBucket": string,
  "relativePath": string,
  "enableRepairFlag": boolean,
  "enablePacketCaptureFlag": boolean,
  "enableCopyHomeFilesFlag": boolean
}
Champs
gcsBucket

string

Obligatoire. Emplacement du bucket Cloud Storage de l'utilisateur (OBLIGATOIRE). Doit être mis en forme avec le préfixe de chemin d'accès (gs://$GCS_BUCKET).

Autorisations : Notebooks gérés par l'utilisateur : "storage.buckets.writer" doit être accordée au compte de service du projet associé à la VM. Notebooks gérés par Google : "storage.buckets.writer" doit être attribué au compte de service du projet ou aux identifiants utilisateur associés à la VM, selon le mode d'authentification.

Le fichier journal du bucket Cloud Storage sera écrit dans gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relativePath

string

Facultatif. Définit le chemin de stockage relatif dans le bucket Cloud Storage où les journaux de diagnostic seront écrits. Le chemin par défaut sera le répertoire racine du bucket Cloud Storage (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz). Exemple de chemin complet où le fichier journal sera écrit : gs://$GCS_BUCKET/$RELATIVE_PATH/
enableRepairFlag

boolean

Facultatif. Active le service de réparation pour l'instance
enablePacketCaptureFlag

boolean

Facultatif. Active le flag permettant de capturer les paquets de l'instance pendant 30 secondes.
enableCopyHomeFilesFlag

boolean

Facultatif. Active le flag pour copier tout le contenu du dossier /home/jupyter.