Start Node Transition
Starts or stops a cluster node.
Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in "Start" for the NodeTransitionType parameter. To stop a node, pass in "Stop" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet. Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation.
Request
| Method | Request URI |
|---|---|
| POST | /Faults/Nodes/{nodeName}/$/StartTransition/?api-version=6.0&OperationId={OperationId}&NodeTransitionType={NodeTransitionType}&NodeInstanceId={NodeInstanceId}&StopDurationInSeconds={StopDurationInSeconds}&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
nodeName |
string | Yes | Path |
api-version |
string | Yes | Query |
OperationId |
string (uuid) | Yes | Query |
NodeTransitionType |
string (enum) | Yes | Query |
NodeInstanceId |
string | Yes | Query |
StopDurationInSeconds |
integer (int32) | 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
NodeTransitionType
Type: string (enum)
Required: Yes
Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. Possible values include: 'Invalid', 'Start', 'Stop'
NodeInstanceId
Type: string
Required: Yes
The node instance ID of the target node. This can be determined through GetNodeInfo API.
StopDurationInSeconds
Type: integer (int32)
Required: Yes
InclusiveMinimum: 0
The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up.
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 |
|---|---|---|
| 202 (Accepted) | A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress. |
|
| All other status codes | The detailed error response. |
FabricError |