Bagikan melalui

Dapatkan Daftar Info Aplikasi yang Disebarkan

  • Artikel

Mendapatkan daftar aplikasi yang disebarkan pada node Service Fabric.

Mendapatkan daftar aplikasi yang disebarkan pada node Service Fabric. Hasilnya tidak mencakup informasi tentang aplikasi sistem yang diterapkan, kecuali secara eksplisit dikueri oleh ID. 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?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parameter

Nama Jenis Diperlukan Lokasi
nodeName string Ya Jalur
api-version string Ya Kueri
timeout bilangan bulat (int64) Tidak Kueri
IncludeHealthState boolean Tidak Kueri
ContinuationToken string Tidak Kueri
MaxResults bilangan bulat (int64) Tidak Kueri

nodeName

Jenis: string
Diperlukan: Ya

Nama node.

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.

ContinuationToken

Jenis: string
Diperlukan: Tidak

Parameter token kelanjutan digunakan untuk mendapatkan serangkaian hasil berikutnya. Token kelanjutan dengan nilai tidak kosong disertakan dalam respons API ketika hasil dari sistem tidak sesuai dalam respons tunggal. Ketika nilai ini diteruskan ke panggilan API berikutnya, API mengembalikan serangkaian hasil berikutnya. Jika tidak ada hasil lebih lanjut, maka token kelanjutan tidak berisi nilai. Nilai parameter ini tidak boleh dikodekan URL.

MaxResults

Jenis: bilangan bulat (int64)
Diperlukan: Tidak
Default: 0
InclusiveMinimum: 0

Jumlah maksimum hasil yang akan dikembalikan sebagai bagian dari kueri halaman. Parameter ini menentukan batas atas pada jumlah hasil yang dikembalikan. Hasil yang dikembalikan dapat kurang dari hasil maksimum yang ditentukan jika tidak cocok dalam pesan berdasarkan pembatasan ukuran pesan maksimum yang ditentukan dalam konfigurasi. Jika parameter ini nol atau tidak ditentukan, kueri halaman mencakup hasil sebanyak mungkin yang cocok dalam pesan kembali.

Respons

Kode Status HTTP Deskripsi Skema Respons
200 (OK) Operasi yang berhasil akan mengembalikan 200 kode status dan daftar informasi aplikasi yang disebarkan.
 PagedDeployedApplicationInfoList
Semua kode status lainnya Respons kesalahan terperinci.
 FabricError

Contoh

Batasi hasil maksimum

Contoh ini menunjukkan cara menentukan jumlah aplikasi yang dikembalikan oleh kueri saat mendapatkan informasi tentang aplikasi yang disebarkan pada simpul tertentu. Jumlah hasil dalam halaman dibatasi hingga maksimum 2 menggunakan parameter MaxResult. Status kesehatan tidak diminta dalam contoh ini, sehingga status kesehatan yang dikembalikan akan Tidak Diketahui.

Minta

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

Respons 200

Isi
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Halaman menggunakan token kelanjutan

Contoh ini menunjukkan fungsionalitas penomoran yang tersedia saat mendapatkan informasi tentang aplikasi yang disebarkan pada simpul tertentu. Contoh ini menggunakan parameter ContinuationToken. Nilai parameter ini disediakan dari kueri sebelumnya; dalam hal ini contoh yang ditunjukkan di atas. Respons berisi hasil yang tersisa dan ContinuationToken kosong. ContinuationToken kosong menunjukkan bahwa hasil tambahan tidak tersedia.

Minta

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

Respons 200

Isi
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Sertakan status kesehatan dalam hasil

Contoh ini menunjukkan cara menyertakan status kesehatan setiap aplikasi yang disebarkan saat mendapatkan informasi tentang aplikasi yang disebarkan pada simpul tertentu.

Minta

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&IncludeHealthState=True

Respons 200

Isi
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}