Küme Durumunu Alma
Service Fabric kümesinin durumunu alır.
Kümede bildirilen sistem durumu olaylarının koleksiyonunu sistem durumu temelinde filtrelemek için EventsHealthStateFilter kullanın. Benzer şekilde, DüğümlerHealthStateFilter ve ApplicationsHealthStateFilter kullanarak toplanan sistem durumuna göre döndürülen düğüm ve uygulama koleksiyonunu filtreleyin.
İstek
| Yöntem | İstek URI'si |
|---|---|
| GET | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parametreler
| Ad | Tür | Gerekli | Konum |
|---|---|---|---|
api-version |
string | Yes | Sorgu |
NodesHealthStateFilter |
tamsayı | No | Sorgu |
ApplicationsHealthStateFilter |
tamsayı | No | Sorgu |
EventsHealthStateFilter |
tamsayı | No | Sorgu |
ExcludeHealthStatistics |
boolean | No | Sorgu |
IncludeSystemApplicationHealthStatistics |
boolean | No | Sorgu |
timeout |
integer (int64) | No | Sorgu |
api-version
Tür: dize
Gerekli: Evet
Varsayılan: 6.0
API 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 belgelenenden farklı olabilir.
Buna ek olarak ç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 ediyor. 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.
NodesHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Küme sistem durumu sorgusu sonucunda döndürülen düğüm sistem durumu nesnelerinin sistem durumuna göre 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 düğümler döndürülür. Tüm düğümler toplanmış sistem durumunu değerlendirmek için kullanılır.
Belirtilmezse, tüm girişler döndürülür.
Durum değerleri bayrak tabanlı numaralandırmadır, bu nedenle değer bit tabanlı 'OR' işleci kullanılarak elde edilen bu değerlerin bir bileşimi olabilir.
Örneğin, sağlanan değer 6 ise, HealthState değeri Tamam (2) ve Uyarı (4) olan düğümlerin sistem durumu 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 - Girişle eşleşen filtreyi HealthState değeri Tamam ile eşleştirin. Değer 2'dir.
- Uyarı - Giriş ile HealthState değeri Uyarı ile eşleşen filtre. Değer 4'dür.
- Hata - Giriş ile HealthState değeriYle 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.
ApplicationsHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Küme durumu sorgusunun sonucunda döndürülen uygulama durumu nesnelerinin sistem durumu durumuna göre filtrelenmesine izin verir.
Bu parametrenin olası değerleri, HealthStateFilter sabit listesi üyelerinde üyelerden alınan tamsayı değerini veya bit tabanlı işlemleri içerir. Yalnızca filtreyle eşleşen uygulamalar döndürülür.
Tüm uygulamalar toplanmış sistem durumunu değerlendirmek için kullanılır. Belirtilmezse, tüm girişler döndürülür.
Durum değerleri bayrak tabanlı numaralandırmadır, bu nedenle değer bit tabanlı 'OR' işleci kullanılarak elde edilen bu değerlerin bir bileşimi olabilir.
Örneğin, sağlanan değer 6 ise, HealthState değeri Tamam (2) ve Uyarı (4) olan uygulamaların sistem durumu 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 - Girişle eşleşen filtreyi HealthState değeri Tamam ile eşleştirin. Değer 2'dir.
- Uyarı - Giriş ile HealthState değeri Uyarı ile eşleşen filtre. Değer 4'dür.
- Hata - Giriş ile HealthState değeriYle 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.
EventsHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Sistem durumu temelinde döndürülen HealthEvent nesnelerinin koleksiyonunu filtrelemeye 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.
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.
IncludeSystemApplicationHealthStatistics
Tür: boole
Gerekli: Hayır
Varsayılan: false
Sistem durumu istatistiklerinin dokuyu içermesi gerekip gerekmediğini gösterir:/Sistem uygulaması sistem durumu istatistikleri. Varsayılan olarak false.
IncludeSystemApplicationHealthStatistics true olarak ayarlanırsa, sistem durumu istatistikleri fabric:/System uygulamasına ait varlıkları içerir.
Aksi takdirde, sorgu sonucu yalnızca kullanıcı uygulamaları için sistem durumu istatistiklerini içerir.
Bu parametrenin uygulanması için sorgu sonucuna sistem durumu istatistikleri eklenmelidir.
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 kodu ve istenen küme sistem durumu bilgilerini döndürür. |
ClusterHealth |
| Diğer tüm durum kodları | Ayrıntılı hata yanıtı. |
Doku Oluşturucu |