Uygulama Türü Bilgi Listesi Al

Makale
08/05/2023

Service Fabric kümesindeki uygulama türlerinin listesini alır.

Service Fabric kümesinde sağlanan veya sağlama sürecinde olan uygulama türleri hakkındaki bilgileri döndürür. Bir uygulama türünün her sürümü tek bir uygulama türü olarak döndürülür. Yanıt ad, sürüm, durum ve uygulama türüyle ilgili diğer ayrıntıları içerir. Bu, sayfalanmış bir sorgudur; yani tüm uygulama türleri bir sayfaya sığmazsa, bir sonuç sayfası döndürülür ve bir sonraki sayfayı almak için kullanılabilecek bir devamlılık belirteci döndürülür. Örneğin, 10 uygulama türü varsa ancak sayfa yalnızca ilk üç uygulama türüne uyuyorsa veya maksimum sonuç 3 olarak ayarlandıysa, üç döndürülür. Sonuçların geri kalanına erişmek için sonraki sorguda döndürülen devamlılık belirtecini kullanarak sonraki sayfaları alın. Sonraki sayfalar yoksa boş bir devamlılık belirteci döndürülür.

İstek

Yöntem	İstek URI'si
GET	`/ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}`

Parametreler

Ad	Tür	Gerekli	Konum
`api-version`	string	Yes	Sorgu
`ApplicationTypeDefinitionKindFilter`	tamsayı	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.0

API'nin 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 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.

`ApplicationTypeDefinitionKindFilter`

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

Service Fabric uygulama türünü tanımlamak için kullanılan mekanizma olan ApplicationTypeDefinitionKind'i 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 ApplicationTypeDefinitionKind değeriyle girişle eşleşen filtre. Değer 65535'tir.
ServiceFabricApplicationPackage - ApplicationTypeDefinitionKind değeri ServiceFabricApplicationPackage ile girişle eşleşen filtre. Değer 1'dir.
Compose - ApplicationTypeDefinitionKind değeri Compose ile girişi eşleştiren filtre. Değer 2'dir.

`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ümedeki uygulama türlerinin listesi.	PagedApplicationTypeInfoList
Diğer tüm durum kodları	Ayrıntılı hata yanıtı.	Doku Oluşturucu

Örnekler

Maksimum sonuçları sınırla

Bu örnek, kümede sağlanan veya sağlanan uygulama türleri hakkında nasıl bilgi alındığını gösterir. MaxResult parametresi kullanılarak sayfadaki sonuç sayısı en fazla beş ile sınırlıdır.

İstek

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

200 Yanıt

Gövde

{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Devamlılık belirtecini kullanan sayfa

Bu örnekte ContinuationToken parametresi kullanılarak kümede sağlanan veya sağlanan uygulama türleri hakkındaki bilgilerin nasıl sayfalandırıldığı gösterilmektedir. Bu parametrenin değeri yukarıdaki sorgudan (bu örnekte yukarıda gösterilen örnekte) sağlanır. Yanıt, kalan iki sonucu ve boş bir ContinuationToken'ı içerir. Boş ContinuationToken, ek sonuçların kullanılamadığını gösterir.

İstek

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

200 Yanıt

Gövde

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Uygulama parametrelerini sonuçtan dışlama

Bu örnekte, kümede sağlanan veya sağlanan uygulama türleri hakkında bilgi alınırken sonuçta uygulama parametresinin nasıl dışlandığı gösterilmektedir.

İstek

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

200 Yanıt

Gövde

{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}

Aracılığıyla paylaş

Uygulama Türü Bilgi Listesi Al

İstek

Parametreler

`api-version`

`ApplicationTypeDefinitionKindFilter`

`ExcludeApplicationParameters`

`ContinuationToken`

`MaxResults`

`timeout`

Yanıtlar

Örnekler

Maksimum sonuçları sınırla

İstek

200 Yanıt

Gövde

Devamlılık belirtecini kullanan sayfa

İstek

200 Yanıt

Gövde

Uygulama parametrelerini sonuçtan dışlama

İstek

200 Yanıt

Gövde

Ek kaynaklar