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
  • https://www.googleapis.com/auth/notebooks

詳情請參閱Authentication Overview。

DiagnosticConfig

定義用於執行診斷工具的旗標

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

string

這是必要旗標，使用者 Cloud Storage bucket 位置 (必填)。必須使用路徑前置字串 (gs://$GCS_BUCKET) 格式。

權限：使用者管理的 Notebook：- storage.buckets.writer：必須授予附加至 VM 的專案服務帳戶。Google Managed Notebooks：- storage.buckets.writer：視驗證模式而定，必須授予專案的服務帳戶或附加至 VM 的使用者憑證。

Cloud Storage bucket 記錄檔會寫入 gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
relativePath

string

選用。定義 Cloud Storage bucket 中的相對儲存路徑，診斷記錄會寫入該路徑：預設路徑為 Cloud Storage bucket 的根目錄 (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz)。記錄檔會寫入的完整路徑範例：gs://$GCS_BUCKET/$RELATIVE_PATH/
enableRepairFlag

boolean

選用。為執行個體啟用維修服務旗標
enablePacketCaptureFlag

boolean

選用。啟用標記，從執行個體擷取封包 30 秒
enableCopyHomeFilesFlag

boolean

選用。啟用旗標，複製所有 /home/jupyter 資料夾內容