使用超时限制任务和可运行对象的运行时间

本文档介绍了如何通过设置超时来限制任务和可运行对象的运行时间。

超时指定了任务或可运行对象可以运行的时长。Batch 不允许作业运行超过 14 天，并且不会为单个任务和可运行对象设置默认超时。因此，单个任务或可运行任务最长可以运行 14 天，之后会自动失败。但是，如果您的任务和可运行对象不会运行这么长时间，此配置可能会导致意外费用和延迟。为防止运行时间过长，您可以为任务和可运行对象设置超时。

准备工作

设置超时

您可以为可运行对象和/或任务设置超时。一个可运行对象的超时设置指定了该可运行对象的最长运行时间。任务的超时指定了该任务的最长运行时间，即其可运行对象的所有运行时间的总和。例如，如果某个任务有 3 个可同时运行且持续运行 1 分钟的任务，则该任务的运行时间为 3 分钟，而非 1 分钟。

如果您设置重叠的超时（例如可运行任务和可运行任务的任务的超时），则只需超过一个超时即可触发自动失败。例如，假设您将某个任务的超时设置为 60 秒，将该任务的每个可运行对象的超时设置为 120 秒。然后，当此示例任务及其所有可运行对象的运行时间总和超过 60 秒时，该任务及其所有可运行对象都会失败，并且无法触发 120 秒的超时。

如需为作业的任务和可运行对象选择适当的超时，请分析您之前运行的类似作业的日志，以确定类似工作负载的任务和可运行对象的典型运行时间。

设置任务超时

使用 Google Cloud CLI 或 REST API 创建一项作业，该作业在 JSON 文件的 taskSpec 对象中包含 maxRunDuration 字段：

{
    "taskGroups": [
      {
        "taskSpec": {
          ...
          "maxRunDuration": "TIMEOUT"
        }
      }
    ]
}

将 TIMEOUT 替换为您希望允许任务运行的最大秒数或小数部分。例如 255s。

为任务设置 255 秒超时的作业将具有类似于以下内容的 JSON 配置文件：

{
    "taskGroups": [
      {
        "taskSpec": {
          "runnables": [
            {
              "script": {
                "text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
              }
            }
          ],
          "maxRunDuration": "255s"
        },
        "taskCount": 3
      }
    ],
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
}

如果超出任务的超时，任务会自动失败，并且作业的状态事件和日志中的退出代码 50005 会显示超出的超时。如需详细了解超出的超时，请参阅有关退出代码 50005 的问题排查文档。

为可运行对象设置超时

使用 Google Cloud CLI 或 REST API 创建一项作业，该作业在 JSON 文件的 runnable 对象中包含 timeout 字段：

{
    "taskGroups": [
      {
        "taskSpec": {
          "runnables": [
            {
              ...
              "timeout": "TIMEOUT"
            }
          ]
        }
      }
    ]
}

将 TIMEOUT 替换为您希望允许可运行对象运行的最大秒数或小数部分。例如 3.5s。

为可运行对象设置 3.5 秒超时的作业将具有类似于以下内容的 JSON 配置文件：

{
    "taskGroups": [
      {
        "taskSpec": {
          "runnables": [
            {
              "script": {
                "text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
              },
              "timeout": "3.5s"
            }
          ]
        },
        "taskCount": 3
      }
    ],
    "logsPolicy": {
        "destination": "CLOUD_LOGGING"
    }
}

如果超出可运行项的超时，则可运行项会自动失败，并且作业的状态事件和日志中的退出代码 50005 表示已超出超时。如需详细了解超出的超时，请参阅有关退出代码 50005 的问题排查文档。

后续步骤