Uygulama Durumunu Alma
Service Fabric uygulamasının sistem durumunu alır.
Service Fabric uygulamasının ısı durumunu döndürür. Yanıt Tamam, Hata veya Uyarı sistem durumunu bildirir. Varlık sistem durumu deposunda bulunmazsa Hata döndürür.
İstek
| Yöntem | İstek URI'si |
|---|---|
| GET | /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parametreler
| Ad | Tür | Gerekli | Konum |
|---|---|---|---|
applicationId |
string | Yes | Yol |
api-version |
string | Yes | Sorgu |
EventsHealthStateFilter |
tamsayı | No | Sorgu |
DeployedApplicationsHealthStateFilter |
tamsayı | No | Sorgu |
ServicesHealthStateFilter |
tamsayı | No | Sorgu |
ExcludeHealthStatistics |
boolean | No | Sorgu |
timeout |
integer (int64) | No | Sorgu |
applicationId
Tür: dize
Gerekli: Evet
Uygulamanın kimliği. Bu genellikle 'fabric:' URI şeması olmayan uygulamanın tam adıdır.
Sürüm 6.0'dan başlayarak, hiyerarşik adlar "~" karakteriyle sınırlandırılır.
Örneğin, uygulama adı "fabric:/myapp/app1" ise, uygulama kimliği 6.0+ sürümünde "myapp~app1" ve önceki sürümlerde "myapp/app1" olacaktır.
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.
DeployedApplicationsHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Uygulama durumu sorgusunun sonucunda döndürülen dağıtılan uygulamaların sistem durumu nesnelerinin sistem durumu 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 dağıtılan uygulamalar döndürülür.
Dağıtılan tüm uygulamalar toplu sistem durumunu değerlendirmek için kullanılır. Belirtilmezse, tüm girdiler 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 Ok (2) ve Warning (4) olan dağıtılan 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 - 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.
ServicesHealthStateFilter
Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0
Hizmetlerin sistem durumu sorgusu sonucunda döndürülen hizmetlerin 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 hizmetler döndürülür. Tüm hizmetler toplu sistem durumunu değerlendirmek için kullanılır.
Belirtilmezse, tüm girdiler 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 Ok (2) ve Warning (4) olan hizmetlerin 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 - 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 kodu ve istenen uygulama sistem durumu bilgilerini döndürür. |
ApplicationHealth |
| Diğer tüm durum kodları | Ayrıntılı hata yanıtı. |
Doku Oluşturucu |