Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

指定したジョブのタスク数を取得します。
タスク数は、アクティブ、実行中、または完了したタスクの状態別のタスクの数と、成功または失敗したタスクの数を提供します。 準備中の状態のタスクは、実行中としてカウントされます。 返される数値が常に最新であるとは限りません。 正確なタスク数が必要な場合は、リスト クエリを使用します。

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?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 のバージョン。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 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 を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	TaskCountsResult	指定したジョブのタスク数を含む応答。 Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

Authorization

Type: apiKey
In: header

例

Job get task counts

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "taskCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  },
  "taskSlotCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  }
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batchエラー応答に含まれる追加情報の項目。
ErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
TaskCounts	タスクはジョブの数をカウントします。
TaskCountsResult	Task と TaskSlot はジョブのカウントです。
TaskSlotCounts	TaskSlot はジョブの数をカウントします。

BatchError

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message	ErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batchエラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

ErrorMessage

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

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

TaskCounts

タスクはジョブの数をカウントします。

名前	型	説明
active	integer	アクティブな状態のタスクの数。
completed	integer	完了状態のタスクの数。
failed	integer	失敗したタスクの数。 Task は、その結果 (executionInfo プロパティで見つかった) が 'failure' の場合に失敗します。
running	integer	実行中または準備中の状態のタスクの数。
succeeded	integer	成功したタスクの数。 Task は、その結果 (executionInfo プロパティにあります) が 'success' の場合に成功します。

TaskCountsResult

Task と TaskSlot はジョブのカウントです。

名前	型	説明
taskCounts	TaskCounts	状態ごとのタスクの数。
taskSlotCounts	TaskSlotCounts	状態ごとのタスクに必要な TaskSlot の数。

TaskSlotCounts

TaskSlot はジョブの数をカウントします。

名前	型	説明
active	integer	アクティブなタスクの TaskSlot の数。
completed	integer	完了したタスクの TaskSlot の数。
failed	integer	失敗したタスクの TaskSlot の数。
running	integer	タスクを実行するための TaskSlot の数。
succeeded	integer	成功したタスクの TaskSlot の数。