通过状态事件查看作业的历史记录

本文档介绍了如何查看批处理作业和任务的状态事件。状态事件可提供历史记录，供您分析作业，并且通常包含可用于问题排查的实用错误消息。

每个作业及其每个任务都有状态事件，这些事件由 Batch 在作业运行时自动创建。这些状态事件中的每项都描述了状态变化以及导致达到该状态的原因的详细信息。如需了解作业和任务状态，请参阅作业生命周期。（可选）您还可以将作业配置为包含自定义状态事件，用于描述可运行作业的进度。如需详细了解自定义状态事件，请参阅 配置自定义状态事件。

准备工作

  1. 如果您之前未使用过批处理功能，请参阅开始使用批处理，并完成适用于项目和用户的前提条件，以启用批处理功能。

  2. 如需获得查看作业和任务所需的权限，请让管理员向您授予项目的批量作业查看器 (roles/batch.jobsViewer) 或批量作业编辑器 (roles/batch.jobsEditor) IAM 角色。 如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

查看状态事件

作业级别（作业的 statusEvents[] 字段）和任务级别（每个任务的 statusEvents[] 字段）可能会显示不同的状态事件。

以下说明介绍了如何使用 Google Cloud 控制台、gcloud CLI 和 Batch API 查看状态事件。要使用客户端库语言，请按照下列步骤操作： 查看任务详情或 查看任务详情 然后查看相应的 statusEvents[] 字段。

查看作业的状态事件

控制台

要使用 Google Cloud 控制台，请按以下步骤操作：

  1. 在 Google Cloud 控制台中，前往作业列表页面。

    转到作业列表

  2. 在作业名称列中，点击作业的名称。

    作业详情页面随即打开。

    详情标签页默认处于打开状态。

  3. 点击事件标签页。

gcloud

要使用 gcloud CLI，请使用 gcloud batch jobs describe 命令、 然后查看 statusEvents[] 字段。

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

替换以下内容：

  • JOB_NAME：现有作业的名称。

  • LOCATION：作业的位置。

API

如需使用批处理 API 查看作业的状态事件，请向 jobs.get 方法发出 GET 请求，然后查看 statusEvents[] 字段。

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

替换以下内容：

  • PROJECT_ID： 项目 ID 当前项目的名称

  • LOCATION：位置 指定作业所在位置

  • JOB_NAME：现有作业的名称。

查看任务的状态事件

gcloud

如需使用 gcloud CLI 查看任务的状态事件，请使用 gcloud batch tasks describe 命令，然后查看 statusEvents[] 字段。

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

替换以下内容：

  • TASK_INDEX：您要查看的任务的索引 了解详情在任务组中，第一个任务的任务索引从 0 开始，每个额外的任务都会使任务索引递增 1。例如，包含四个任务的任务组的索引为 0、1、2 和 3。

  • JOB_NAME：现有作业的名称。

  • LOCATION：作业的位置。

  • TASK_GROUP_NAME：包含您要查看其详细信息的任务的任务组的名称。该值必须设置为 group0。

API

如需使用 Batch API 查看任务的状态事件，请向 tasks.get 方法发出 GET 请求，然后查看 statusEvents[] 字段。

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。

后续步骤