Dapatkan Kesehatan Kluster
Mendapatkan kesehatan dari kluster Service Fabric.
Gunakan EventsHealthStateFilter untuk memfilter pengumpulan peristiwa kesehatan yang dilaporkan pada kluster berdasarkan keadaan kesehatan. Selain itu, gunakan NodesHealthStateFilter dan ApplicationsHealthStateFilter untuk memfilter pengumpulan node dan aplikasi yang dikembalikan berdasarkan kondisi kesehatan agregatnya.
Minta
| Metode | URI Permintaan |
|---|---|
| GET | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parameter
| Nama | Jenis | Diperlukan | Lokasi |
|---|---|---|---|
api-version |
string | Ya | Kueri |
NodesHealthStateFilter |
bilangan bulat | Tidak | Kueri |
ApplicationsHealthStateFilter |
bilangan bulat | Tidak | Kueri |
EventsHealthStateFilter |
bilangan bulat | Tidak | Kueri |
ExcludeHealthStatistics |
boolean | Tidak | Kueri |
IncludeSystemApplicationHealthStatistics |
boolean | Tidak | Kueri |
timeout |
bilangan bulat (int64) | Tidak | Kueri |
api-version
Jenis: string
Diperlukan: Ya
Default: 6.0
Versi API. Parameter ini diperlukan dan nilainya harus '6.0'.
Versi REST API Service Fabric didasarkan pada versi runtime tempat API diperkenalkan atau diubah. Runtime Service Fabric mendukung lebih dari satu versi API. Ini adalah versi API terbaru yang didukung. Jika versi API yang lebih rendah diteruskan, respons yang dikembalikan mungkin berbeda dari yang di dokumentasikan dalam spesifikasi ini.
Selain itu runtime menerima versi apa pun yang lebih tinggi dari versi terbaru yang didukung hingga versi runtime saat ini. Jadi, jika versi API terbaru adalah 6.0, tetapi jika runtime adalah 6.1, untuk mempermudah penulisan klien, runtime akan menerima versi 6.1 untuk API tersebut. Namun perilaku API akan sesuai dengan versi 6.0 yang di dokumentasikan.
NodesHealthStateFilter
Jenis: bilangan bulat
Diperlukan: Tidak
Default: 0
Memungkinkan pemfilteran objek status kesehatan node yang dikembalikan dalam hasil kueri kesehatan layanan berdasarkan status kesehatannya. Kemungkinan nilai untuk parameter ini antara lain nilai bilangan bulat dari salah satu status kesehatan berikut. Hanya node yang cocok dengan filter yang dikembalikan. Semua node digunakan untuk mengevaluasi status kesehatan agregat.
Jika tidak ditentukan, semua entri akan dikembalikan.
Nilai status adalah enumerasi berbasis bendera, sehingga nilainya bisa berupa kombinasi dari nilai-nilai ini, yang diperoleh menggunakan operator 'OR' bitwise.
Misalnya, jika nilai yang diberikan adalah 6, maka status kesehatan node dengan nilai HealthState OK (2) dan Warning (4) akan dikembalikan.
- Default - Nilai default. Mencocokkan dengan HealthState. Nilainya berbasis nol.
- None - Filter yang tidak cocok dengan nilai HealthState apa pun. Digunakan untuk mengembalikan tanpa hasil pada koleksi status tertentu. Nilainya adalah 1.
- Ok - Filter yang cocok dengan input dengan nilai HealthState Ok. Nilainya adalah 2.
- Peringatan - Filter yang cocok dengan input dengan peringatan nilai HealthState. Nilainya adalah 4.
- Kesalahan - Filter yang cocok dengan input dengan nilai HealthState Kesalahan. Nilainya adalah 8.
- Semua - Filter yang cocok dengan input dengan nilai HealthState apa pun. Nilainya adalah 65535.
ApplicationsHealthStateFilter
Jenis: bilangan bulat
Diperlukan: Tidak
Default: 0
Memungkinkan pemfilteran objek status kesehatan aplikasi yang dikembalikan dalam hasil kueri kesehatan kluster berdasarkan status kesehatannya.
Kemungkinan nilai untuk parameter ini antara lain nilai bilangan bulat yang diperoleh dari anggota atau operasi bitwise pada anggota enumerasi HealthStateFilter. Hanya partisi yang cocok dengan filter yang dikembalikan.
Semua aplikasi digunakan untuk mengevaluasi status kesehatan agregat. Jika tidak ditentukan, semua entri akan dikembalikan.
Nilai status adalah enumerasi berbasis bendera, sehingga nilainya bisa berupa kombinasi dari nilai-nilai ini, yang diperoleh menggunakan operator 'OR' bitwise.
Misalnya, jika nilai yang diberikan adalah 6, maka status kesehatan aplikasi dengan nilai HealthState OK (2) dan Warning (4) akan dikembalikan.
- Default - Nilai default. Mencocokkan dengan HealthState. Nilainya berbasis nol.
- None - Filter yang tidak cocok dengan nilai HealthState apa pun. Digunakan untuk mengembalikan tanpa hasil pada koleksi status tertentu. Nilainya adalah 1.
- Ok - Filter yang cocok dengan input dengan nilai HealthState Ok. Nilainya adalah 2.
- Peringatan - Filter yang cocok dengan input dengan peringatan nilai HealthState. Nilainya adalah 4.
- Kesalahan - Filter yang cocok dengan input dengan nilai HealthState Kesalahan. Nilainya adalah 8.
- Semua - Filter yang cocok dengan input dengan nilai HealthState apa pun. Nilainya adalah 65535.
EventsHealthStateFilter
Jenis: bilangan bulat
Diperlukan: Tidak
Default: 0
Memungkinkan pemfilteran koleksi objek HealthEvent yang dikembalikan berdasarkan status kesehatan.
Nilai yang mungkin untuk parameter ini termasuk nilai bilangan bulat dari salah satu status kesehatan berikut.
Hanya peristiwa yang cocok dengan filter yang dikembalikan. Semua peristiwa digunakan untuk mengevaluasi status kesehatan agregat.
Jika tidak ditentukan, semua entri akan dikembalikan. Nilai status adalah enumerasi berbasis bendera, sehingga nilainya bisa berupa kombinasi dari nilai-nilai ini, yang diperoleh menggunakan operator 'OR' bitwise. Misalnya, Jika nilai yang diberikan adalah 6, maka semua peristiwa dengan nilai HealthState OK (2) dan Warning (4) dikembalikan.
- Default - Nilai default. Mencocokkan dengan HealthState. Nilainya berbasis nol.
- None - Filter yang tidak cocok dengan nilai HealthState apa pun. Digunakan untuk mengembalikan tanpa hasil pada koleksi status tertentu. Nilainya adalah 1.
- Ok - Filter yang cocok dengan input dengan nilai HealthState Ok. Nilainya adalah 2.
- Peringatan - Filter yang cocok dengan input dengan nilai HealthState Peringatan. Nilainya adalah 4.
- Kesalahan - Filter yang cocok dengan input dengan nilai HealthState Kesalahan. Nilainya adalah 8.
- Semua - Filter yang cocok dengan input dengan nilai HealthState apa pun. Nilainya adalah 65535.
ExcludeHealthStatistics
Jenis: boolean
Diperlukan: Tidak
Default: false
Menunjukkan apakah statistik kesehatan harus dikembalikan sebagai bagian dari hasil kueri. Salah secara default.
Statistik menunjukkan jumlah entitas anak dalam keadaan kesehatan Ok, Warning, dan Error.
IncludeSystemApplicationHealthStatistics
Jenis: boolean
Diperlukan: Tidak
Default: false
Menunjukkan apakah statistik kesehatan harus mencakup statistik kesehatan statistik kesehatan fabric:/Aplikasi sistem. Salah secara default.
Jika IncludeSystemApplicationHealthStatistics diatur ke true, statistik kesehatan mencakup entitas yang termasuk dalam fabric:/Aplikasi sistem.
Jika tidak, hasil kueri hanya mencakup statistik kesehatan untuk aplikasi pengguna.
Statistik kesehatan harus disertakan dalam hasil kueri agar parameter ini diterapkan.
timeout
Jenis: bilangan bulat (int64)
Diperlukan: Tidak
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Batas waktu server untuk melakukan operasi dalam hitungan detik. Batas waktu ini menentukan durasi waktu klien bersedia menunggu operasi yang diminta selesai. Nilai default untuk parameter ini adalah 60 detik.
Respons
| Kode Status HTTP | Deskripsi | Skema Respons |
|---|---|---|
| 200 (OK) | Operasi yang berhasil akan mengembalikan 200 kode status dan informasi kesehatan kluster yang diminta. |
ClusterHealth |
| Semua kode status lainnya | Respons kesalahan terperinci. |
FabricError |