Get Active Head Node
Gets the name of the active head node of the HPC cluster.
Request
You can specify the Get Active Head Node request as follows.
| Method | Request URI |
|---|---|
| GET (before HPC Pack 2016) | https://head_node_name:port/WindowsHPC/HPC_cluster_name/ActiveHeadnode |
| GET (HPC Pack 2016) | https://head_node_name:port/WindowsHPC/ActiveHeadnode |
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 the HPC cluster, use the Get Clusters operation.
URI Parameters
You can specify the following additional parameters on the request URI.
| Parameter | Description |
|---|---|
| api-version | Required if the request does not contain the api-version header. Specifies the version of the operation to use for this request. To specify Microsoft HPC Pack 2008 R2 with Service Pack 4 (SP4), use a value of 2012-03-31.3.4. The minimum version that supports this URI parameter is Microsoft HPC Pack 2008 R2 with Service Pack 4 (SP4). The value of this URI parameter is ignored if the request also contains the api-version header. |
Request Headers
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
| api-version | Required if the request does not include the api-version URI parameter. Specifies the version of the operation to use for this request. To specify Microsoft HPC Pack 2008 R2 with Service Pack 4 (SP4), use a value of 2012-03-31.3.4. The minimum version that supports this header is Microsoft HPC Pack 2008 R2 with Service Pack 4 (SP4). The value specified in this header overrides the value specified in the api-version URI parameter if both are specified. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body in XML format.
Status Code
A successful operation returns status code 200 (OK). For more information about status codes, see HttpStatusCode.
Note: The error response will be contained in a 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.
| Response Header | Description |
|---|---|
| x-ms-hpc-authoritychain | A comma-separated list of RFC 1918 IP addresses that indicate the sequence of instances of the REST web service that the operation called in order from to right. Only responses from instances of the REST web service that are hosted on Azure contain this header. Responses from instances of the REST web service that are hosted on premise omit this header. |
The response for this operation also includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
Response Body
The format of the response body is as follows.
<string xmlns="https://schemas.microsoft.com/2003/10/Serialization/">active_head_node_name</string>
The response XML consists of a single string element that contains the name of the active head node of the HPC cluster.
Requirements
Product |
HPC Pack 2008 R2 with SP4, or a later version of HPC Pack. |