Bagikan melalui

Dapatkan Kesehatan Aplikasi yang Disebarkan

  • Artikel

Mendapatkan informasi tentang kesehatan aplikasi yang disebarkan pada node Service Fabric.

Mendapatkan informasi tentang kesehatan aplikasi yang disebarkan pada node Service Fabric. Gunakan EventsHealthStateFilter guna memfilter secara opsional untuk pengumpulan objek HealthEvent yang dilaporkan pada aplikasi yang disebarkan berdasarkan status kesehatan. Gunakan DeployedServicePackagesHealthStateFilter untuk memfilter secara opsional untuk anak-anak DeployedServicePackageHealth berdasarkan kondisi kesehatan.

Minta

Metode URI Permintaan
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parameter

Nama Jenis Diperlukan Lokasi
nodeName string Ya Jalur
applicationId string Ya Jalur
api-version string Ya Kueri
EventsHealthStateFilter bilangan bulat Tidak Kueri
DeployedServicePackagesHealthStateFilter bilangan bulat Tidak Kueri
ExcludeHealthStatistics boolean Tidak Kueri
timeout bilangan bulat (int64) Tidak Kueri

nodeName

Jenis: string
Diperlukan: Ya

Nama node.

applicationId

Jenis: string
Diperlukan: Ya

Identitas aplikasi. Ini biasanya nama lengkap aplikasi tanpa skema URI 'fabric:'. Mulai dari versi 6.0, nama hierarki dibatasi dengan karakter “~”. Misalnya, jika nama aplikasi adalah "fabric:/myapp/app1", identitas aplikasi akan menjadi "myapp~app1" di versi 6.0+ dan "myapp/app1" di versi sebelumnya.

api-version

Jenis: string
Diperlukan: Ya
Default: 6.0

Versi API. Parameter ini diperlukan dan nilainya harus '6.0'.

Versi SERVICE Fabric REST API didasarkan pada versi runtime tempat API diperkenalkan atau diubah. Runtime Service Fabric mendukung lebih dari satu versi API. Ini adalah versi TERBARU api yang didukung. Jika versi API yang lebih rendah diteruskan, respons yang dikembalikan mungkin berbeda dari yang didokumenkan 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 versi 6.0 yang didokumentasikan.

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.

DeployedServicePackagesHealthStateFilter

Jenis: bilangan bulat
Diperlukan: Tidak
Default: 0

Memungkinkan pemfilteran objek status kesehatan paket layanan yang disebarkan dalam hasil kueri kesehatan aplikasi yang disebarkan berdasarkan status kesehatannya. Kemungkinan nilai untuk parameter ini antara lain nilai bilangan bulat dari salah satu status kesehatan berikut. Hanya paket layanan yang disebarkan yang cocok dengan filter yang dikembalikan. Semua paket layanan yang disebarkan digunakan untuk mengevaluasi status kesehatan agregat dari aplikasi yang diterapkan. 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 paket layanan 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.

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.

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 aplikasi yang disebarkan.
 DeployedApplicationHealth
Semua kode status lainnya Respons kesalahan terperinci.
 FabricError