Získání stavu repliky pomocí zásadGet Replica Health Using Policy

Pomocí zadaných zásad Získá stav repliky stavové služby Service Fabric nebo instance bezstavové služby.Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.

Získá stav repliky stavové služby Service Fabric nebo instance bezstavové služby.Gets the health of a Service Fabric stateful service replica or stateless service instance. Pomocí EventsHealthStateFilter můžete filtrovat kolekci událostí stavu hlášených v clusteru na základě stavu.Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Pomocí ApplicationHealthPolicy můžete volitelně přepsat zásady stavu používané k vyhodnocení stavu.Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. Toto rozhraní API používá pouze pole ' ConsiderWarningAsError ' objektu ApplicationHealthPolicy.This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. Zbytek polí se při vyhodnocování stavu repliky ignoruje.The rest of the fields are ignored while evaluating the health of the replica.

ŽádostRequest

MetodaMethod Identifikátor URI žádostiRequest URI
POSTPOST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

ParametryParameters

NázevName TypType VyžadovánoRequired UmístěníLocation
partitionId řetězec (UUID)string (uuid) AnoYes CestaPath
replicaId stringstring AnoYes CestaPath
api-version stringstring AnoYes DotazQuery
EventsHealthStateFilter integerinteger NeNo DotazQuery
timeout celé číslo (Int64)integer (int64) NeNo DotazQuery
ApplicationHealthPolicy ApplicationHealthPolicyApplicationHealthPolicy NeNo TextBody

partitionId

Typ : String (UUID)Type : string (uuid)
Požadováno : AnoRequired : Yes

Identita oddíluThe identity of the partition.


replicaId

Typ : řetězecType : string
Požadováno : AnoRequired : Yes

Identifikátor replikyThe identifier of the replica.


api-version

Typ : řetězecType : string
Požadováno : AnoRequired : Yes
Výchozí : 6.0Default : 6.0

Verze rozhraní API.The version of the API. Tento parametr je povinný a jeho hodnota musí být 6,0.This parameter is required and its value must be '6.0'.

Verze Service Fabric REST API je založena na verzi modulu runtime, ve které bylo rozhraní API zavedeno nebo bylo změněno.Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime podporuje více než jednu verzi rozhraní API.Service Fabric runtime supports more than one version of the API. Toto je nejnovější podporovaná verze rozhraní API.This is the latest supported version of the API. Pokud je předána nižší verze rozhraní API, vrácená odpověď může být jiná než ta popsaná v této specifikaci.If a lower API version is passed, the returned response may be different from the one documented in this specification.

Kromě toho modul runtime akceptuje všechny verze, které jsou vyšší než nejnovější podporovaná verze, až do aktuální verze modulu runtime.Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. Takže pokud je nejnovější verze rozhraní API 6,0, ale pokud je modul runtime 6,1, aby bylo snazší psát klienty, modul runtime bude pro toto rozhraní API akceptovat verzi 6,1.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. Chování rozhraní API ale bude podle zdokumentované verze 6,0.However the behavior of the API will be as per the documented 6.0 version.


EventsHealthStateFilter

Typ : celé čísloType : integer
Požadováno : neRequired : No
Výchozí : 0Default : 0

Umožňuje filtrovat kolekci objektů HealthEvent vrácených na základě stavu.Allows filtering the collection of HealthEvent objects returned based on health state. Možné hodnoty pro tento parametr zahrnují celočíselnou hodnotu jednoho z následujících stavů.The possible values for this parameter include integer value of one of the following health states. Vrátí se pouze události, které odpovídají filtru.Only events that match the filter are returned. Všechny události se používají k vyhodnocení agregovaného stavu.All events are used to evaluate the aggregated health state. Pokud tento parametr nezadáte, vrátí se všechny položky.If not specified, all entries are returned. Hodnoty stavu jsou výčet založený na příznak, takže hodnota by mohla být kombinací těchto hodnot získána pomocí bitového operátoru OR.The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. Pokud je například zadaná hodnota 6, budou vráceny všechny události s hodnotou ' OK (2) a upozornění (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.

  • Výchozí hodnota – výchozí hodnota.Default - Default value. Odpovídá jakémukoli elementu.Matches any HealthState. Hodnota je nula.The value is zero.
  • Žádný – filtr neodpovídá žádné hodnotě elementu.None - Filter that doesn't match any HealthState value. Používá se k tomu, aby se v dané kolekci stavů nevracely žádné výsledky.Used in order to return no results on a given collection of states. Hodnota je 1.The value is 1.
  • OK – filtr, který odpovídá zadanému vstupu s hodnotou elementu ' OK '.Ok - Filter that matches input with HealthState value Ok. Hodnota je 2.The value is 2.
  • Upozornění – filtr, který odpovídá zadanému vstupu s upozorněním na hodnotu podstavuWarning - Filter that matches input with HealthState value Warning. Hodnota je 4.The value is 4.
  • Filtr chyb, který odpovídá zadanému vstupu s chybou hodnoty elementu stavError - Filter that matches input with HealthState value Error. Hodnota je 8.The value is 8.
  • All – filtr, který odpovídá zadanému vstupu s jakoukoli hodnotou elementu.All - Filter that matches input with any HealthState value. Hodnota je 65535.The value is 65535.

timeout

Typ : Integer (Int64)Type : integer (int64)
Požadováno : neRequired : No
Výchozí : 60Default : 60
InclusiveMaximum : 4294967295InclusiveMaximum : 4294967295
InclusiveMinimum : 1InclusiveMinimum : 1

Časový limit serveru pro provedení operace během několika sekund.The server timeout for performing the operation in seconds. Tento časový limit určuje dobu, po kterou bude klient ochotn počkat na dokončení požadované operace.This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. Výchozí hodnota pro tento parametr je 60 sekund.The default value for this parameter is 60 seconds.


ApplicationHealthPolicy

Zadejte : ApplicationHealthPolicyType : ApplicationHealthPolicy
Požadováno : neRequired : No

Popisuje zásady stavu používané k vyhodnocení stavu aplikace nebo jedné z jejích podřízených objektů.Describes the health policies used to evaluate the health of an application or one of its children. Pokud není k dispozici, hodnocení stavu používá zásady stavu z manifestu aplikace nebo výchozí zásady stavu.If not present, the health evaluation uses the health policy from application manifest or the default health policy.

OdpovědiResponses

Stavový kód HTTPHTTP Status Code PopisDescription Schéma odpovědiResponse Schema
200 (OK)200 (OK) Úspěšná operace vrátí stavový kód 200 a požadované informace o stavu repliky.A successful operation will return 200 status code and the requested replica health information.
ReplicaHealthReplicaHealth
Všechny ostatní stavové kódyAll other status codes Podrobná chybová odpověď.The detailed error response.
FabricErrorFabricError