Validate Cluster Upgrade

  • Article

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.

Request

Method Request URI
POST /$/ValidateUpgrade?api-version=8.2&timeout={timeout}

Parameters

Name Type Required Location
api-version string Yes Query
timeout integer (int64) No Query
StartClusterUpgradeDescription StartClusterUpgradeDescription Yes Body

api-version

Type: string
Required: Yes
Default: 8.2

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.

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.

StartClusterUpgradeDescription

Type: StartClusterUpgradeDescription
Required: Yes

Describes the parameters for starting a cluster upgrade.

Responses

HTTP Status Code Description Response Schema
200 (OK) 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.
 ValidateClusterUpgradeResult
All other status codes The detailed error response.
 FabricError