Get Cluster Health Chunk
Gets the health of a Service Fabric cluster using health chunks.
Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities. To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.
Request
| Method | Request URI |
|---|---|
| GET | /$/GetClusterHealthChunk?api-version=6.0&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.0
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.
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 health chunk information. |
ClusterHealthChunk |
| All other status codes | The detailed error response. |
FabricError |