Submit Job

Submits a job to the HPC Job Scheduler Service so that the HPC Job Scheduler Service can add the job to the queue of jobs to run.

Request

You can specify the Submit Job request as follows.

For instances of the REST web service that are hosted in Azure, the head node name should have a format of Windows_Azure_service_name.cloudapp.net.

To get the name to use for an HPC cluster that runs at least Microsoft HPC Pack 2008 R2 with Service Pack 3 (SP3), use the Get Clusters operation.

URI Parameters

You can specify the following additional parameters on the request URI.

Request Headers

The following table describes required and optional request headers.

Request Body

The format of the request body is as follows.

<ArrayOfProperty xmlns="https://schemas.microsoft.com/HPCS2008R2/common">
    <Property>
        <Name>Property Name</Name>
        <Value>Property Value</Value>
    </Property>
    <Property>
        <Name>Property Name</Name>
        <Value>Property Value</Value>
    </Property>
    …
</ArrayOfProperty>

The following table describes each of the elements in this request XML.

Response

The response includes an HTTP status code and a set of response headers.

Status Code

A successful operation returns status code 200 (OK). For more information about status codes, see HttpStatusCode.

The error response is dependent upon the api-version used in the request. If the api-version is not provided, or CCP_Version is specified, then the error response will be an XML string (Note: The error message will vary based on the error):

<string xmlns="https://schemas.microsoft.com/2003/10/Serialization/">Error message text.</string>

If the api-version is 2011-11-01 or later, the error message will be a more descriptive XML response (Note: Values will vary based on the error):

<HpcWebServiceFault xmlns="https://schemas.microsoft.com/HPCS2008R2/common" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>267386880</Code>
  <Message>Error message text.</Message>
  <Values i:nil="true" xmlns:a="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
</HpcWebServiceFault>

Response Headers

The response for this operation includes the following headers.

The response for this operation also includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

None.

Remarks

If the credentials for the account under which the job should run are not cached on the server, you can set them in the UserName and Password properties.

A job that is submitted by using this operation is not validated. After the job is submitted, you can get information about the job by using theGet Job operation.

The following table shows the job properties for which you can set the values when you submit the job to the HPC Job Scheduler Service. For information about the property, including the versions of Microsoft HPC Pack that support it, see the corresponding property of the ISchedulerJob interface or JobPropertyIds class in the managed API for Microsoft HPC Pack.

Requirements