Replika állapotának beolvasása házirend alapjánGet Replica Health Using Policy

Beolvas egy Service Fabric állapot-nyilvántartó szolgáltatás replikájának vagy állapot nélküli szolgáltatási példányának állapotát a megadott házirenddel.Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.

Beolvas egy Service Fabric állapot-nyilvántartó szolgáltatás replikájának vagy állapot nélküli szolgáltatási példányának állapotát.Gets the health of a Service Fabric stateful service replica or stateless service instance. A EventsHealthStateFilter használatával szűrheti a fürtön az állapot alapján jelentett állapotú események gyűjteményét.Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. A ApplicationHealthPolicy használatával felülbírálhatja az állapot kiértékeléséhez használt állapotfigyelő házirendeket.Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. Ez az API csak a ApplicationHealthPolicy "ConsiderWarningAsError" mezőjét használja.This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. A rendszer figyelmen kívül hagyja a többi mezőt a replika állapotának kiértékelése során.The rest of the fields are ignored while evaluating the health of the replica.

KérésRequest

MódszerMethod Kérés URI-jaRequest URI
POSTPOST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

ParaméterekParameters

Name (Név)Name TípusType KötelezőRequired HelyLocation
partitionId karakterlánc (UUID)string (uuid) IgenYes ÚtvonalPath
replicaId sztringstring IgenYes ÚtvonalPath
api-version sztringstring IgenYes LekérdezésQuery
EventsHealthStateFilter egész száminteger NemNo LekérdezésQuery
timeout egész szám (Int64)integer (int64) NemNo LekérdezésQuery
ApplicationHealthPolicy ApplicationHealthPolicyApplicationHealthPolicy NemNo TörzsBody

partitionId

Típus: karakterlánc (UUID)Type: string (uuid)
Kötelező: igenRequired: Yes

A partíció identitása.The identity of the partition.


replicaId

Típus: karakterláncType: string
Kötelező: igenRequired: Yes

A replika azonosítója.The identifier of the replica.


api-version

Típus: karakterláncType: string
Kötelező: igenRequired: Yes
Alapértelmezett:6.0Default: 6.0

Az API verziója.The version of the API. Ezt a paramétert kötelező megadni, és az értéke csak "6,0" lehet.This parameter is required and its value must be '6.0'.

A Service Fabric REST API verziója azon futtatókörnyezet-verzión alapul, amelyben az API-t bevezették vagy módosították.Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric futtatókörnyezet az API több verzióját is támogatja.Service Fabric runtime supports more than one version of the API. Ez az API legújabb támogatott verziója.This is the latest supported version of the API. Ha a rendszer alacsonyabb API-verziót ad át, a visszaadott válasz különbözhet az ebben a specifikációban dokumentált értéktől.If a lower API version is passed, the returned response may be different from the one documented in this specification.

Emellett a futtatókörnyezet minden olyan verziót elfogad, amely a legújabb támogatott verziónál magasabb, mint a futtatókörnyezet aktuális verziója.Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. Tehát ha a legújabb API-verzió a 6,0-as, de ha a futtatókörnyezet 6,1, az ügyfelek írásához a futtatókörnyezet az adott API-hoz tartozó 6,1-as verziót fogja elfogadni.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. Az API viselkedése azonban a dokumentált 6,0-es verziónak megfelelően fog történni.However the behavior of the API will be as per the documented 6.0 version.


EventsHealthStateFilter

Típus: egész számType: integer
Kötelező: nemRequired: No
Alapértelmezett:0Default: 0

Engedélyezi az állapot alapján visszaadott HealthEvent-objektumok gyűjteményének szűrését.Allows filtering the collection of HealthEvent objects returned based on health state. A paraméter lehetséges értékei a következő állapotok egyikének egészét tartalmazzák.The possible values for this parameter include integer value of one of the following health states. Csak a szűrőnek megfelelő események lesznek visszaadva.Only events that match the filter are returned. A rendszer minden eseményt felhasznál az összesített állapot kiértékelésére.All events are used to evaluate the aggregated health state. Ha nincs megadva, a rendszer az összes bejegyzést visszaadja.If not specified, all entries are returned. Az állapotok a jelző-alapú enumerálások, így az érték a bitenkénti "vagy" operátor használatával kapott értékek kombinációja lehet.The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. Ha például a megadott érték 6, akkor a rendszer az összes, az OK (2) és a figyelmeztetés (4) HealthState értékű eseményt adja vissza.For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.

  • Alapértelmezett – alapértelmezett érték.Default - Default value. Megfelel bármely HealthState.Matches any HealthState. Az érték nulla.The value is zero.
  • Nincs – olyan szűrő, amely nem felel meg egyetlen HealthState értéknek sem.None - Filter that doesn't match any HealthState value. Az adott állapotok egy adott gyűjteményében nem lehet eredményt visszaadni.Used in order to return no results on a given collection of states. Az érték 1.The value is 1.
  • Ok – a HealthState értékkel egyező bemenettel rendelkező szűrő.Ok - Filter that matches input with HealthState value Ok. Az érték 2.The value is 2.
  • Figyelmeztetés – a HealthState értékkel rendelkező bemenettel egyező szűrő.Warning - Filter that matches input with HealthState value Warning. Az érték 4.The value is 4.
  • Hiba – a HealthState értékű bemenettel egyező szűrő.Error - Filter that matches input with HealthState value Error. Az érték 8.The value is 8.
  • Minden olyan szűrő, amely megfelel bármely HealthState értéknek.All - Filter that matches input with any HealthState value. Az érték 65535.The value is 65535.

timeout

Típus: egész szám (Int64)Type: integer (int64)
Kötelező: nemRequired: No
Alapértelmezett:60Default: 60
InclusiveMaximum:4294967295InclusiveMaximum: 4294967295
InclusiveMinimum:1InclusiveMinimum: 1

A kiszolgáló időtúllépése másodpercben a művelet végrehajtására.The server timeout for performing the operation in seconds. Ez az időkorlát azt az időtartamot adja meg, ameddig az ügyfélnek várnia kell, amíg a kért művelet befejeződik.This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. A paraméter alapértelmezett értéke 60 másodperc.The default value for this parameter is 60 seconds.


ApplicationHealthPolicy

Típus: ApplicationHealthPolicyType: ApplicationHealthPolicy
Kötelező: nemRequired: No

Az alkalmazások vagy az egyik gyermekeik állapotának kiértékeléséhez használt állapotfigyelő házirendeket ismerteti.Describes the health policies used to evaluate the health of an application or one of its children. Ha nem jelennek meg, az állapot kiértékelése az alkalmazás jegyzékfájljának vagy az alapértelmezett állapotházirend állapotát használja.If not present, the health evaluation uses the health policy from application manifest or the default health policy.

VálaszokResponses

HTTP-állapotkódHTTP Status Code LeírásDescription VálaszsémaResponse Schema
200 (OK)200 (OK) A sikeres művelet a 200 állapotkódot és a kért replika állapotra vonatkozó információkat fogja visszaadni.A successful operation will return 200 status code and the requested replica health information.
ReplicaHealthReplicaHealth
Minden egyéb állapotkódAll other status codes A hiba részletes válasza.The detailed error response.
FabricErrorFabricError