Uzyskiwanie kondycji repliki przy użyciu zasadGet Replica Health Using Policy

Pobiera kondycję repliki Service Fabric stanowej lub bez stanowego wystąpienia usługi przy użyciu określonych zasad.Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.

Pobiera kondycję repliki Service Fabric stanowej lub bez stanowego wystąpienia usługi.Gets the health of a Service Fabric stateful service replica or stateless service instance. Użyj filtru EventsHealthStateFilter, aby filtrować kolekcję zdarzeń kondycji zgłaszanych w klastrze na podstawie stanu kondycji.Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Użyj zasad ApplicationHealthPolicy, aby opcjonalnie zastąpić zasady kondycji używane do oceny kondycji.Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. Ten interfejs API używa tylko pola "ConsiderWarningAsError" w polu ApplicationHealthPolicy.This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. Pozostałe pola są ignorowane podczas oceny kondycji repliki.The rest of the fields are ignored while evaluating the health of the replica.

ŻądanieRequest

MetodaMethod Identyfikator URI żądaniaRequest URI
POSTPOST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

ParametryParameters

NazwaName TypType WymaganeRequired LokalizacjaLocation
partitionId string (uuid)string (uuid) TakYes ŚcieżkaPath
replicaId ciągstring TakYes ŚcieżkaPath
api-version ciągstring TakYes ZapytanieQuery
EventsHealthStateFilter liczba całkowitainteger NieNo ZapytanieQuery
timeout integer (int64)integer (int64) NieNo ZapytanieQuery
ApplicationHealthPolicy ApplicationHealthPolicyApplicationHealthPolicy NieNo TreśćBody

partitionId

Typ: string (uuid)Type: string (uuid)
Wymagane: TakRequired: Yes

Tożsamość partycji.The identity of the partition.


replicaId

Typ: ciągType: string
Wymagane: TakRequired: Yes

Identyfikator repliki.The identifier of the replica.


api-version

Typ: ciągType: string
Wymagane: TakRequired: Yes
Wartość domyślna:6.0Default: 6.0

Wersja interfejsu API.The version of the API. Ten parametr jest wymagany, a jego wartość musi być "6.0".This parameter is required and its value must be '6.0'.

Service Fabric interfejsu API REST jest oparta na wersji środowiska uruchomieniowego, w której interfejs API został wprowadzony lub zmieniony.Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric uruchomieniowe obsługuje więcej niż jedną wersję interfejsu API.Service Fabric runtime supports more than one version of the API. Jest to najnowsza obsługiwana wersja interfejsu API.This is the latest supported version of the API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może różnić się od odpowiedzi udokumentowanej w tej specyfikacji.If a lower API version is passed, the returned response may be different from the one documented in this specification.

Ponadto środowisko uruchomieniowe akceptuje dowolną wersję, która jest wyższa niż najnowsza obsługiwana wersja aż do bieżącej wersji środowiska uruchomieniowego.Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. Jeśli więc najnowsza wersja interfejsu API to 6.0, ale jeśli środowisko uruchomieniowe to 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API.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. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.However the behavior of the API will be as per the documented 6.0 version.


EventsHealthStateFilter

Typ: liczba całkowitaType: integer
Wymagane: NieRequired: No
Wartość domyślna:0Default: 0

Umożliwia filtrowanie kolekcji obiektów HealthEvent zwracanych na podstawie stanu kondycji.Allows filtering the collection of HealthEvent objects returned based on health state. Możliwe wartości tego parametru obejmują wartość całkowitą jednego z następujących stanów kondycji.The possible values for this parameter include integer value of one of the following health states. Zwracane są tylko zdarzenia zgodne z filtrem.Only events that match the filter are returned. Wszystkie zdarzenia są używane do oceny zagregowanego stanu kondycji.All events are used to evaluate the aggregated health state. Jeśli nie zostanie określony, zostaną zwrócone wszystkie wpisy.If not specified, all entries are returned. Wartości stanu to wyliczenie oparte na flagach, więc wartość może być kombinacją tych wartości uzyskaną za pomocą bitowego operatora "OR".The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. Na przykład jeśli podaną wartość wynosi 6, zwracane są wszystkie zdarzenia z wartością HealthState OK (2) i ostrzeżeniem (4).For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.

  • Domyślne — wartość domyślna.Default - Default value. Dopasowuje dowolną healthState.Matches any HealthState. Wartość wynosi zero.The value is zero.
  • Brak — filtr, który nie pasuje do żadnej wartości healthState.None - Filter that doesn't match any HealthState value. Służy do zwracania żadnych wyników dla danej kolekcji stanów.Used in order to return no results on a given collection of states. Wartość to 1.The value is 1.
  • Ok — filtr, który pasuje do danych wejściowych z wartością HealthState OK.Ok - Filter that matches input with HealthState value Ok. Wartość to 2.The value is 2.
  • Ostrzeżenie — filtr, który pasuje do danych wejściowych z wartością HealthState Warning.Warning - Filter that matches input with HealthState value Warning. Wartość to 4.The value is 4.
  • Błąd — filtr, który pasuje do danych wejściowych z wartością HealthState Błąd.Error - Filter that matches input with HealthState value Error. Wartość to 8.The value is 8.
  • Wszystkie — filtr, który pasuje do danych wejściowych z dowolną wartością HealthState.All - Filter that matches input with any HealthState value. Wartość to 65535.The value is 65535.

timeout

Typ: liczba całkowita (int64)Type: integer (int64)
Wymagane: NieRequired: No
Wartość domyślna:60Default: 60
InclusiveMaximum:4294967295InclusiveMaximum: 4294967295
InclusiveMinimum: 1InclusiveMinimum: 1

Limit czasu serwera dla wykonywania operacji w sekundach.The server timeout for performing the operation in seconds. Ten limit czasu określa czas trwania, przez który klient może czekać na zakończenie żądanej operacji.This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. Wartość domyślna dla tego parametru to 60 sekund.The default value for this parameter is 60 seconds.


ApplicationHealthPolicy

Typ: ApplicationHealthPolicyType: ApplicationHealthPolicy
Wymagane: NieRequired: No

Opisuje zasady kondycji używane do oceny kondycji aplikacji lub jednego z jej dzieci.Describes the health policies used to evaluate the health of an application or one of its children. Jeśli nie jest obecny, ocena kondycji używa zasad kondycji z manifestu aplikacji lub domyślnych zasad kondycji.If not present, the health evaluation uses the health policy from application manifest or the default health policy.

OdpowiedziResponses

Kod stanu HTTPHTTP Status Code OpisDescription Response SchemaResponse Schema
200 (OK)200 (OK) Pomyślna operacja zwróci kod stanu 200 i żądane informacje o kondycji repliki.A successful operation will return 200 status code and the requested replica health information.
ReplicaHealthReplicaHealth
Wszystkie inne kody stanuAll other status codes Szczegółowa odpowiedź o błędzie.The detailed error response.
FabricErrorFabricError