ランタイムを管理

このページでは、次のタスクを含む Colab Enterprise ランタイムの管理方法について説明します。

  • ランタイムを開始します。
  • ランタイムを停止します。
  • ランタイムから切断します。
  • ランタイムに再接続します。
  • 接続先のランタイムを変更します。
  • ランタイムを削除します。

必要なロール

Colab Enterprise ランタイムの管理に必要な権限を取得するには、プロジェクトに対する Colab Enterprise ユーザー（roles/aiplatform.colabEnterpriseUser）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ランタイムを開始する

ランタイムを開始するには、 Google Cloud コンソール、gcloud CLI、または REST API を使用します。

コンソール

ランタイムを開始するには:

  1. Google Cloud コンソールで、Colab Enterprise の [ランタイム] ページに移動します。

    [ランタイム] に移動

  2. [リージョン] メニューで、ランタイムを含むリージョンを選択します。

  3. 起動するランタイムを選択します。

  4. [起動] をクリックします。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

  • RUNTIME_ID: ランタイムの ID。
  • PROJECT_ID: プロジェクト ID。
  • REGION: ランタイムが配置されているリージョン。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

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

Windows（PowerShell）

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

Windows（cmd.exe）

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

コマンドラインからランタイム テンプレートを作成するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

REST

リクエストのデータを使用する前に、次のように置き換えます。

  • REGION: ランタイムが配置されているリージョン。
  • PROJECT_ID: プロジェクト ID。
  • RUNTIME_ID: ランタイムの ID。

HTTP メソッドと URL:

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

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

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

次のコマンドを実行します。 

$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

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

Windows（PowerShell）

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

Windows（cmd.exe）

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

コマンドラインからランタイムを停止するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

REST

リクエストのデータを使用する前に、次のように置き換えます。

  • REGION: ランタイムが配置されているリージョン。
  • PROJECT_ID: プロジェクト ID。
  • RUNTIME_ID: ランタイムの ID。

HTTP メソッドと URL:

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

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

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

次のコマンドを実行します。 

$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. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

  3. ランタイムから切断するノートブックを開きます。

  4. ヘッダー ツールバーで、[ランタイム] > [セッションの管理] をクリックします。ヘッダー ツールバーが表示されない場合は、 ヘッダーの表示 / 非表示を切り替えをクリックします。

  5. [アクティブ セッション] ペインで、 [セッションを終了] ボタンをクリックします。

  6. [Terminate] をクリックします。

ランタイムに再接続する

ランタイムに再接続するには:

  1. Google Cloud コンソールで、Colab Enterprise の [マイ ノートブック] ページに移動します。

    [マイ ノートブック] に移動

  2. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

  3. ランタイムから最近切断されたノートブックを開きます。

  4. ノートブックの右上にある [再接続] をクリックします。

    ノートブックが以前に接続されていたランタイムがまだ実行されている場合、Colab Enterprise はそのランタイムに接続します。そのランタイムが実行されていない場合は、デフォルトのランタイムに接続します。

ランタイムを変更する

接続先のランタイムを変更するには:

  1. Google Cloud コンソールで、Colab Enterprise の [マイ ノートブック] ページに移動します。

    [マイ ノートブック] に移動

  2. [リージョン] メニューで、ノートブックを含むリージョンを選択します。

  3. ランタイムに接続されているノートブックを開きます。

  4. ノートブックの右上にある  追加の接続オプション > ランタイム タイプの変更 をクリックします。

  5. ダイアログに入力して、ランタイムに接続します。

ランタイムを削除する

ランタイムを削除するには、 Google Cloud コンソール、gcloud CLI、または REST API を使用します。

コンソール

ランタイムを削除するには:

  1. Google Cloud コンソールで、Colab Enterprise の [ランタイム] ページに移動します。

    [ランタイム] に移動

  2. [リージョン] メニューで、ランタイムを含むリージョンを選択します。

  3. 削除するランタイムを選択します。

  4. [削除] をクリックします。

  5. [確認] をクリックします。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

  • RUNTIME_ID: ランタイムの ID。
  • PROJECT_ID: プロジェクト ID。
  • REGION: ランタイムが配置されているリージョン。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

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

Windows（PowerShell）

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

Windows（cmd.exe）

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

コマンドラインからランタイム テンプレートを作成するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

REST

リクエストのデータを使用する前に、次のように置き換えます。

  • REGION: ランタイムが配置されているリージョン。
  • PROJECT_ID: プロジェクト ID。
  • RUNTIME_ID: ランタイムの ID。

HTTP メソッドと URL:

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

リクエストを送信するには、次のいずれかのオプションを選択します。

curl

次のコマンドを実行します。

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

次のコマンドを実行します。 

$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 のドキュメントをご覧ください。

次のステップ