你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job - List Preparation And Release Task Status

  • 参考
服务:
Batch Service
API 版本:
2023-11-01.18.0

列出运行作业的计算节点上指定作业的作业准备和作业发布任务的执行状态。
此 API 在运行作业准备或作业发布任务的所有计算节点上返回作业准备和作业发布任务状态。 这包括此后已从池中删除的计算节点。 如果在没有作业准备或作业发布任务的作业上调用此 API，Batch 服务将返回 HTTP 状态代码 409 (冲突) ，错误代码为 JobPreparationTaskNotSpecified。

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
具有可选参数: 
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称 在 必需 类型 说明
batchUrl
 path True

string

所有Azure Batch服务请求的基 URL。
jobId
 path True

string

作业的 ID。
api-version
 query True

string

客户端 API 版本。
$filter
 query

string

OData $filter 子句。 有关构造此筛选器的详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status。
$select
 query

string

OData $select 子句。
maxresults
 query

integer

int32

响应中要返回的最大项数。 最多可以返回 1000 个任务。
timeout
 query

integer

int32

服务器可以花费处理请求的最长时间（以秒为单位）。 默认为 30 秒。

请求头

Media Types: "application/json; odata=minimalmetadata"

名称 必需 类型 说明
client-request-id

string

uuid

调用方生成的请求标识，采用不带修饰（如大括号）的 GUID 形式，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id

boolean

服务器是否应在响应中返回 client-request-id。
ocp-date

string

date-time-rfc1123

发出请求的时间。 客户端库通常将此设置为当前系统时钟时间;如果直接调用 REST API，请显式设置它。

响应

名称 类型 说明
200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

包含作业准备和作业发布任务状态列表的响应。

标头

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch 服务中的错误。 如果在没有作业准备或作业发布任务的作业上调用此 API，Batch 服务将返回 HTTP 状态代码 409。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Job list preparation and release task status

示例请求

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

示例响应

状态代码:
200 
{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

定义

名称 说明
BatchError

从Azure Batch服务收到的错误响应。
BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。
CloudJobListPreparationAndReleaseTaskStatusResult

列出作业的作业准备和作业释放任务的状态的结果。
ErrorCategory

错误的类别。
ErrorMessage

Azure Batch错误响应中收到的错误消息。
JobPreparationAndReleaseTaskExecutionInformation

计算节点上作业准备和作业释放任务的状态。
JobPreparationTaskExecutionInformation

包含有关在计算节点上执行作业准备任务的信息。
JobPreparationTaskState

计算节点上作业准备任务的当前状态。
JobReleaseTaskExecutionInformation

包含有关在计算节点上执行作业释放任务的信息。
JobReleaseTaskState

计算节点上作业释放任务的当前状态。
NameValuePair

表示一个名称-值对。
TaskContainerExecutionInformation

包含有关 Task 正在执行的容器的信息。
TaskExecutionResult

任务执行的结果。
TaskFailureInformation

有关任务失败的信息。

BatchError

从Azure Batch服务收到的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的，旨在以编程方式使用。
message

ErrorMessage

描述错误的消息，该消息适用于在用户界面中显示。
values

BatchErrorDetail[]

包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称 类型 说明
key

string

指定 Value 属性的含义的标识符。
value

string

错误响应附带的其他信息。

CloudJobListPreparationAndReleaseTaskStatusResult

列出作业的作业准备和作业释放任务的状态的结果。

名称 类型 说明
odata.nextLink

string

用于获取下一组结果的 URL。
value

JobPreparationAndReleaseTaskExecutionInformation[]

作业准备和作业释放任务执行信息的列表。

ErrorCategory

错误的类别。

名称 类型 说明
servererror

string

此错误是由于内部服务器问题导致的。
usererror

string

此错误是由于用户问题（例如配置错误）导致的。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。

JobPreparationAndReleaseTaskExecutionInformation

计算节点上作业准备和作业释放任务的状态。

名称 类型 说明
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

有关此计算节点上作业准备任务的执行状态的信息。
jobReleaseTaskExecutionInfo

JobReleaseTaskExecutionInformation

有关此计算节点上作业释放任务执行状态的信息。
仅当作业释放任务已在计算节点上运行时才设置此属性。
nodeId

string

此项引用的计算节点的 ID。
nodeUrl

string

此项引用的计算节点的 URL。
poolId

string

包含此条目引用的计算节点的池的 ID。

JobPreparationTaskExecutionInformation

包含有关在计算节点上执行作业准备任务的信息。

名称 类型 说明
containerInfo

TaskContainerExecutionInformation

有关执行 Task 的容器的信息。
仅当 Task 在容器上下文中运行时，才会设置此属性。
endTime

string

作业准备任务完成的时间。
仅当 Task 处于“已完成”状态时，才会设置此属性。
exitCode

integer

Task 命令行上指定的程序的退出代码。
仅当 Task 处于已完成状态时，才会返回此参数。 进程的退出代码反映了应用程序开发人员为该过程实现的特定约定。 如果使用退出代码值在代码中做出决策，请确保知道应用程序进程使用的退出代码约定。 请注意，退出代码也可能由计算节点操作系统生成，例如，当进程被强行终止时。
failureInfo

TaskFailureInformation

描述任务失败的信息（如果有）。
仅当 Task 处于已完成状态并遇到失败时，才会设置此属性。
lastRetryTime

string

作业准备任务重试开始运行的最新时间。
仅当重试 Task (即 retryCount 为非零) 时，才会设置此属性。 如果存在，这通常与 startTime 相同，但如果任务因重试以外的原因而重启，则可能会有所不同;例如，如果计算节点在重试期间重新启动，则 startTime 会更新，但 lastRetryTime 不会更新。
result

TaskExecutionResult

任务执行的结果。
如果值为“failed”，则可以在 failureInfo 属性中找到失败的详细信息。
retryCount

integer

Batch 服务重试 Task 的次数。 重试任务应用程序失败 (非零退出代码) ，) 无法运行任务 (预处理错误，并且不会重试文件上传错误。 Batch 服务将重试 Task，最大限制为约束指定的限制。
重试任务应用程序失败 (非零退出代码) ，) 无法运行任务 (预处理错误，并且不会重试文件上传错误。 Batch 服务将重试 Task，最大限制为约束指定的限制。
startTime

string

任务开始运行的时间。
如果任务已重启或重试，则这是任务开始运行的最新时间。
state

JobPreparationTaskState

计算节点上作业准备任务的当前状态。
taskRootDirectory

string

计算节点上作业准备任务的根目录。 可以使用此路径检索 Task 创建的文件，例如日志文件。
taskRootDirectoryUrl

string

计算节点上作业准备任务的根目录的 URL。

JobPreparationTaskState

计算节点上作业准备任务的当前状态。

名称 类型 说明
completed

string

任务已退出，退出代码为 0，或者任务已用尽重试限制，或者 Batch 服务因任务准备错误 (（如资源文件下载失败) ）而无法启动任务。
running

string

任务当前正在运行 (包括重试) 。

JobReleaseTaskExecutionInformation

包含有关在计算节点上执行作业释放任务的信息。

名称 类型 说明
containerInfo

TaskContainerExecutionInformation

有关执行 Task 的容器的信息。
仅当 Task 在容器上下文中运行时，才会设置此属性。
endTime

string

作业发布任务完成的时间。
仅当 Task 处于“已完成”状态时，才会设置此属性。
exitCode

integer

Task 命令行上指定的程序的退出代码。
仅当 Task 处于已完成状态时，才会返回此参数。 进程的退出代码反映了应用程序开发人员为该过程实现的特定约定。 如果使用退出代码值在代码中做出决策，请确保知道应用程序进程使用的退出代码约定。 请注意，退出代码也可能由计算节点操作系统生成，例如，当进程被强行终止时。
failureInfo

TaskFailureInformation

描述任务失败的信息（如果有）。
仅当 Task 处于已完成状态并遇到失败时，才会设置此属性。
result

TaskExecutionResult

任务执行的结果。
如果值为“failed”，则可以在 failureInfo 属性中找到失败的详细信息。
startTime

string

任务开始运行的时间。
如果任务已重启或重试，则这是任务开始运行的最新时间。
state

JobReleaseTaskState

计算节点上作业释放任务的当前状态。
taskRootDirectory

string

计算节点上作业释放任务的根目录。 可以使用此路径检索 Task 创建的文件，例如日志文件。
taskRootDirectoryUrl

string

计算节点上作业发布任务的根目录的 URL。

JobReleaseTaskState

计算节点上作业释放任务的当前状态。

名称 类型 说明
completed

string

任务已退出，退出代码为 0，或者任务已用尽重试限制，或者 Batch 服务因任务准备错误 (（如资源文件下载失败) ）而无法启动任务。
running

string

任务当前正在运行 (包括重试) 。

NameValuePair

表示一个名称-值对。

名称 类型 说明
name

string

名称/值对中的名称。
value

string

名称/值对中的值。

TaskContainerExecutionInformation

包含有关 Task 正在执行的容器的信息。

名称 类型 说明
containerId

string

容器的 ID。
error

string

有关容器的详细错误信息。
这是 Docker 服务的详细错误字符串（如果可用）。 它等效于“docker inspect”返回的错误字段。
state

string

容器的状态。
这是容器的状态（根据 Docker 服务）。 它等效于“docker inspect”返回的状态字段。

TaskExecutionResult

任务执行的结果。

名称 类型 说明
failure

string

处理任务期间出错。 失败可能发生在启动任务进程之前、任务进程正在执行或任务进程退出之后。
success

string

任务已成功运行。

TaskFailureInformation

有关任务失败的信息。

名称 类型 说明
category

ErrorCategory

任务错误的类别。
code

string

任务错误的标识符。 代码是固定的，旨在以编程方式使用。
details

NameValuePair[]

与错误相关的其他详细信息的列表。
message

string

描述任务错误的消息，该错误适用于在用户界面中显示。