Get Node Group List

Gets the names and descriptions for all of the node groups for the HPC cluster.

Request

You can specify the Get Node Group List request as follows.

Method	Request URI
GET (before HPC Pack 2016)	https://head_node_name:port/WindowsHPC/HPC_cluster_name/NodeGroups
GET (HPC Pack 2016)	https://head_node_name:port/WindowsHPC/NodeGroups

 

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 3 (SP3), use a value of 2011-11-01. The minimum version that supports this operation is Microsoft HPC Pack 2008 R2 with SP3. 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 SP3, use a value of 2011-11-01. The minimum version that supports this operation is Microsoft HPC Pack 2008 R2 with SP3. 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).

If the request includes neither the api-version URI parameter nor the api-version header, the operation returns status code 400 (Bad Request).

For more information about status codes, see HttpStatusCode.

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.

<ArrayOfObject xmlns="https://schemas.microsoft.com/HPCS2008R2/common" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Object>
        <Properties>
            <Property>
                <Name>Name</Name>
                <Value>nodegroup1_name</Value>
           </Property>
           <Property>
               <Name>Description</Name>
               <Value>nodegroup1_description</Value>
           </Property>
        </Properties>
    </Object>
    <Object>
        <Properties>
            <Property>
                <Name>Name</Name>
                <Value>nodegroup2_name</Value>
           </Property>
           <Property>
               <Name>Description</Name>
               <Value>nodegroup2_description</Value>
           </Property>
        </Properties>
    </Object>
    ...
</ArrayOfObject>

The following table describes each of the elements in the response XML.

Element	Description
ArrayOfObject	Represents the set of node groups in the HPC cluster.
Object	Represents a single node group.
Properties	Represents the set of properties for the node groups. The two properties for node groups are Name and Description.
Property	Represents a single property for the node group.
Name	Contains the name of the property.
Value	Contains the value of the property.

 

Requirements

Product

HPC Pack 2008 R2 with at least SP3, or a later version of HPC Pack.