Bagikan melalui

Dapatkan Info Aplikasi

  • Artikel

Mendapatkan informasi tentang aplikasi Service Fabric.

Mengembalikan informasi tentang aplikasi yang dibuat atau dalam proses dibuat di kluster Service Fabric dan yang namanya cocok dengan yang ditentukan sebagai parameter. Respons mencakup nama, jenis, status, parameter, dan detail lainnya tentang aplikasi.

Minta

Metode URI Permintaan
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parameter

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

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.

ExcludeApplicationParameters

Jenis: boolean
Diperlukan: Tidak
Default: false

Bendera yang menentukan apakah parameter aplikasi akan dikecualikan dari hasilnya.

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) Informasi tentang aplikasi.
 ApplicationInfo
204 (NoContent) Respons kosong dikembalikan jika applicationId yang ditentukan tidak ditemukan di kluster.
Semua kode status lainnya Respons kesalahan terperinci.
 FabricError

Contoh

Mendapatkan aplikasi tertentu dengan id aplikasi

Contoh ini menunjukkan cara mendapatkan informasi tentang aplikasi menggunakan pengidentifikasinya. Jika aplikasi ditemukan, informasi tentang aplikasi dikembalikan dengan kode status 200. Jika aplikasi tidak ditemukan, konten kosong dikembalikan dengan kode status 204.

Minta

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Respons 200

Isi
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Respons 204

Isi

Isi respons kosong.