HPC Web Service API Reference

Beginning with Microsoft HPC Pack 2008 R2 with Service Pack 2 (SP2), Microsoft HPC Pack provides access to the HPC Job Scheduler Service by using an HTTP web service that is based on the representational state transfer (REST) model.

Later versions of Microsoft HPC Pack, including HPC Pack 2012, HPC Pack 2012 R2, and HPC Pack 2016, provide additional operations that provide information about nodes and node groups, and that allow you to create and manage SOA sessions, SOA requests, and SOA responses.

The HPC REST API defines a number of operations that you can perform, including the information that is expected in the HTTP requests that you send to the HPC REST web service and that is provided in the HTTP responses that you receive in return as part of each operation.

Note  

The HPC REST API does not define the manner in which you create and send these HTTP requests and process the HTTP responses. The approach you can use to work with the HTTP requests and responses varies depending on the programming language that you use, and can also vary depending on the libraries or other tools that you choose to install to work with HTTP requests and responses in your programming language of choice. Additional information about working with the HTTP requests and responses is beyond the scope of this documentation. For an example of how to work with HTTP requests and responses for operations in the HPC REST API, see Creating and Submitting Jobs by Using the REST API in Microsoft HPC Pack.

For certain operations (starting the Microsoft HPC Pack 2008 R2 with Service Pack 3 (SP3)), the api-version URI parameter or request header is required to use functionality that is available as of a certain version of Microsoft HPC Pack. The following table lists the values of the api-version parameter that correspond to versions of HPC Pack.

The following table shows the operations that are available in the REST API both when the REST web service is hosted in an on-premises cluster, and when the REST web service is hosted in Azure.

The following table shows the operations that are available only when the REST web service is hosted in Windows Azure. All of the operations are supported starting with Microsoft HPC Pack 2008 R2 with SP3.