Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Application

Gets details for the latest upgrade performed on this application.

Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.

get/Applications/{applicationId}/$/GetUpgradeProgress

Path parameters

applicationIdstring required

The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myappapp1" in 6.0+ and "myapp/app1" in previous versions.

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

The application upgrade details.

Namestring

The name of the target application, including the 'fabric:' URI scheme.

TypeNamestring

The application type name as defined in the application manifest.

TargetApplicationTypeVersionstring

The target application type version (found in the application manifest) for the application upgrade.

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. Not applicable to node-by-node upgrades.

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

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

UpgradeDurationInMillisecondsstring

The estimated total amount of time spent processing the overall upgrade.

UpgradeDomainDurationInMillisecondsstring

The estimated total amount of time spent processing the current upgrade domain.

StartTimestampUtcstring

The estimated UTC datetime when the upgrade started.

FailureTimestampUtcstring

The estimated UTC datetime when the upgrade failed and FailureAction was executed.

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

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

UpgradeStatusDetailsstring

Additional detailed information about the status of the pending upgrade.

IsNodeByNodeboolean

Indicates whether this upgrade is node-by-node.