Bagikan melalui

Dapatkan Daftar Info Aplikasi

  • Artikel

Mendapatkan daftar aplikasi yang dibuat di kluster Service Fabric yang cocok dengan filter yang telah ditentukan.

Mendapatkan informasi tentang aplikasi yang dibuat atau dalam proses dibuat di kluster Service Fabric dan mencocokkan filter yang ditentukan. Respons mencakup nama, jenis, status, parameter, dan detail lainnya tentang aplikasi. Jika aplikasi tidak cocok dalam halaman, satu halaman hasil dikembalikan serta token kelanjutan, yang dapat digunakan untuk mendapatkan halaman berikutnya. Filter ApplicationTypeName dan ApplicationDefinitionKindFilter tidak dapat ditentukan secara bersamaan.

Minta

Metode URI Permintaan
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

Nama Jenis Diperlukan Lokasi
api-version string Ya Kueri
ApplicationDefinitionKindFilter bilangan bulat Tidak Kueri
ApplicationTypeName string Tidak Kueri
ExcludeApplicationParameters boolean Tidak Kueri
ContinuationToken string Tidak Kueri
MaxResults bilangan bulat (int64) Tidak Kueri
timeout bilangan bulat (int64) Tidak Kueri

api-version

Jenis: string
Diperlukan: Ya
Default: 6.1

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

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.

ApplicationDefinitionKindFilter

Jenis: bilangan bulat
Diperlukan: Tidak
Default: 0

Digunakan untuk memfilter pada ApplicationDefinitionKind, yang merupakan mekanisme yang digunakan untuk mendefinisikan aplikasi Service Fabric.

  • Default - Nilai default, yang melakukan fungsi yang sama dengan memilih "Semua". Nilainya adalah 0.
  • Semua - Filter yang cocok dengan input dengan nilai ApplicationDefinitionKind apa pun. Nilainya adalah 65535.
  • ServiceFabricApplicationDescription - Filter yang cocok dengan input dengan ApplicationDefinitionKind value ServiceFabricApplicationDescription. Nilainya adalah 1.
  • Compose - Filter yang cocok dengan input dengan ApplicationDefinitionKind value Compose. Nilainya adalah 2.

ApplicationTypeName

Jenis: string
Diperlukan: Tidak

Nama jenis aplikasi yang digunakan untuk memfilter aplikasi yang akan dikueri. Nilai ini tidak akan berisi versi tipe aplikasi.

ExcludeApplicationParameters

Jenis: boolean
Diperlukan: Tidak
Default: false

Bendera yang menentukan apakah parameter aplikasi akan dikecualikan dari hasilnya.

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.

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) Daftar aplikasi yang dibuat dalam kluster.
 PagedApplicationInfoList
Semua kode status lainnya Respons kesalahan terperinci.
 FabricError

Contoh

Batasi hasil maksimum

Contoh ini menunjukkan cara mendapatkan informasi tentang aplikasi pada kluster. Jumlah hasil dalam halaman dibatasi hingga maksimum dua menggunakan parameter MaxResult.

Minta

GET http://localhost:19080/Applications?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",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Halaman menggunakan token kelanjutan

Contoh ini menunjukkan cara halaman melalui informasi tentang aplikasi pada kluster menggunakan parameter ContinuationToken. Nilai parameter ini disediakan dari kueri sebelumnya, dalam hal ini contoh yang ditunjukkan di atas. Respons berisi satu hasil yang tersisa dan ContinuationToken kosong. ContinuationToken kosong menunjukkan bahwa hasil tambahan tidak tersedia.

Minta

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Respons 200

Isi
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}