Method: projects.locations.instances.diagnose

给定实例后,创建诊断文件并运行诊断工具。

HTTP 请求

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

路径参数

参数
name

string

必需。格式:projects/{projectId}/locations/{location}/instances/{instanceId}

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • notebooks.instances.diagnose

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "diagnosticConfig": {
    object (DiagnosticConfig)
  },
  "timeoutMinutes": integer
}
字段
diagnosticConfig

object (DiagnosticConfig)

必需。定义用于运行诊断工具的标志

timeoutMinutes

integer

可选。操作超时前的最长时间(以分钟为单位)。

响应正文

如果成功,则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围:

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

如需了解详情,请参阅 Authentication Overview

DiagnosticConfig

定义用于运行诊断工具的标志

JSON 表示法
{
  "gcsBucket": string,
  "relativePath": string,
  "enableRepairFlag": boolean,
  "enablePacketCaptureFlag": boolean,
  "enableCopyHomeFilesFlag": boolean
}
字段
gcsBucket

string

必需。用户 Cloud Storage 存储桶位置(必需)。必须使用路径前缀 (gs://$GCS_BUCKET) 进行格式化。

权限:用户管理的笔记本:- storage.buckets.writer:必须授予附加到虚拟机的项目的服务帐号。Google 管理的笔记本:- storage.buckets.writer:必须根据身份验证模式授予附加到虚拟机的项目的服务帐号或用户凭据。

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/

enableRepairFlag

boolean

可选。启用标志以修复实例的服务

enablePacketCaptureFlag

boolean

可选。启用标志以从实例捕获数据包 30 秒

enableCopyHomeFilesFlag

boolean

可选。启用标志以复制所有 /home/jupyter 文件夹内容