Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
MeshApplications

Gets the progress of the latest upgrade performed on this application resource.

Gets the upgrade progress information about the Application resource with the given name. The information include percentage of completion and other upgrade state information of the Application resource.

get/Resources/Applications/{applicationResourceName}/$/GetUpgradeProgress

Path parameters

applicationResourceNamestring required

The identity of the application.

Query parameters

api-version'7.0' required

The version of the API. This parameter is required and its value must be '7.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 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.

Response

OK

Namestring

Name of the Application resource.

TargetApplicationTypeVersionstring

The target application version for the application upgrade.

StartTimestampUtcstring

The estimated UTC datetime when the upgrade started.

UpgradeState'Invalid' | 'ProvisioningTarget' | 'RollingForward' | 'UnprovisioningCurrent' | 'CompletedRollforward' | 'RollingBack' | 'UnprovisioningTarget' | 'CompletedRollback' | 'Failed'

The state of the application resource upgrade.

PercentCompletedstring

The estimated percent of replicas are completed in the upgrade.

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

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

UpgradeDurationstring

The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

ApplicationUpgradeStatusDetailsstring

Additional detailed information about the status of the pending upgrade.

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).

FailureTimestampUtcstring

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