Bölüm Durumunu Alma
Belirtilen Service Fabric bölümünün sistem durumunu alır.
Hizmette bildirilen sistem durumu olaylarının koleksiyonunu sistem durumuna göre filtrelemek için EventsHealthStateFilter kullanın. Bölümdeki ReplicaHealthState nesnelerinin koleksiyonunu filtrelemek için ReplicasHealthStateFilter kullanın. Sistem durumu deposunda bulunmayan bir bölüm belirtirseniz, bu istek bir hata döndürür.
İstek
| Yöntem | İstek URI'si |
|---|---|
| GET | /Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parametreler
| Ad | Tür | Gerekli | Konum |
|---|---|---|---|
partitionId |
string (uuid) | Yes | Yol |
api-version |
string | Yes | Sorgu |
EventsHealthStateFilter |
tamsayı | No | Sorgu |
ReplicasHealthStateFilter |
tamsayı | No | Sorgu |
ExcludeHealthStatistics |
boolean | No | Sorgu |
timeout |
integer (int64) | No | Sorgu |
partitionId
Tür: dize (uuid)
Gerekli: Evet
Bölümün kimliği.
api-version
Tür: dize
Gerekli: Evet
Varsayılan: 6.0
API'nin sürümü. Bu parametre gereklidir ve değeri '6.0' olmalıdır.
Service Fabric REST API sürümü, API'nin tanıtıldığı veya değiştirildiği çalışma zamanı sürümünü temel alır. Service Fabric çalışma zamanı API'nin birden fazla sürümünü destekler. Bu, API'nin desteklenen en son sürümüdür. Daha düşük bir API sürümü geçirilirse, döndürülen yanıt bu belirtimde belgelenen yanıttan farklı olabilir.
Ayrıca çalışma zamanı, çalışma zamanının geçerli sürümüne kadar desteklenen en son sürümden daha yüksek olan tüm sürümleri kabul edin. Bu nedenle, en son API sürümü 6.0 ise ancak çalışma zamanı 6.1 ise, istemcileri yazmayı kolaylaştırmak için çalışma zamanı bu API için sürüm 6.1'i kabul eder. Ancak API'nin davranışı, belgelenen 6.0 sürümüne göre olacaktır.
EventsHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Sistem durumu temelinde döndürülen HealthEvent nesnelerinin koleksiyonunun filtrelenmesine izin verir.
Bu parametrenin olası değerleri aşağıdaki sistem durumu durumlarından birinin tamsayı değerini içerir.
Yalnızca filtreyle eşleşen olaylar döndürülür. Toplanan sistem durumunu değerlendirmek için tüm olaylar kullanılır.
Belirtilmezse, tüm girdiler döndürülür. Durum değerleri bayrak tabanlı sabit listesidir, bu nedenle değer bit düzeyinde 'OR' işleci kullanılarak elde edilen bu değerlerin bir birleşimi olabilir. Örneğin, sağlanan değer 6 ise, HealthState değeri Ok (2) ve Warning (4) olan tüm olaylar döndürülür.
- Varsayılan - Varsayılan değer. Herhangi bir HealthState ile eşleşir. Değer sıfırdır.
- Hiçbiri - Herhangi bir HealthState değeriyle eşleşmeyen filtre. Belirli bir durum koleksiyonunda sonuç döndürmemek için kullanılır. Değer 1'dir.
- Tamam - HealthState değeri Ok olan girişle eşleşen filtre. Değer 2'dir.
- Uyarı - HealthState değeri Warning ile girişle eşleşen filtre. Değer 4'dür.
- Error - HealthState değeriyle girişle eşleşen filtre Error. Değer 8'dir.
- Tümü - Herhangi bir HealthState değeriyle girişle eşleşen filtre. Değer 65535'tir.
ReplicasHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Bölümdeki ReplicaHealthState nesnelerinin koleksiyonunu filtrelemeye izin verir. Değer, HealthStateFilter üyelerindeki üyelerden veya bit tabanlı işlemlerden alınabilir. Yalnızca filtreyle eşleşen çoğaltmalar döndürülür. Toplanan sistem durumunu değerlendirmek için tüm çoğaltmalar kullanılır. Belirtilmezse, tüm girişler döndürülür. Durum değerleri bayrak tabanlı sabit listesidir, bu nedenle değer bit tabanlı 'OR' işleci kullanılarak elde edilen bu değerlerin bir birleşimi olabilir. Örneğin, sağlanan değer 6 ise, HealthState değeri Ok (2) ve Warning (4) olan tüm olaylar döndürülür. Bu parametrenin olası değerleri aşağıdaki sistem durumu durumlarından birinin tamsayı değerini içerir.
- Varsayılan - Varsayılan değer. Herhangi bir HealthState ile eşleşir. Değer sıfırdır.
- Hiçbiri - Herhangi bir HealthState değeriyle eşleşmeyen filtre. Belirli bir durum koleksiyonunda sonuç döndürmemek için kullanılır. Değer 1'dir.
- Tamam - HealthState değeri Ok olan girişle eşleşen filtre. Değer 2'dir.
- Uyarı - HealthState değeri Warning ile girişle eşleşen filtre. Değer 4'dür.
- Error - HealthState değeriyle girişle eşleşen filtre Error. Değer 8'dir.
- Tümü - Herhangi bir HealthState değeriyle girişle eşleşen filtre. Değer 65535'tir.
ExcludeHealthStatistics
Tür: boole
Gerekli: Hayır
Varsayılan: false
Sistem durumu istatistiklerinin sorgu sonucunun bir parçası olarak döndürülmesi gerekip gerekmediğini gösterir. Varsayılan olarak false.
İstatistikler, sistem durumu Tamam, Uyarı ve Hata'daki alt varlıkların sayısını gösterir.
timeout
Tür: tamsayı (int64)
Gerekli: Hayır
Varsayılan: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
İşlemi saniyeler içinde gerçekleştirmek için sunucu zaman aşımı. Bu zaman aşımı, istemcinin istenen işlemin tamamlanmasını beklemeye istekli olduğu süreyi belirtir. Bu parametre için varsayılan değer 60 saniyedir.
Yanıtlar
| HTTP Durum Kodu | Description | Yanıt Şeması |
|---|---|---|
| 200 (Tamam) | Başarılı bir işlem 200 durum kodunu ve belirtilen bölümle ilgili sistem durumu bilgilerini döndürür. |
PartitionHealth |
| Diğer tüm durum kodları | Ayrıntılı hata yanıtı. |
Doku Oluşturucu |