管理執行階段

管理執行階段

本頁說明如何管理 Colab Enterprise 執行階段，包括執行下列工作：

• 啟動執行階段。
• 停止執行階段。
• 中斷與執行階段的連線。
• 重新連線至執行階段。
• 變更連線的執行階段。
• 刪除執行階段。

必要的角色

如要取得管理 Colab Enterprise 執行階段所需的權限，請要求管理員授予您專案的 Colab Enterprise 使用者 (roles/aiplatform.colabEnterpriseUser) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

您或許還可透過自訂角色或其他預先定義的角色取得必要權限。

一或多個必要角色包含 dataform.repositories.list 權限。在專案中獲派 dataform.repositories.list 權限或「程式碼建立者」(roles/dataform.codeCreator)角色的使用者，可以使用 Dataform API 或 Dataform 指令列介面 (CLI)，列出該專案中的程式碼資產名稱。使用 BigQuery Studio 的非管理員只能查看自己建立或與自己共用的程式碼資產。

啟動執行階段

如要啟動執行階段，可以使用 Google Cloud 控制台、gcloud CLI 或 REST API。

控制台

如要啟動執行階段：

1. 前往 Google Cloud 控制台的 Colab Enterprise「Runtimes」頁面。

   前往執行階段

2. 在「Region」(區域) 選單中，選取包含執行階段的區域。

3. 選取要啟動的執行階段。

4. 按一下「啟動」。

gcloud

使用下列任何指令資料之前，請先替換以下項目：

• RUNTIME_ID：執行階段的 ID。
• PROJECT_ID：您的專案 ID。
• REGION：執行階段所在的區域。

執行下列指令：

Linux、macOS 或 Cloud Shell

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes start RUNTIME_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes start RUNTIME_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes start RUNTIME_ID ^
    --project=PROJECT_ID ^
    --region=REGION

如要進一步瞭解如何透過指令列建立執行階段範本，請參閱 gcloud CLI 說明文件。

REST

使用任何要求資料之前，請先替換以下項目：

• REGION：執行階段所在的區域。
• PROJECT_ID：您的專案 ID。
• RUNTIME_ID：執行階段的 ID。

HTTP 方法和網址：

POST https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start

如要傳送要求，請選擇以下其中一個選項：

curl

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI， 或使用 Cloud Shell，自動登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start"

PowerShell

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start" | Select-Object -Expand Content

如果成功，回應主體會包含 Operation 的執行個體。

詳情請參閱 notebookRuntimes.start REST API 說明文件。

停止執行階段

如要停止執行階段，可以使用 gcloud CLI 或 REST API。

gcloud

使用下列任何指令資料之前，請先替換以下項目：

• RUNTIME_ID：執行階段的 ID。
• PROJECT_ID：您的專案 ID。
• REGION：執行階段所在的區域。

執行下列指令：

Linux、macOS 或 Cloud Shell

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes stop RUNTIME_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes stop RUNTIME_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes stop RUNTIME_ID ^
    --project=PROJECT_ID ^
    --region=REGION

如要進一步瞭解如何透過指令列停止執行階段，請參閱 gcloud CLI 說明文件。

REST

使用任何要求資料之前，請先替換以下項目：

• REGION：執行階段所在的區域。
• PROJECT_ID：您的專案 ID。
• RUNTIME_ID：執行階段的 ID。

HTTP 方法和網址：

POST https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start

如要傳送要求，請選擇以下其中一個選項：

curl

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI， 或使用 Cloud Shell，自動登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start"

PowerShell

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID:start" | Select-Object -Expand Content

如果成功，回應主體會包含 Operation 的執行個體。

詳情請參閱 notebookRuntimes.stop REST API 說明文件。

中斷與執行階段的連線

如要中斷與執行階段的連線：

1. 前往 Google Cloud 控制台的 Colab Enterprise「我的筆記本」頁面。

   前往「我的筆記本」

2. 在「Region」(區域) 選單中，選取包含筆記本的區域。

3. 開啟要與執行階段中斷連線的筆記本。

4. 在標題工具列中，依序點選「執行階段」>「管理工作階段」。如果沒有看到標題工具列，請按一下「切換標題顯示設定」圖示 。

5. 在「Active sessions」(有效工作階段) 窗格中，按一下「End session」(結束工作階段) 按鈕 。

6. 按一下「終止」。

重新連線至執行階段

如要重新連線至執行階段，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的 Colab Enterprise「我的筆記本」頁面。

   前往「我的筆記本」

2. 在「Region」(區域) 選單中，選取包含筆記本的區域。

3. 開啟最近與執行階段中斷連線的筆記本。

4. 在筆記本的右上角， 按一下「重新連線」。

   如果筆記本先前連線的執行階段仍在執行，Colab Enterprise 會連線至該執行階段。如果該執行階段不再執行，系統會連線至預設執行階段。

變更執行階段

如要變更連線的執行階段：

1. 前往 Google Cloud 控制台的 Colab Enterprise「我的筆記本」頁面。

   前往「我的筆記本」

2. 在「Region」(區域) 選單中，選取包含筆記本的區域。

3. 開啟已連線至執行階段的筆記本。

4. 依序點選筆記本右上角的「其他連線選項」>「變更執行階段類型」。

5. 完成對話方塊，連線至執行階段。

刪除執行階段

如要刪除執行階段，可以使用 Google Cloud 控制台、gcloud CLI 或 REST API。

控制台

如要刪除執行階段，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的 Colab Enterprise「Runtimes」頁面。

   前往執行階段

2. 在「Region」(區域) 選單中，選取包含執行階段的區域。

3. 選取要刪除的執行階段。

4. 按一下「Delete」(刪除) 圖示 。

5. 按一下「確認」。

gcloud

使用下列任何指令資料之前，請先替換以下項目：

• RUNTIME_ID：執行階段的 ID。
• PROJECT_ID：您的專案 ID。
• REGION：執行階段所在的區域。

執行下列指令：

Linux、macOS 或 Cloud Shell

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes delete RUNTIME_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows (PowerShell)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes delete RUNTIME_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows (cmd.exe)

注意： 請確認您已透過執行下列任一指令，初始化 Google Cloud CLI 的驗證和專案： gcloud init； 或 gcloud auth login 和 gcloud config set project。

gcloud colab runtimes delete RUNTIME_ID ^
    --project=PROJECT_ID ^
    --region=REGION

如要進一步瞭解如何透過指令列建立執行階段範本，請參閱 gcloud CLI 說明文件。

REST

使用任何要求資料之前，請先替換以下項目：

• REGION：執行階段所在的區域。
• PROJECT_ID：您的專案 ID。
• RUNTIME_ID：執行階段的 ID。

HTTP 方法和網址：

DELETE https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID

如要傳送要求，請選擇以下其中一個選項：

curl

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI， 或使用 Cloud Shell，自動登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID"

PowerShell

注意： 下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。 您可以執行 gcloud auth list 查看目前有效的帳戶。

執行下列指令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimes/RUNTIME_ID" | Select-Object -Expand Content

如果成功，回應主體會包含 Operation 的執行個體。

詳情請參閱 notebookRuntimes.delete REST API 說明文件。

後續步驟

• 進一步瞭解執行階段和執行階段範本。
• 建立執行階段範本。