v10

latestSwagger 2.02026-07-132477431.2 MB

Cluster

Validate and assess the impact of a code or configuration version update of a Service Fabric cluster.

Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.

post/$/ValidateUpgrade

Query parameters

api-version'8.2' required

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

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 version 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 accepts 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 and the runtime is 6.1, 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.

timeoutinteger

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.

Request body

CodeVersionstring

The cluster code version.

ConfigVersionstring

The cluster configuration version.

UpgradeKind'Invalid' | 'Rolling'

The kind of upgrade out of the following possible values.

RollingUpgradeMode'Invalid' | 'UnmonitoredAuto' | 'UnmonitoredManual' | 'Monitored' | 'UnmonitoredDeferred'

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.

UpgradeReplicaSetCheckTimeoutInSecondsinteger

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

ForceRestartboolean

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Defines the order in which an upgrade proceeds through the cluster.

EnableDeltaHealthEvaluationboolean

When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

InstanceCloseDelayDurationInSecondsinteger

Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.

Response

A successful response means that the cluster code or configuration upgrade has valid parameters. The response body describes the assessed expected impact of the upgrade.

ServiceHostUpgradeImpact'Invalid' | 'None' | 'ServiceHostRestart' | 'UnexpectedServiceHostRestart'

The expected impact of the upgrade.

ValidationDetailsstring

A string containing additional details for the Fabric upgrade validation result.