查看工作和任務

本文說明如何查看 Batch 工作和工作。

事前準備

  1. 如果您從未使用過 Batch，請參閱「開始使用 Batch」，並完成專案和使用者的必要條件，啟用 Batch。

  2. 如要取得查看工作和工作所需的權限，請要求管理員授予您專案的 Batch 工作檢視者 (roles/batch.jobsViewer) 或 Batch 工作編輯者 (roles/batch.jobsEditor) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

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

查看工作

如要查看工作，請選取下列其中一種方法：

查看工作清單

您可以使用Google Cloud 控制台、gcloud CLI、Batch API、Go、Java、Node.js、Python 或 C++，查看目前專案中的工作清單。

主控台

  1. 如要使用Google Cloud 控制台查看目前專案中的工作清單，請前往「工作清單」頁面。

    前往工作清單

    工作清單可能有多頁。如要前往下一頁，請按一下畫面底部的「下一步」。

  2. 選用：如要篩選工作清單，請按一下 「篩選」。然後輸入或選取屬性和值。

    舉例來說，如要篩選清單，只顯示特定州別的職缺，請輸入以下內容：

    Status:JOB_STATE

    將 JOB_STATE 替換為工作狀態，例如 FAILED。

gcloud

查看所有工作

如要使用 gcloud CLI 查看目前專案中的工作清單，請使用 gcloud batch jobs list 指令。

gcloud batch jobs list

查看篩選後的工作清單

您可以視需要新增一或多個旗標，查看經過篩選的工作清單：

  • 如要只查看特定地點的職缺，請加入 --location 旗標。

  • 如要只根據篩選條件運算式查看工作，請指定 --filter 標記。

例如，使用以下指令：

gcloud batch jobs list \
    --location=LOCATION \
    --filter="FILTER_EXPRESSION"

更改下列內容：

  • LOCATION：一或多個職缺所在的地點。

  • FILTER_EXPRESSION：定義要列出職缺的篩選器運算式。篩選運算式必須定義一或多個以零或多個布林運算子 (AND、OR 和 NOT) 分隔的屬性值配對。

    例如，請參閱下列篩選器運算式：

    • 依工作狀態篩選：如要只查看特定狀態的工作，請使用下列篩選條件運算式：

      status.state="JOB_STATE"

      將 JOB_STATE 替換為工作狀態，例如 FAILED。

    • 根據標籤篩選： 假設專案已定義下列自訂標籤：

      • 如要在查看 Cloud Billing 報表時，指出研究團隊建立的工作及其資源，部分工作和資源會標示 team 標籤，並設為 research。

      • 如要指出時間敏感型工作負載，部分工作會顯示 deadline 標籤，並設為各種值。

      • 如要指出開發團隊已成功測試的可執行檔，部分可執行檔會顯示 tested 標籤，並設為 true。

      接著，您可以指定下列篩選運算式：

      (allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))

      這個篩選運算式只會列出符合下列所有條件的工作：

      • 研究團隊的工作，工作分配政策設為 research，並標有 team 標籤。

      • 符合下列至少一項條件的工作：

        • 時效性職缺，職缺上設有 deadline 標籤，且值為任意值。

        • 至少有一個可執行檔已通過測試的工作，也就是至少有一個可執行檔的 tested 標籤設為 true 的工作。

API

查看所有工作

如要使用 Batch API 查看目前專案中特定位置的作業清單，請對 jobs.list 方法發出 GET 要求。

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs

更改下列內容：

  • PROJECT_ID：目前專案的專案 ID。

  • LOCATION：職缺所在的位置。

查看篩選後的工作清單

您也可以指定 filter 查詢參數，根據篩選運算式查看篩選過的工作清單。

舉例來說，請提出下列 GET 要求：

GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION

將 FILTER_EXPRESSION 替換為使用 網址編碼的篩選運算式。篩選運算式必須定義一或多個以零或多個布林運算子 (AND、OR 和 NOT) 分隔的屬性值配對。

例如，請參閱下列篩選器運算式：

  • 依工作狀態篩選：如要只查看特定狀態的工作，請使用下列篩選條件運算式：

    status.state="JOB_STATE"

    將 JOB_STATE 替換為工作狀態，例如 FAILED。

  • 根據標籤篩選： 假設專案已定義下列自訂標籤：

    • 如要在查看 Cloud Billing 報表時，指出研究團隊建立的工作及其資源，部分工作和資源會標示 team 標籤，並設為 research。

    • 如要指出時間敏感型工作負載，部分工作會顯示 deadline 標籤，並設為各種值。

    • 如要指出開發團隊已成功測試的可執行檔，部分可執行檔會顯示 tested 標籤，並設為 true。

    接著，您可以指定下列篩選運算式：

    (allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))

    這個篩選運算式只會列出符合下列所有條件的工作：

    • 研究團隊的工作，工作分配政策設為 research，並標有 team 標籤。

    • 符合下列至少一項條件的工作：

      • 時效性職缺，職缺上設有 deadline 標籤，且值為任意值。

      • 至少有一個可執行檔已通過測試的工作，也就是至少有一個可執行檔的 tested 標籤設為 true 的工作。

Go

Go

詳情請參閱 Batch Go API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	"google.golang.org/api/iterator"
)

// Lists all jobs in the given project and region
func listJobs(w io.Writer, projectID, region string) error {
	// projectID := "your_project_id"
	// region := "us-central1"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.ListJobsRequest{
		Parent: fmt.Sprintf("projects/%s/locations/%s", projectID, region),
	}

	var jobs []*batchpb.Job
	it := batchClient.ListJobs(ctx, req)

	for {
		job, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("unable to list jobs: %w", err)
		}
		jobs = append(jobs, job)
	}

	fmt.Fprintf(w, "Jobs: %v\n", jobs)

	return nil
}

Java

Java

詳情請參閱 Batch Java API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Job;
import java.io.IOException;

public class ListJobs {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region hosting the jobs.
    String region = "europe-central2";

    listJobs(projectId, region);
  }

  // Get a list of all jobs defined in given region.
  public static void listJobs(String projectId, String region) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Construct the parent path of the job.
      String parent = String.format("projects/%s/locations/%s", projectId, region);

      for (Job job : batchServiceClient.listJobs(parent).iterateAll()) {
        System.out.println(job.getName());
      }
      System.out.println("Listed all batch jobs.");
    }
  }
}

Node.js

Node.js

詳情請參閱 Batch Node.js API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callListJobs() {
  // Construct request
  const request = {
    parent: `projects/${projectId}/locations/${region}`,
  };

  // Run request
  const iterable = await batchClient.listJobsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

await callListJobs();

Python

Python

詳情請參閱 Batch Python API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

from __future__ import annotations

from collections.abc import Iterable

from google.cloud import batch_v1


def list_jobs(project_id: str, region: str) -> Iterable[batch_v1.Job]:
    """
    Get a list of all jobs defined in given region.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosting the jobs.

    Returns:
        An iterable collection of Job object.
    """
    client = batch_v1.BatchServiceClient()

    return client.list_jobs(parent=f"projects/{project_id}/locations/{region}")

C++

C++

詳情請參閱 Batch C++ API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id) {
    auto const parent = "projects/" + project_id + "/locations/" + location_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    int i = 0;
    for (auto job : client.ListJobs(parent)) {
      if (!job) throw std::move(job).status();
      std::cout << "Job[" << i++ << "]  " << job->DebugString() << "\n";
    }
  }

查看工作詳細資料

您可以使用Google Cloud 控制台、gcloud CLI、Batch API、Go、Java、Node.js、Python 或 C++，查看目前專案中工作的詳細資料。

主控台

如要使用Google Cloud 控制台查看目前專案中的工作詳細資料，請按照下列步驟操作：

  1. 前往 Google Cloud 控制台的「Job list」(工作清單) 頁面。

    前往工作清單

  2. 在「Job name」(工作名稱) 欄中，按一下工作名稱。

    「Job details」(工作詳細資料) 頁面隨即開啟。

    系統預設會開啟「詳細資料」分頁。如要瞭解詳情，請按一下其他分頁標籤。

gcloud

如要使用 gcloud CLI 查看目前專案中某項工作的詳細資料，請使用 gcloud batch jobs describe 指令並加上 --location 旗標。

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

更改下列內容：

  • JOB_NAME：現有工作的名稱。

  • LOCATION：職缺所在的地點。

API

如要使用 Batch API 查看目前專案中某項工作的詳細資料，請向 jobs.get 方法發出 GET 要求。

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME

更改下列內容：

  • PROJECT_ID：目前專案的專案 ID。

  • LOCATION：職缺所在的地點。

  • JOB_NAME：現有工作的名稱。

Go

Go

詳情請參閱 Batch Go API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
)

// Retrieves the information about the specified job, most importantly its status
func getJob(w io.Writer, projectID, region, jobName string) (*batchpb.Job, error) {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.GetJobRequest{
		Name: fmt.Sprintf("projects/%s/locations/%s/jobs/%s", projectID, region, jobName),
	}

	response, err := batchClient.GetJob(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("unable to get job: %w", err)
	}

	fmt.Fprintf(w, "Job info: %v\n", response)

	return response, nil
}

Java

Java

詳情請參閱 Batch Java API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.JobName;
import java.io.IOException;

public class GetJob {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region hosts the job.
    String region = "europe-central2";

    // The name of the job you want to retrieve information about.
    String jobName = "JOB_NAME";

    getJob(projectId, region, jobName);
  }

  // Retrieve information about a Batch Job.
  public static void getJob(String projectId, String region, String jobName) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      Job job =
          batchServiceClient.getJob(
              JobName.newBuilder()
                  .setProject(projectId)
                  .setLocation(region)
                  .setJob(jobName)
                  .build());

      System.out.printf("Retrieved the job: %s ", job.getName());
    }
  }
}

Node.js

Node.js

詳情請參閱 Batch Node.js API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job you want to retrieve information about.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callGetJob() {
  // Construct request
  const request = {
    name: `projects/${projectId}/locations/${region}/jobs/${jobName}`,
  };

  // Run request
  const response = await batchClient.getJob(request);
  console.log(response);
}

await callGetJob();

Python

Python

詳情請參閱 Batch Python API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。


from google.cloud import batch_v1


def get_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    Retrieve information about a Batch Job.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosts the job.
        job_name: the name of the job you want to retrieve information about.

    Returns:
        A Job object representing the specified job.
    """
    client = batch_v1.BatchServiceClient()

    return client.get_job(
        name=f"projects/{project_id}/locations/{region}/jobs/{job_name}"
    )

C++

C++

詳情請參閱 Batch C++ API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    auto const name = "projects/" + project_id + "/locations/" + location_id +
                      "/jobs/" + job_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.GetJob(name);
    if (!response) throw std::move(response).status();
    std::cout << "GetJob() succeeded with " << response->DebugString() << "\n";
  }

查看工作

如要查看某項工作的任務，請選取下列其中一種方法：

查看工作任務清單

您可以使用Google Cloud 控制台、gcloud CLI、Batch API、Go、Java、Node.js、Python 或 C++，查看工作中的工作清單或工作的工作群組。

如要篩選工作或工作工作群組中的工作清單 (例如只列出已順利完成執行的工作)，請使用 gcloud CLI 或 Batch API。

主控台

如要使用Google Cloud 控制台查看工作任務摘要，請查看工作詳細資料，開啟「工作詳細資料」頁面。然後參閱「工作詳細資料」一節。

gcloud

如要使用 gcloud CLI 查看工作任務群組中的任務清單，請使用 gcloud batch tasks list 指令，並加上下列標記：

gcloud batch tasks list \
    --job=JOB_NAME \
    --location=LOCATION

更改下列內容：

  • JOB_NAME：現有工作的名稱。

  • LOCATION：職缺所在的位置。

視需要新增 --filter 旗標，根據篩選運算式查看工作任務群組中經過篩選的工作清單。

例如，使用以下指令：

gcloud batch tasks list \
    --job=example-job \
    --location=us-central1 \
    --filter="FILTER_EXPRESSION"

將 FILTER_EXPRESSION 替換為篩選運算式。

舉例來說，您可以指定下列篩選條件運算式，只查看工作中正在執行或已順利完成執行的工作：

STATE=RUNNING OR STATE=SUCCEEDED

API

如要使用 Batch API 查看作業工作群組中的工作清單，請對 tasks.list 方法發出 GET 要求：

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks

更改下列內容：

  • PROJECT_ID：目前專案的專案 ID。

  • LOCATION：職缺所在的地點。

  • JOB_NAME：現有工作的名稱。

  • TASK_GROUP_NAME：要查看詳細資料的工作群組名稱。值必須設為 group0。

您也可以指定 filter 查詢參數，根據篩選運算式，查看工作任務群組中經過篩選的工作清單。

舉例來說，請提出下列 GET 要求：

GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION

將 FILTER_EXPRESSION 替換為使用網址編碼的篩選運算式。

舉例來說，您可以指定下列篩選條件運算式，只查看工作中正在執行或已順利完成執行的工作：

STATE=RUNNING%20OR%20STATE=SUCCEEDED

請注意，網址編碼的篩選運算式代表下列解碼的篩選運算式：

STATE=RUNNING OR STATE=SUCCEEDED

Go

Go

詳情請參閱 Batch Go API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	"google.golang.org/api/iterator"
)

// Lists all tasks in the given project and region
func listTasks(w io.Writer, projectID, region, jobName, taskGroup string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"
	// taskGroup := "group0" // defaults to "group0" on job creation unless overridden

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.ListTasksRequest{
		Parent: fmt.Sprintf("projects/%s/locations/%s/jobs/%s/taskGroups/%s", projectID, region, jobName, taskGroup),
	}

	var tasks []*batchpb.Task
	it := batchClient.ListTasks(ctx, req)

	for {
		task, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("unable to list tasks: %w", err)
		}
		tasks = append(tasks, task)
	}

	fmt.Fprintf(w, "Tasks: %v\n", tasks)

	return nil
}

Java

Java

詳情請參閱 Batch Java API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Task;
import java.io.IOException;

public class ListTasks {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";
    // Name of the region hosts the job.
    String region = "europe-central2";
    // Name of the job which tasks you want to list.
    String jobName = "JOB_NAME";
    // Name of the group of tasks. Usually it's `group0`.
    String groupName = "group0";

    listTasks(projectId, region, jobName, groupName);
  }

  // Get a list of all jobs defined in given region.
  public static void listTasks(String projectId, String region, String jobName, String groupName)
      throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      String parent = String.format("projects/%s/locations/%s/jobs/%s/taskGroups/%s", projectId,
          region, jobName, groupName);
      for (Task task : batchServiceClient.listTasks(parent).iterateAll()) {
        System.out.println(task.getName());
      }
    }
  }
}

Node.js

Node.js

詳情請參閱 Batch Node.js API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job which tasks you want to list.
 */
// const jobName = 'YOUR_JOB_NAME';
/**
 * The name of the group of tasks. Usually it's `group0`.
 */
// const groupName = 'group0';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callListTasks() {
  // Construct request
  const request = {
    parent: `projects/${projectId}/locations/${region}/jobs/${jobName}/taskGroups/${groupName}`,
  };

  // Run request
  const iterable = await batchClient.listTasksAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

await callListTasks();

Python

Python

詳情請參閱 Batch Python API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

from __future__ import annotations

from collections.abc import Iterable

from google.cloud import batch_v1


def list_tasks(
    project_id: str, region: str, job_name: str, group_name: str
) -> Iterable[batch_v1.Task]:
    """
    Get a list of all jobs defined in given region.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosting the jobs.
        job_name: name of the job which tasks you want to list.
        group_name: name of the group of tasks. Usually it's `group0`.

    Returns:
        An iterable collection of Task objects.
    """
    client = batch_v1.BatchServiceClient()

    return client.list_tasks(
        parent=f"projects/{project_id}/locations/{region}/jobs/{job_name}/taskGroups/{group_name}"
    )

C++

C++

詳情請參閱 Batch C++ API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id, std::string const& group_id) {
    auto const parent = "projects/" + project_id + "/locations/" + location_id +
                        "/jobs/" + job_id + "/taskGroups/" + group_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    int i = 0;
    for (auto task : client.ListTasks(parent)) {
      if (!task) throw std::move(task).status();
      std::cout << "Task[" << i++ << "]  " << task->DebugString() << "\n";
    }
  }

查看工作詳細資料

您可以使用Google Cloud 主控台、gcloud CLI、Batch API、Go、Java、Node.js、Python 或 C++，查看工作詳細資料。

主控台

如要使用Google Cloud 控制台查看工作詳細資料，請查看工作詳細資料，開啟「工作詳細資料」頁面。然後參閱「工作詳細資料」一節。

gcloud

如要使用 gcloud CLI 查看工作詳細資料，請使用 gcloud batch tasks describe 指令，並加上下列旗標：

gcloud batch tasks describe TASK_INDEX \
  --location=LOCATION \
  --job=JOB_NAME \
  --task_group=TASK_GROUP_NAME

更改下列內容：

  • TASK_INDEX：要查看詳細資料的工作索引。在工作群組中，第一個工作的索引從 0 開始，每新增一個工作，索引就會增加 1。舉例來說，如果工作群組包含四項工作，則索引為 0、1、2 和 3。

  • TASK_GROUP_NAME：工作群組的名稱，其中包含您要查看詳細資料的工作。這個值必須設為 group0。

  • JOB_NAME：現有工作的名稱。

  • LOCATION：職缺所在的位置。

API

如要使用 Batch API 查看工作詳細資料，請向 tasks.get 方法發出 GET 要求：

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX

更改下列內容：

  • PROJECT_ID：目前專案的專案 ID。

  • LOCATION：職缺所在的地點。

  • JOB_NAME：現有工作的名稱。

  • TASK_GROUP_NAME：工作群組的名稱，其中包含您要查看詳細資料的工作。這個值必須設為 group0。

  • TASK_INDEX：要查看詳細資料的工作索引。在工作群組中，第一個工作的任務索引從 0 開始，每新增一個工作，索引就會遞增 1。舉例來說，如果工作群組包含四項工作，則索引為 0、1、2 和 3。

Go

Go

詳情請參閱 Batch Go API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
)

// Retrieves the information about the specified job, most importantly its status
func getTask(w io.Writer, projectID, region, jobName, taskGroup string, taskNumber int32) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"
	// taskGroup := "group0" // defaults to "group0" on job creation unless overridden
	// taskNumber := 0

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.GetTaskRequest{
		Name: fmt.Sprintf("projects/%s/locations/%s/jobs/%s/taskGroups/%s/tasks/%d",
			projectID, region, jobName, taskGroup, taskNumber),
	}

	response, err := batchClient.GetTask(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to get task: %w", err)
	}

	fmt.Fprintf(w, "Task info: %v\n", response)

	return nil
}

Java

Java

詳情請參閱 Batch Java API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Task;
import com.google.cloud.batch.v1.TaskName;
import java.io.IOException;

public class GetTask {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";
    // Name of the region hosts the job.
    String region = "europe-central2";
    // The name of the job you want to retrieve information about.
    String jobName = "JOB_NAME";
    // The name of the group that owns the task you want to check. Usually it's `group0`.
    String groupName = "group0";
    // Number of the task you want to look up.
    int taskNumber = 0;

    getTask(projectId, region, jobName, groupName, taskNumber);
  }

  // Retrieve information about a Task.
  public static void getTask(String projectId, String region, String jobName, String groupName,
      int taskNumber) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      Task task = batchServiceClient.getTask(TaskName.newBuilder()
          .setProject(projectId)
          .setLocation(region)
          .setJob(jobName)
          .setTaskGroup(groupName)
          .setTask(String.valueOf(taskNumber))
          .build());
      System.out.printf("Retrieved task information: %s", task.getName());
    }
  }
}

Node.js

Node.js

詳情請參閱 Batch Node.js API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job you want to retrieve information about.
 */
// const jobName = 'YOUR_JOB_NAME';
/**
 * The name of the group that owns the task you want to check.
 * Usually it's `group0`.
 */
// const groupName = 'group0';
/**
 * The number of the task you want to look up.
 */
// const taskNumber = 0;

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callGetJob() {
  // Construct request
  const request = {
    name:
      `projects/${projectId}/locations/${region}/jobs/${jobName}` +
      `/taskGroups/${groupName}/tasks/${taskNumber}`,
  };

  // Run request
  const response = await batchClient.getTask(request);
  console.log(response);
}

await callGetJob();

Python

Python

詳情請參閱 Batch Python API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。


from google.cloud import batch_v1


def get_task(
    project_id: str, region: str, job_name: str, group_name: str, task_number: int
) -> batch_v1.Task:
    """
    Retrieve information about a Task.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosts the job.
        job_name: the name of the job you want to retrieve information about.
        group_name: the name of the group that owns the task you want to check. Usually it's `group0`.
        task_number: number of the task you want to look up.

    Returns:
        A Task object representing the specified task.
    """
    client = batch_v1.BatchServiceClient()

    return client.get_task(
        name=f"projects/{project_id}/locations/{region}/jobs/{job_name}"
        f"/taskGroups/{group_name}/tasks/{task_number}"
    )

C++

C++

詳情請參閱 Batch C++ API 參考說明文件。

如要向 Batch 進行驗證，請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id, std::string const& group_id,
     std::string const& task_number) {
    auto const name = "projects/" + project_id + "/locations/" + location_id +
                      "/jobs/" + job_id + "/taskGroups/" + group_id +
                      "/tasks/" + task_number;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.GetTask(name);
    if (!response) throw std::move(response).status();
    std::cout << "GetTask() succeeded with " << response->DebugString() << "\n";
  }

後續步驟