Get Cluster Version

مقالة
04/13/2021

Get the current Service Fabric cluster version.

If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.

Request

Method	Request URI
GET	`/$/GetClusterVersion?api-version=6.4&timeout={timeout}`

Parameters

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

`api-version`

Type: string
Required: Yes
Default: 6.4

The version of the API. This parameter is required and its value must be '6.4'.

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.

Responses

HTTP Status Code	Description	Response Schema
200 (OK)	A successful operation will return 200 status code and the requested cluster version information.	ClusterVersion
All other status codes	The detailed error response.	FabricError

Examples