你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Task - Update
汇报指定 Task 的属性。
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2023-11-01.18.0
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
batch
|
path | True |
string |
所有Azure Batch服务请求的基 URL。 |
job
|
path | True |
string |
包含任务的作业的 ID。 |
task
|
path | True |
string |
要更新的任务的 ID。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
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,请显式设置它。 |
|
If-Match |
string |
与客户端已知的资源版本关联的 ETag 值。 仅当服务上的资源当前 ETag 与客户端指定的值完全匹配时,才会执行该操作。 |
|
If-None-Match |
string |
与客户端已知的资源版本关联的 ETag 值。 仅当服务上的资源当前 ETag 与客户端指定的值不匹配时,才会执行该操作。 |
|
If-Modified-Since |
string date-time-rfc1123 |
一个时间戳,指示客户端已知的资源的上次修改时间。 仅当服务上的资源自指定时间以来已修改时,才会执行该操作。 |
|
If-Unmodified-Since |
string date-time-rfc1123 |
一个时间戳,指示客户端已知的资源的上次修改时间。 仅当服务上的资源自指定时间以来未修改时,才会执行该操作。 |
请求正文
Media Types: "application/json; odata=minimalmetadata"
名称 | 类型 | 说明 |
---|---|---|
constraints |
适用于此任务的约束。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
对 Batch 服务的请求已成功。 标头
|
|
Other Status Codes |
Batch 服务中的错误。 |
安全性
azure_auth
Microsoft Entra OAuth 2.0 身份验证代码流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
Authorization
类型:
apiKey
在:
header
示例
Task update
示例请求
PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0
{
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 3,
"retentionTime": "PT1H"
}
}
示例响应
定义
名称 | 说明 |
---|---|
Batch |
从Azure Batch服务收到的错误响应。 |
Batch |
Azure Batch错误响应中包含的其他信息项。 |
Error |
Azure Batch错误响应中收到的错误消息。 |
Task |
要应用于 Task 的执行约束。 |
Task |
要对任务进行的更改集。 |
BatchError
从Azure Batch服务收到的错误响应。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
描述错误的消息,该消息适用于在用户界面中显示。 |
|
values |
包含有关错误的其他详细信息的键值对的集合。 |
BatchErrorDetail
Azure Batch错误响应中包含的其他信息项。
名称 | 类型 | 说明 |
---|---|---|
key |
string |
指定 Value 属性含义的标识符。 |
value |
string |
错误响应附带的其他信息。 |
ErrorMessage
Azure Batch错误响应中收到的错误消息。
名称 | 类型 | 说明 |
---|---|---|
lang |
string |
错误消息的语言代码 |
value |
string |
消息的文本。 |
TaskConstraints
要应用于 Task 的执行约束。
名称 | 类型 | 说明 |
---|---|---|
maxTaskRetryCount |
integer |
可以重试任务的最大次数。 如果任务退出代码为非零,Batch 服务会重试任务。 |
maxWallClockTime |
string |
任务可能运行的最大已用时间,从任务启动时间开始计算。 如果任务未在时间限制内完成,Batch 服务将终止它。 |
retentionTime |
string |
在运行任务节点的计算节点上保留 Task 目录的最短时间,从它完成执行时算起。 在此之后,Batch 服务可能会删除 Task 目录及其所有内容。 |
TaskUpdateParameter
要对任务进行的更改集。
名称 | 类型 | 说明 |
---|---|---|
constraints |
适用于此任务的约束。 |