Bagikan melalui

Dapatkan Daftar Info Jenis Aplikasi Menurut Nama

  • Artikel

Mendapatkan daftar jenis aplikasi di kluster Service Fabric yang sama persis dengan nama yang telah ditentukan.

Mengembalikan informasi tentang tipe aplikasi yang disediakan atau dalam proses penyediaan di kluster Service Fabric. Hasil ini adalah jenis aplikasi yang namanya cocok persis dengan yang ditentukan sebagai parameter, dan yang sesuai dengan parameter kueri yang diberikan. Semua versi jenis aplikasi yang cocok dengan nama jenis aplikasi dikembalikan, dengan setiap versi dikembalikan sebagai satu jenis aplikasi. Respons mencakup nama, versi, status, parameter, dan detail lainnya tentang jenis aplikasi. Ini adalah kueri yang dipaginasi, yang berarti jika tidak semua jenis aplikasi cocok dalam halaman, satu halaman hasil dikembalikan serta token kelanjutan, yang dapat digunakan untuk mendapatkan halaman berikutnya. Misalnya, jika ada 10 jenis aplikasi tetapi sebuah halaman hanya cocok dengan tiga jenis aplikasi pertama, atau jika hasil maks diatur ke 3, maka tiga dikembalikan. Untuk mengakses hasil lainnya, ambil halaman berikutnya dengan menggunakan token kelanjutan yang dikembalikan di kueri berikutnya. Token kelanjutan kosong dikembalikan jika tidak ada halaman berikutnya.

Minta

Metode URI Permintaan
GET /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parameter

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

applicationTypeName

Jenis: string
Diperlukan: Ya

Nama jenis aplikasi.

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.

ApplicationTypeVersion

Jenis: string
Diperlukan: Tidak

Versi jenis 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 jenis aplikasi dalam kluster.
 PagedApplicationTypeInfoList
Semua kode status lainnya Respons kesalahan terperinci.
 FabricError