Method: projects.locations.instances.diagnose

インスタンスを指定して診断ファイルを作成し、診断ツールを実行します。

HTTP リクエスト

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

パスパラメータ

パラメータ
name

string

必須。形式: projects/{projectId}/locations/{location}/instances/{instanceId}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
フィールド
diagnosticConfig

object (DiagnosticConfig)

必須。診断ツールを実行するために使用されるフラグを定義します

timeoutMinutes

integer

省略可。オペレーションがタイムアウトになるまでの最大時間(分単位)。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

DiagnosticConfig

診断ツールを実行するために使用されるフラグを定義します

JSON 表現
{
  "gcsBucket": string,
  "relativePath": string,
  "repairFlagEnabled": boolean,
  "packetCaptureFlagEnabled": boolean,
  "copyHomeFilesFlagEnabled": boolean
}
フィールド
gcsBucket

string

必須。ユーザーの Cloud Storage バケットのロケーション(必須)。パス接頭辞(gs://$GCS_BUCKET)でフォーマットする必要があります。

権限: ユーザー管理のノートブック: - storage.buckets.writer: VM に接続されているプロジェクトのサービス アカウントに付与する必要があります。Google マネージド ノートブック: - storage.buckets.writer: 認証モードに応じて、プロジェクトのサービス アカウントまたは VM に関連付けられたユーザー認証情報に付与する必要があります。

Cloud Storage バケット ログファイルが gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz に書き込まれます

relativePath

string

省略可。診断ログが書き込まれる Cloud Storage バケット内の相対ストレージ パスを定義します。デフォルトのパスは Cloud Storage バケットのルート ディレクトリ(gs://$GCS_BUCKET/$DATE_$TIME.tar.gz)です。ログファイルが書き込まれるフルパスの例: gs://$GCS_BUCKET/$RELATIVE_PATH/

repairFlagEnabled

boolean

省略可。インスタンスのサービスを修復するフラグを有効にします

packetCaptureFlagEnabled

boolean

省略可。インスタンスから 30 秒間パケットをキャプチャするフラグを有効にします

copyHomeFilesFlagEnabled

boolean

省略可。すべての /home/jupyter フォルダの内容をコピーするフラグを有効化