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)	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない 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	コンピューティングノードでタスクスケジュールを無効にするときの現在実行中のタスクの対処方法。既定値は requeue です。

応答

名前	型	説明
200 OK		Batch サービスへの要求が成功しました。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

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
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

Authorization

型: apiKey
/: header

例

Node disable scheduling

要求のサンプル

HTTP

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	実行中のタスクプロセスを終了し、タスクを再キューします。タスクは、他のコンピューティングノードで再度実行することも、このコンピューティングノードでタスクのスケジュール設定を再度有効にした場合にも実行できます。タスクが終了するとすぐにオフライン状態になります。
taskcompletion	現在実行中のタスクの完了を許可します。待機中に新しいタスクをスケジュールしません。すべてのタスクが完了したら、オフライン状態になります。
terminate	実行中のタスクを終了します。タスクは、終了されたことを示す failureInfo で完了し、もう一度実行されません。タスクが終了するとすぐにオフライン状態になります。

ErrorMessage

Object

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード
value	string	メッセージのテキスト。

NodeDisableSchedulingParameter

Object

コンピューティングノードでスケジュールを無効にするオプション。

名前	型	説明
nodeDisableSchedulingOption	DisableComputeNodeSchedulingOption	コンピューティングノードでタスクスケジュールを無効にするときの現在実行中のタスクの対処方法。既定値は requeue です。

次の方法で共有

Compute Node - Disable Scheduling

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

Authorization

例

Node disable scheduling

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

DisableComputeNodeSchedulingOption

ErrorMessage

NodeDisableSchedulingParameter