Get Node Transition Progress

  • Article

Gets the progress of an operation started using StartNodeTransition.

Gets the progress of an operation started with StartNodeTransition using the provided OperationId.

Request

Method Request URI
GET /Faults/Nodes/{nodeName}/$/GetTransitionProgress?api-version=6.0&OperationId={OperationId}&timeout={timeout}

Parameters

Name Type Required Location
nodeName string Yes Path
api-version string Yes Query
OperationId string (uuid) Yes Query
timeout integer (int64) No Query

nodeName

Type: string
Required: Yes

The name of the node.

api-version

Type: string
Required: Yes
Default: 6.0

The version of the API. This parameter is required and its value must be '6.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

OperationId

Type: string (uuid)
Required: Yes

A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
200 (OK) Information about the progress of a node transition operation.
 NodeTransitionProgress
All other status codes The detailed error response.
 FabricError

Examples

Gets information about a completed NodeTransition operation

This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.

Request

GET http://localhost:19080/Faults/Nodes/N0060/$/GetTransitionProgress?api-version=6.0&OperationId=a9c24269-88e9-4812-b4ad-a0bf2b724ad4

200 Response

Body
{
  "State": "Completed",
  "NodeTransitionResult": {
    "ErrorCode": "0",
    "NodeResult": {
      "NodeName": "N0060",
      "NodeInstanceId": "131366982707950527"
    }
  }
}

Gets information about a running NodeTransition operation

This shows an example of output when GetTransitionProgress has a State of Running.

Request

GET http://localhost:19080/Faults/Nodes/N0060/$/GetTransitionProgress?api-version=6.0&OperationId=ed903556-acf1-489c-9f33-b484c31f9087

200 Response

Body
{
  "State": "Running"
}