Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Get Task List

Get Task List

Gets the values of the properties for all of the tasks in the specified job.

Request

You can specify the Get Task List request as follows.

MethodRequest URI
GEThttps://head_node_name:port/WindowsHPC/HPC_cluster_name/Job/job_identifier/Tasks

 

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.

ParameterDescription
Properties

Optional. A comma-separated list of the names for the properties of the tasks for which you want to get values.

If you do not specify the Properties parameter, the response contains values for the TaskId, Name, State, CommandLine, ExitCode, ParentJobId, JobTaskId, and InstanceId properties. For a list of the properties that you can specify, see the Remarks section.

If a property with a specified name does not exist for a task, an error occurs.

ExpandParametric

Optional. Specifies whether to get properties only for the master task for a parametric sweep task, or for all of the subtasks instead. True indicates that you want to get properties for all of the subtasks. False indicates that you want to get properties only for the master task. The default value is True.

QueryId

Specifies internal data from the x-ms-continuation-QueryId header from the response in the previous Get Task List operation in a continuation sequence of Get Task List operations. For more information, see the Response Headers section later in this topic.

CurrentObjectNumber

Specifies internal data from the x-ms-continuation-CurrentObjectNumber header from the response in the previous Get Task List operation in a set of Get Task List operations. For more information, see the Response Headers section later in this topic. Deprecated starting with Microsoft HPC Pack 2008 R2 with Service Pack 3 (SP3).

api-version

Optional. 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 URI parameter 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 HeaderDescription
api-version

Optional. 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 header 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.

CCP_Version

Optional. Specifies the version of the operation to use for this request.

Deprecated beginning with Microsoft HPC Pack 2008 R2 with Service Pack 3 (SP3).

 

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.

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="http://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="http://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 HeaderDescription
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.

This header is supported beginning with Microsoft HPC Pack 2008 R2 with SP3 and is not available in previous versions.

x-ms-continuation-queryId

Enables large sets of data to be returned in smaller responses across a continuation sequence of several requests. The value of this header is to be assigned to the queryId query string parameter in the next call in the sequence of calls to the Get Task List operation. The response to the Get Task List operation contains this header as long as additional data remains to be processed. You use the values of this header for one operation in the queryId URI parameter for the next operation.

The format of the data in this header is not guaranteed to remain unchanged. You should only copy the data in this header from one operation in a set of multiple operations to the queryId URI parameter for the next operation. You should not use the data in this header or depend on the format of the data in this header in any other way.

For an example of how to use this header and URI parameter in a way that potential changes will not impact, see the code for the sample client applications for REST API. For information about how to get these sample client applications, see Getting Sample Programs that use the REST API.

x-ms-continuation-CurrentObjectNumber

Contains internal data that support working with sets of data that are too large or too expensive to get in a single response body by dividing the Get Task List operation into a set of multiple Get Task List operations. The response to the Get Task List operation contains this header as long as additional data remains to be processed. You use the values of this header for one operation in the CurrentObjectNumber URI parameter for the next operation.

The format of the data in this header is not guaranteed to remain unchanged. You should only copy the data in this header from one operation in a set of multiple operations to the CurrentObjectNumber URI parameter for the next operation. You should not use the data in this header or depend on the format of the data in this header in any other way.

For an example of how to use this header and URI parameter in a way that potential changes will not impact, see the code for the sample client applications for REST API.

Deprecated starting with Microsoft HPC Pack 2008 R2 with SP3.

 

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="http://schemas.microsoft.com/HPCS2008R2/common" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Object>
        <Properties>
            <Property>
                <Name>task1_property1_name</Name>
                <Value>task1_property1_value</Value>
           </Property>
           <Property>
               <Name>task1_property2_name</Name>
               <Value>task1_property2_value</Value>
           </Property>
           ...
        </Properties>
    </Object>
        <Properties>
            <Property>
                <Name>task2_property1_name</Name>
                <Value>task2_property1_value</Value>
           </Property>
           <Property>
               <Name>task2_property2_name</Name>
               <Value>task2_property2_value</Value>
           </Property>
           ...
        </Properties>
    </Object>
    ...
</ArrayOfObject>

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

ElementDescription
ArrayOfObject

Represents the set of tasks in the specified job.

Object

Represents a single task.

Properties

Represents the set of properties for the task.

Property

Represents a single property for the task.

Name

Contains the name of the property.

Value

Contains the value of the property.

 

Remarks

The following table shows the task properties for which you can get the values. For information about the property, including the versions of Microsoft HPC Pack that support it, see the corresponding property of the ISchedulerTask or ITaskId interface in the managed API for Microsoft HPC Pack.

PropertyCorresponding ISchedulerTask or ITaskId Property
TaskId ISchedulerTask.TaskId
Name ISchedulerTask.Name
State ISchedulerTask.State
PreviousState ISchedulerTask.PreviousState
MinCores ISchedulerTask.MinimumNumberOfCores
MaxCores ISchedulerTask.MaximumNumberOfCores
MinNodes ISchedulerTask.MinimumNumberOfNodes
MaxNodes ISchedulerTask.MaximumNumberOfNodes
MinSockets ISchedulerTask.MinimumNumberOfSockets
MaxSockets ISchedulerTask.MaximumNumberOfSockets
RuntimeSeconds ISchedulerTask.Runtime
SubmitTime ISchedulerTask.SubmitTime
CreateTime ISchedulerTask.CreateTime
EndTime ISchedulerTask.EndTime
ChangeTime ISchedulerTask.ChangeTime
StartTime ISchedulerTask.StartTime
ParentJobId ISchedulerTask.ParentJobId
CommandLine ISchedulerTask.CommandLine
WorkDirectory ISchedulerTask.WorkDirectory
RequiredNodes ISchedulerTask.RequiredNodes
DependsOn ISchedulerTask.DependsOn
IsExclusive ISchedulerTask.IsExclusive
IsRerunnable ISchedulerTask.IsRerunnable
StdOutFilePath ISchedulerTask.StdOutFilePath
StdInFilePath ISchedulerTask.StdInFilePath
StdErrFilePath ISchedulerTask.StdErrFilePath
ExitCode ISchedulerTask.ExitCode
RequeueCount ISchedulerTask.RequeueCount
StartValue ISchedulerTask.StartValue
EndValue ISchedulerTask.EndValue
IncrementValue ISchedulerTask.IncrementValue
ErrorMessage ISchedulerTask.ErrorMessage
Output ISchedulerTask.Output
UserBlob ISchedulerTask.UserBlob
Type ISchedulerTask.Type
IsServiceConcluded ISchedulerTask.IsServiceConcluded
FailJobOnFailure ISchedulerTask.FailJobOnFailure
FailJobOnFailureCount ISchedulerTask.FailJobOnFailureCount
AllocatedCoreIds ISchedulerTask.AllocatedCoreIds
AllocatedNodes ISchedulerTask.AllocatedNodes
HasRuntime ISchedulerTask.HasRuntime
JobTaskId ITaskId.JobTaskId
InstanceId ITaskId.InstanceId
TaskValidExitCodes ISchedulerTask.ValidExitCodes

 

Requirements

Product

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

 

 

Show:
© 2015 Microsoft