Job - Get Task Counts
指定したジョブのタスク数を取得します。
タスク数は、アクティブ、実行中、または完了したタスクの状態によるタスクの数と、成功または失敗したタスクの数を提供します。 準備中の状態のタスクは、実行中としてカウントされます。 返される数値が常に最新であるとは限りません。 正確なタスク数が必要な場合は、リスト クエリを使用します。
GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2024-07-01.20.0GET {batchUrl}/jobs/{jobId}/taskcounts?timeout={timeout}&api-version=2024-07-01.20.0URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
batch
|
path | True |
string |
すべての Azure Batch サービス要求のベース URL。 |
|
job
|
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 を直接呼び出す場合は、明示的に設定します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
指定したジョブのタスク数を含む応答。 ヘッダー
|
|
| Other Status Codes |
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
例
Job get task counts
要求のサンプル
GET account.region.batch.azure.com/jobs/jobId/taskcounts?api-version=2024-07-01.20.0
応答のサンプル
{
"taskCounts": {
"active": 5,
"running": 7,
"completed": 4,
"succeeded": 2,
"failed": 2
},
"taskSlotCounts": {
"active": 5,
"running": 7,
"completed": 4,
"succeeded": 2,
"failed": 2
}
}定義
| 名前 | 説明 |
|---|---|
|
Batch |
Azure Batch サービスから受信したエラー応答。 |
|
Batch |
Azure Batch エラー応答に含まれる追加情報の項目。 |
|
Error |
Azure Batch エラー応答で受信したエラー メッセージ。 |
|
Task |
タスクはジョブの数をカウントします。 |
|
Task |
タスクと TaskSlot は、ジョブの数をカウントします。 |
|
Task |
TaskSlot はジョブの数をカウントします。 |
BatchError
Azure Batch サービスから受信したエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| message |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
|
| values |
エラーに関する追加の詳細を含むキーと値のペアのコレクション。 |
BatchErrorDetail
Azure Batch エラー応答に含まれる追加情報の項目。
| 名前 | 型 | 説明 |
|---|---|---|
| key |
string |
Value プロパティの意味を指定する識別子。 |
| value |
string |
エラー応答に含まれる追加情報。 |
ErrorMessage
Azure Batch エラー応答で受信したエラー メッセージ。
| 名前 | 型 | 説明 |
|---|---|---|
| lang |
string |
エラー メッセージの言語コード |
| value |
string |
メッセージのテキスト。 |
TaskCounts
タスクはジョブの数をカウントします。
| 名前 | 型 | 説明 |
|---|---|---|
| active |
integer (int32) |
アクティブな状態のタスクの数。 |
| completed |
integer (int32) |
完了状態のタスクの数。 |
| failed |
integer (int32) |
失敗したタスクの数。 結果 (executionInfo プロパティで見つかった) が 'failure' の場合、タスクは失敗します。 |
| running |
integer (int32) |
実行中または準備中の状態のタスクの数。 |
| succeeded |
integer (int32) |
成功したタスクの数。 結果 (executionInfo プロパティで見つかった) が 'success' の場合、タスクは成功します。 |
TaskCountsResult
タスクと TaskSlot は、ジョブの数をカウントします。
| 名前 | 型 | 説明 |
|---|---|---|
| taskCounts |
状態ごとのタスクの数。 |
|
| taskSlotCounts |
状態ごとのタスクに必要な TaskSlot の数。 |
TaskSlotCounts
TaskSlot はジョブの数をカウントします。
| 名前 | 型 | 説明 |
|---|---|---|
| active |
integer (int32) |
アクティブなタスクの TaskSlot の数。 |
| completed |
integer (int32) |
完了したタスクの TaskSlot の数。 |
| failed |
integer (int32) |
失敗したタスクの TaskSlot の数。 |
| running |
integer (int32) |
タスクを実行するための TaskSlot の数。 |
| succeeded |
integer (int32) |
成功したタスクの TaskSlot の数。 |