Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2019-06-202346811.1 MB
Cluster

Gets the progress of the current cluster upgrade.

Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.

get/$/GetUpgradeProgress

Query parameters

api-version'6.0' required

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.

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.

Response

A successful operation will return 200 status code and the requested cluster upgrade progress.

CodeVersionstring

The ServiceFabric code version of the cluster.

ConfigVersionstring

The cluster configuration version (specified in the cluster manifest).

UpgradeState'Invalid' | 'RollingBackInProgress' | 'RollingBackCompleted' | 'RollingForwardPending' | 'RollingForwardInProgress' | 'RollingForwardCompleted' | 'Failed'

The state of the upgrade domain.

NextUpgradeDomainstring

The name of the next upgrade domain to be processed.

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

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

UpgradeDurationInMillisecondsstring

The estimated elapsed time spent processing the current overall upgrade.

UpgradeDomainDurationInMillisecondsstring

The estimated elapsed time spent processing the current upgrade domain.

StartTimestampUtcstring

The start time of the upgrade in UTC.

FailureTimestampUtcstring

The failure time of the upgrade in UTC.

FailureReason'None' | 'Interrupted' | 'HealthCheck' | 'UpgradeDomainTimeout' | 'OverallUpgradeTimeout'

The cause of an upgrade failure that resulted in FailureAction being executed.