Aracılığıyla paylaş

Hizmet Açıklamasını Al

  • Makale

Var olan bir Service Fabric hizmetinin açıklamasını alır.

Var olan bir Service Fabric hizmetinin açıklamasını alır. Bir hizmetin açıklamasının alınabilmesi için önce oluşturulması gerekir.

İstek

Yöntem İstek URI'si
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parametreler

Ad Tür Gerekli Konum
serviceId string Yes Yol
api-version string Yes Sorgu
timeout integer (int64) No Sorgu

serviceId

Tür: dize
Gerekli: Evet

Hizmetin kimliği. Bu kimlik genellikle 'fabric:' URI şeması olmayan hizmetin tam adıdır. Sürüm 6.0'dan başlayarak hiyerarşik adlar "~" karakteriyle sınırlandırılır. Örneğin, hizmet adı "fabric:/myapp/app1/svc1" ise, hizmet kimliği 6.0+ sürümünde "myapp~app1~svc1" ve önceki sürümlerde "myapp/app1/svc1" olacaktır.

api-version

Tür: dize
Gerekli: Evet
Varsayılan: 6.0

API sürümü. Bu parametre gereklidir ve değeri '6.0' olmalıdır.

Service Fabric REST API sürümü, API'nin tanıtıldığı veya değiştirildiği çalışma zamanı sürümünü temel alır. Service Fabric çalışma zamanı API'nin birden fazla sürümünü destekler. Bu, API'nin desteklenen en son sürümüdür. Daha düşük bir API sürümü geçirilirse, döndürülen yanıt bu belirtimde belgelenenden farklı olabilir.

Buna ek olarak çalışma zamanı, çalışma zamanının geçerli sürümüne kadar desteklenen en son sürümden daha yüksek olan tüm sürümleri kabul ediyor. Bu nedenle, en son API sürümü 6.0 ise ancak çalışma zamanı 6.1 ise, istemcileri yazmayı kolaylaştırmak için çalışma zamanı bu API için sürüm 6.1'i kabul eder. Ancak API'nin davranışı, belgelenen 6.0 sürümüne göre olacaktır.

timeout

Tür: tamsayı (int64)
Gerekli: Hayır
Varsayılan: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

İşlemi saniyeler içinde gerçekleştirmek için sunucu zaman aşımı. Bu zaman aşımı, istemcinin istenen işlemin tamamlanmasını beklemeye istekli olduğu süreyi belirtir. Bu parametre için varsayılan değer 60 saniyedir.

Yanıtlar

HTTP Durum Kodu Description Yanıt Şeması
200 (Tamam) Başarılı bir işlem 200 durum kodu döndürür.
 ServiceDescription
Diğer tüm durum kodları Ayrıntılı hata yanıtı.
 Doku Oluşturucu