Disable Node
Deactivate a Service Fabric cluster node with the specified deactivation intent.
Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.
Method | Request URI |
---|---|
POST | /Nodes/{nodeName}/$/Deactivate?api-version=6.0&timeout={timeout} |
Name | Type | Required | Location |
---|---|---|---|
nodeName |
string | Yes | Path |
api-version |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
DeactivationIntentDescription |
DeactivationIntentDescription | Yes | Body |
Type: string
Required: Yes
The name of the node.
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.
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.
Type: DeactivationIntentDescription
Required: Yes
Describes the intent or reason for deactivating the node.
HTTP Status Code | Description | Response Schema |
---|---|---|
200 (OK) | A successful operation will return 200 status code. |
|
All other status codes | The detailed error response. |
FabricError |