v1

latestSwagger 2.02026-07-1377151733.6 KB
Jobs

Gets the task counts for the specified job.

Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.

get/jobs/{jobId}/taskcounts

Path parameters

jobIdstring required

The ID of the job.

Query parameters

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring uuid

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc1123

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Response

A response containing the task counts for the specified job.

activeinteger required
runninginteger required
completedinteger required
succeededinteger required
failedinteger required