Batch Status and Error Codes

REST API operations for the Batch service return standard HTTP status codes, as defined in the HTTP/1.1 Status Code Definitions.

API operations may also return additional error information to provide the developer with more information about the error. For example, the following error response indicates that a query parameter specified on the request URI was invalid, and provides additional information about the invalid parameter’s name and value and the reason for the error.

{
  "code": "InvalidQueryParameterValue",
  "message": {
      "lang": "en-us",
      "value": "Value for one of the query parameters specified in the request URI is invalid"
  },
  "values": [{
      "key": "QueryParameterName",
      "value": "state"
  }, {
      "key": "QueryParameterValue",
      "value": "deleted"
  }, {
      "key": "Reason",
      "value": "invalid state"
  }]
}

The following sections provide lists of error codes for the Batch service:

• Common REST API Error Codes

• Batch Service Error Codes

• Job/Task Scheduling Error Codes

Common REST API Error Codes

The error codes listed in the following table may be returned by an operation on the Batch service.

Batch Service Error Codes

The error codes listed in the following table may be returned by an operation on the Batch service.

Job/Task Scheduling Error Codes

If the Batch service encounters an error when starting a task on a node, it marks the task as completed. The error information is returned within a failureInfo element in the response body of List the files associated with a task and Get information about a task APIs.

Similarly, if the Batch service encounters an error while starting the job, it marks the job as completed. This scheduling error information is returned within a schedulingError element in the response body of Get information about a job in Batch APIs.

The following table provides the list of categories for task scheduling errors.

Below is a sample pre-processing error returned by the Batch service.

{
  "preProcessingError": {
    "category": "UserError",
    "code": "BlobNotFound",
    "message": "The specified blob does not exist.",
    "values": {
      "name": "FilePath",
      "value": "myfile.txt"
    }
  }
}

The following table provides the list of job scheduling error codes that may be returned by the Batch service.

The following table provides the list of task scheduling error codes that may be returned by the Batch service.