Sign in

v10

latestSwagger 2.02026-07-132477431.2 MB
Replica

Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.

Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.

post/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth

Path parameters

partitionIdstring uuid required

The identity of the partition.

replicaIdstring required

The identifier of the replica.

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.

EventsHealthStateFilterinteger

Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.

  • Default - Default value. Matches any HealthState. The value is zero.
  • None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
  • Ok - Filter that matches input with HealthState value Ok. The value is 2.
  • Warning - Filter that matches input with HealthState value Warning. The value is 4.
  • Error - Filter that matches input with HealthState value Error. The value is 8.
  • All - Filter that matches input with any HealthState value. The value is 65535.
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

ConsiderWarningAsErrorboolean

Indicates whether warnings are treated with the same severity as errors.

MaxPercentUnhealthyDeployedApplicationsinteger

The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.

Response

A successful operation will return 200 status code and the requested replica health information.

AggregatedHealthState'Invalid' | 'Ok' | 'Warning' | 'Error' | 'Unknown'

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.