Dapatkan Deskripsi Layanan
Mendapatkan deskripsi layanan Service Fabric yang ada.
Mendapatkan deskripsi layanan Service Fabric yang ada. Layanan harus dibuat sebelum deskripsinya dapat diperoleh.
Minta
Metode | URI Permintaan |
---|---|
GET | /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout} |
Parameter
Nama | Jenis | Diperlukan | Lokasi |
---|---|---|---|
serviceId |
string | Ya | Jalur |
api-version |
string | Ya | Kueri |
timeout |
bilangan bulat (int64) | Tidak | Kueri |
serviceId
Jenis: string
Diperlukan: Ya
Identitas layanan. ID ini biasanya merupakan nama lengkap layanan tanpa skema URI 'fabric:’.
Mulai dari versi 6.0, nama hierarki dibatasi dengan karakter “~”.
Misalnya, jika nama layanan adalah "fabric:/myapp/app1/svc1", identitas layanan akan menjadi "myapp~app1~svc1" di 6.0+ dan "myapp/app1/svc1" 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.
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) | Operasi yang berhasil akan mengembalikan kode status 200. |
ServiceDescription |
Semua kode status lainnya | Respons kesalahan terperinci. |
FabricError |