Export (0) Print
Expand All

Get Subtask

Gets the values of the specified properties for the specified subtask, or the values of all of the properties if no properties are specified.

Request

You can specify the Get Subtask request as follows.

MethodRequest URI
GEThttps://head_node_name:port/WindowsHPC/HPC_cluster_name/Job/job_identifier/Task/task_identifier/SubTask/subtask_identifier

 

For instances of the REST web service that are hosted in Windows 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 subtask for which you want to get values.

If you do not specify the Properties parameter, the response contains values for all of the properties of the subtask. If a property with a specified name does not exist for the subtask, an error occurs.

Render

Optional. Specifies the format in which to get the information about the subtask.

Specify RestPropRender to get an XML string that lists the names and values of the properties of the subtask. Specify HpcJobXml to get the information about the subtask as an XML string in the same format as a task XML file.

The default value is RestPropRender.

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 Windows 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 supported in previous versions.

 

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 body of the response depends on the renderer that you specify. The following example shows the format if you specify RestPropRender for Render parameter.


<ArrayOfProperty xmlns="http://schemas.microsoft.com/HPCS2008R2/common" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <Property>
        <Name>subtask_property1_name</Name>
        <Value>subtask_property1_value</Value>
    </Property>
    <Property>
        <Name>subtask_property2_name</Name>
        <Value>subtask_property2_value</Value>
    </Property>
    ...
<ArrayOfProperty>


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

ElementDescription
ArrayOfProperty

Represents the set of properties for the subtask.

Property

Represents a single property for the task.

Name

Contains the name of the property.

Value

Contains the value of the property.

 

The following example shows the format if you specify HpcJobXml for Render parameter and CreateTime,State for the Properties parameter.

  <Task Version="3.000" CreateTime="9/26/2011 9:31:28 PM" State="Finished" xmlns="http://schemas.microsoft.com/HPCS2008R2/scheduler/" /> 

If you specify HpcJobXml for Render parameter and do not specify a value for the Properties parameter, the task XML that you get contains information about custom properties in addition to the values for the built-in subtask properties. For more information about the information in task XML files, see Task Schema.

Remarks

The following table shows the subtask properties for which you can get the values. For information about the property, 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:
© 2014 Microsoft