通过

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

Compute Node - Disable Scheduling

服务:
Batch Service
API 版本:
2024-07-01.20.0

禁用指定计算节点上的任务计划。
仅当计算节点上启用了任务的当前计划状态时，才能禁用任务计划。

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?api-version=2024-07-01.20.0
具有可选参数: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/disablescheduling?timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

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

string

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

string

要禁用任务计划的计算节点的 ID。
poolId
 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"

名称 类型 说明
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

在计算节点上禁用任务计划时，当前正在运行的任务该怎么办。
默认值为重新排队。

响应

名称 类型 说明
200 OK

对 Batch 服务的请求成功。

标头

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

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Node disable scheduling

示例请求

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/disablescheduling?api-version=2024-07-01.20.0



{
  "nodeDisableSchedulingOption": "terminate"
}

示例响应

状态代码:
200

定义

名称 说明
BatchError

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

Azure Batch 错误响应中包含的附加信息项。
DisableComputeNodeSchedulingOption

在计算节点上禁用任务计划时，当前正在运行的任务该怎么办。
ErrorMessage

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

用于在计算节点上禁用计划的选项。

BatchError

Object

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

名称 类型 说明
code

string

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

ErrorMessage

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

BatchErrorDetail[]

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

BatchErrorDetail

Object

Azure Batch 错误响应中包含的附加信息项。

名称 类型 说明
key

string

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

string

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

DisableComputeNodeSchedulingOption

枚举

在计算节点上禁用任务计划时，当前正在运行的任务该怎么办。

值 说明
requeue

终止正在运行的任务进程并重新排队任务。 任务可以在其他计算节点上再次运行，或者在此计算节点上重新启用任务计划时。 在任务终止后立即进入脱机状态。
terminate

终止正在运行的任务。 任务将通过 failureInfo 完成，指示它们已终止，并且不会再次运行。 在任务终止后立即进入脱机状态。
taskcompletion

允许当前运行的任务完成。 等待时不安排新任务。 完成所有任务后进入脱机状态。

ErrorMessage

Object

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

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。

NodeDisableSchedulingParameter

Object

用于在计算节点上禁用计划的选项。

名称 类型 说明
nodeDisableSchedulingOption

DisableComputeNodeSchedulingOption

在计算节点上禁用任务计划时，当前正在运行的任务该怎么办。
默认值为重新排队。