v3

latestSwagger 2.0raw.githubusercontent.com2019-08-0676156747.2 KB

Jobs

Gets lifetime summary statistics for all of the Jobs in the specified Account.

Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

get/lifetimejobstats

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 Job statistics for the lifetime of the Batch Account.

urlstring required

startTimestring date-time required

lastUpdateTimestring date-time required

userCPUTimestring duration required

kernelCPUTimestring duration required

wallClockTimestring duration required

The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries.

readIOpsinteger required

writeIOpsinteger required

readIOGiBnumber double required

writeIOGiBnumber double required

numSucceededTasksinteger required

A Task completes successfully if it returns exit code 0.

numFailedTasksinteger required

A Task fails if it exhausts its maximum retry count without returning exit code 0.

numTaskRetriesinteger required

waitTimestring duration required

The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics.