v2

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

Cluster

Start upgrading the configuration of a Service Fabric standalone cluster.

Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.

post/$/StartClusterConfigurationUpgrade

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.

Request body

ClusterConfigstring required

The cluster configuration as a JSON string. For example, this file contains JSON describing the nodes and other properties of the cluster.

HealthCheckRetryTimeoutstring duration

The length of time between attempts to perform health checks if the application or cluster is not healthy.

HealthCheckWaitDurationInSecondsstring duration

The length of time to wait after completing an upgrade domain before starting the health checks process.

HealthCheckStableDurationInSecondsstring duration

The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.

UpgradeDomainTimeoutInSecondsstring duration

The timeout for the upgrade domain.

UpgradeTimeoutInSecondsstring duration

The upgrade timeout.

MaxPercentUnhealthyApplicationsinteger

The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.

MaxPercentUnhealthyNodesinteger

The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.

MaxPercentDeltaUnhealthyNodesinteger

The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.

MaxPercentUpgradeDomainDeltaUnhealthyNodesinteger

The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.

Response

A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade.