Compute Node - Reboot
重启指定的计算节点。
仅当计算节点处于空闲或正在运行状态时,才能重启计算节点。
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reboot?api-version=2024-07-01.20.0POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reboot?timeout={timeout}&api-version=2024-07-01.20.0URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 | 
|---|---|---|---|---|
| batch | path | True | string | 所有 Azure Batch 服务请求的基本 URL。 | 
| node | path | True | string | 要重启的计算节点的 ID。 | 
| pool | path | True | string | 包含计算节点的池的 ID。 | 
| api-version | query | True | string | 客户端 API 版本。 | 
| timeout | query | integer (int32) | 服务器处理请求的最长时间(以秒为单位)。 默认值为 30 秒。 如果该值大于 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,请显式设置它。 | 
请求正文
Media Types: "application/json; odata=minimalmetadata"
| 名称 | 类型 | 说明 | 
|---|---|---|
| nodeRebootOption | 何时重新启动计算节点以及当前正在运行的任务要执行的操作。 | 
响应
| 名称 | 类型 | 说明 | 
|---|---|---|
| 202 Accepted | 对 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
			
示例
Node reboot
示例请求
POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/reboot?api-version=2024-07-01.20.0
{
  "nodeRebootOption": "terminate"
}
示例响应
定义
| 名称 | 说明 | 
|---|---|
| Batch | 从 Azure Batch 服务收到的错误响应。 | 
| Batch | Azure Batch 错误响应中包含的附加信息项。 | 
| Compute | 何时重新启动计算节点以及当前正在运行的任务要执行的操作。 | 
| Error | Azure Batch 错误响应中收到的错误消息。 | 
| Node | 用于重新启动计算节点的选项。 | 
BatchError 
			
			从 Azure Batch 服务收到的错误响应。
| 名称 | 类型 | 说明 | 
|---|---|---|
| code | string | 错误的标识符。 代码是固定的,旨在以编程方式使用。 | 
| message | 描述错误的消息,旨在适合在用户界面中显示。 | |
| values | 包含有关错误的更多详细信息的键值对的集合。 | 
BatchErrorDetail  
			
			Azure Batch 错误响应中包含的附加信息项。
| 名称 | 类型 | 说明 | 
|---|---|---|
| key | string | 指定 Value 属性含义的标识符。 | 
| value | string | 错误响应附带的其他信息。 | 
ComputeNodeRebootOption   
			
			何时重新启动计算节点以及当前正在运行的任务要执行的操作。
| 值 | 说明 | 
|---|---|
| requeue | 终止正在运行的任务进程并重新排队任务。 当计算节点可用时,任务将再次运行。 在任务终止后立即重启计算节点。 | 
| terminate | 终止正在运行的任务。 任务将通过 failureInfo 完成,指示它们已终止,并且不会再次运行。 在任务终止后立即重启计算节点。 | 
| taskcompletion | 允许当前运行的任务完成。 等待时不安排新任务。 完成所有任务后,重启计算节点。 | 
| retaineddata | 已弃用,建议将任务数据上传到任务中的 Azure 存储,并改用  | 
ErrorMessage 
			
			Azure Batch 错误响应中收到的错误消息。
| 名称 | 类型 | 说明 | 
|---|---|---|
| lang | string | 错误消息的语言代码 | 
| value | string | 消息的文本。 | 
NodeRebootParameter  
			
			用于重新启动计算节点的选项。
| 名称 | 类型 | 说明 | 
|---|---|---|
| nodeRebootOption | 何时重新启动计算节点以及当前正在运行的任务要执行的操作。 |