Aracılığıyla paylaş

Uygulama Bilgileri Listesini Al

  • Makale

Service Fabric kümesinde oluşturulan ve belirtilen filtrelerle eşleşen uygulamaların listesini alır.

Service Fabric kümesinde oluşturulan veya oluşturulma sürecinde olan uygulamalar hakkındaki bilgileri alır ve belirtilen filtrelerle eşleşir. Yanıt ad, tür, durum, parametreler ve uygulama hakkındaki diğer ayrıntıları içerir. Uygulamalar bir sayfaya sığmazsa, bir sonuç sayfası ve sonraki sayfayı almak için kullanılabilecek bir devamlılık belirteci döndürülür. ApplicationTypeName ve ApplicationDefinitionKindFilter filtrelerini aynı anda belirtemez.

İstek

Yöntem İstek URI'si
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parametreler

Ad Tür Gerekli Konum
api-version string Yes Sorgu
ApplicationDefinitionKindFilter tamsayı No Sorgu
ApplicationTypeName dize No Sorgu
ExcludeApplicationParameters boolean No Sorgu
ContinuationToken dize No Sorgu
MaxResults integer (int64) No Sorgu
timeout integer (int64) No Sorgu

api-version

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

API'nin sürümü. Bu parametre gereklidir ve değeri '6.1' 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 belgelenen yanıttan farklı olabilir.

Ayrıca ç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 edin. 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.

ApplicationDefinitionKindFilter

Tür: tamsayı
Gerekli: Hayır
Varsayılan: 0

Service Fabric uygulamasını tanımlamak için kullanılan mekanizma olan ApplicationDefinitionKind'de filtrelemek için kullanılır.

  • Varsayılan - "Tümü" öğesini seçmekle aynı işlevi gerçekleştiren varsayılan değer. Değer 0'dır.
  • Tümü - Herhangi bir ApplicationDefinitionKind değeriyle girişle eşleşen filtre. Değer 65535'tir.
  • ServiceFabricApplicationDescription - ApplicationDefinitionKind değeri ServiceFabricApplicationDescription ile girişle eşleşen filtre. Değer 1'dir.
  • Compose - ApplicationDefinitionKind değeri Compose ile girişi eşleştiren filtre. Değer 2'dir.

ApplicationTypeName

Tür: dize
Gerekli: Hayır

Sorgu yapılacak uygulamaları filtrelemek için kullanılan uygulama türü adı. Bu değer uygulama türü sürümünü içermemelidir.

ExcludeApplicationParameters

Tür: boole
Gerekli: Hayır
Varsayılan: false

Uygulama parametrelerinin sonuçtan dışlanıp dışlanmayacağını belirten bayrak.

ContinuationToken

Tür: dize
Gerekli: Hayır

Devamlılık belirteci parametresi, sonraki sonuç kümesini almak için kullanılır. Sistemden alınan sonuçlar tek bir yanıta sığmadığında API'nin yanıtına boş olmayan bir değer içeren bir devamlılık belirteci eklenir. Bu değer bir sonraki API çağrısına geçirildiğinde, API bir sonraki sonuç kümesini döndürür. Başka sonuç yoksa, devamlılık belirteci bir değer içermez. Bu parametrenin değeri URL kodlanmış olmamalıdır.

MaxResults

Tür: tamsayı (int64)
Gerekli: Hayır
Varsayılan: 0
InclusiveMinimum: 0

Disk belleğine alınan sorguların bir parçası olarak döndürülecek en fazla sonuç sayısı. Bu parametre, döndürülen sonuç sayısı üzerindeki üst sınırı tanımlar. Döndürülen sonuçlar, yapılandırmada tanımlanan maksimum ileti boyutu kısıtlamalarına göre iletiye sığmamaları durumunda belirtilen en yüksek sonuçlardan küçük olabilir. Bu parametre sıfırsa veya belirtilmezse, sayfalanan sorgu dönüş iletisine sığacak kadar çok sonuç içerir.

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) Kümede oluşturulan uygulamaların listesi.
 PagedApplicationInfoList
Diğer tüm durum kodları Ayrıntılı hata yanıtı.
 Doku Oluşturucu

Örnekler

Maksimum sonuçları sınırla

Bu örnekte, kümedeki uygulamalar hakkında bilgi edinme gösterilmektedir. MaxResult parametresi kullanılarak sayfadaki sonuç sayısı en fazla iki sonuçla sınırlıdır.

İstek

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

200 Yanıt

Gövde
{
  "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"
    }
  ]
}

Devamlılık belirtecini kullanan sayfa

Bu örnek, ContinuationToken parametresini kullanarak kümedeki uygulamalar hakkında bilgilerde nasıl sayfalandırma yapılacağını gösterir. Bu parametrenin değeri önceki sorgudan(bu örnekte) yukarıda gösterilen örnekten sağlanır. Yanıt, kalan bir sonucu ve boş bir ContinuationToken'ı içerir. Boş ContinuationToken, ek sonuçların kullanılamadığını gösterir.

İstek

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

200 Yanıt

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