Dapatkan Info Aplikasi yang Disebarkan
Mendapatkan informasi tentang aplikasi yang disebarkan pada node Service Fabric.
Kueri ini mengembalikan informasi aplikasi sistem jika ID aplikasi yang disediakan adalah untuk aplikasi sistem. Hasil mencakup aplikasi yang disebarkan dalam status aktif, mengaktifkan, dan mengunduh. Kueri ini mengharuskan nama node sesuai dengan node pada kluster. Kueri gagal jika nama node yang disediakan tidak menunjuk ke node Service Fabric aktif pada kluster.
Minta
Metode | URI Permintaan |
---|---|
GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState} |
Parameter
Nama | Jenis | Diperlukan | Lokasi |
---|---|---|---|
nodeName |
string | Ya | Jalur |
applicationId |
string | Ya | Jalur |
api-version |
string | Ya | Kueri |
timeout |
bilangan bulat (int64) | Tidak | Kueri |
IncludeHealthState |
boolean | 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.1
Versi API. Parameter ini diperlukan dan nilainya harus '6.1'.
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.
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.
IncludeHealthState
Jenis: boolean
Diperlukan: Tidak
Default: false
Menyertakan status kesehatan entitas.
Jika parameter ini false atau tidak ditentukan, maka status kesehatan yang dikembalikan adalah "Tidak Diketahui".
Ketika diatur ke true, kueri berjalan sejajar dengan node dan layanan sistem kesehatan sebelum hasilnya digabungkan.
Akibatnya, kueri lebih mahal dan mungkin membutuhkan waktu lebih lama.
Respons
Kode Status HTTP | Deskripsi | Skema Respons |
---|---|---|
200 (OK) | Operasi yang berhasil akan mengembalikan 200 kode status dan informasi tentang aplikasi yang disebarkan. |
DeployedApplicationInfo |
204 (NoContent) | Respons kosong dikembalikan jika aplikasi yang ditentukan tidak disebarkan pada simpul. |
|
Semua kode status lainnya | Respons kesalahan terperinci. |
FabricError |
Contoh
Dapatkan aplikasi tertentu yang disebarkan dengan ID aplikasi dan sertakan status kesehatan dalam hasilnya
Contoh ini menunjukkan cara mendapatkan informasi tentang aplikasi yang disebarkan pada simpul tertentu dengan menggunakan pengidentifikasi aplikasi. Jika aplikasi ditemukan, informasi tersebut dikembalikan dengan kode status 200. Respons kosong dengan kode status 204 dikembalikan, jika aplikasi yang ditentukan tidak disebarkan pada simpul.
Minta
GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True
Respons 200
Isi
{
"Id": "samples~CalculatorApp",
"Name": "fabric:/samples/CalculatorApp",
"TypeName": "CalculatorApp",
"TypeVersion": "1.0.0",
"Status": "Active",
"WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
"LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
"TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
"HealthState": "Ok"
}
Respons 204
Isi
Isi respons kosong.