Aracılığıyla paylaş

Dağıtılan Uygulama Bilgileri Listesini Al

  • Makale

Service Fabric düğümünde dağıtılan uygulamaların listesini alır.

Service Fabric düğümünde dağıtılan uygulamaların listesini alır. Sonuçlar, kimliğine göre açıkça sorgulanmadığı sürece dağıtılan sistem uygulamaları hakkında bilgi içermez. Sonuçlar etkin, etkinleştirme ve indirme durumlarında dağıtılan uygulamaları kapsar. Bu sorgu, düğüm adının kümedeki bir düğüme karşılık geldiğini gerektirir. Sağlanan düğüm adı kümedeki etkin Service Fabric düğümlerine işaret etmiyorsa sorgu başarısız olur.

İstek

Yöntem İstek URI'si
GET /Nodes/{nodeName}/$/GetApplications?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parametreler

Ad Tür Gerekli Konum
nodeName string Yes Yol
api-version string Yes Sorgu
timeout integer (int64) No Sorgu
IncludeHealthState boolean No Sorgu
ContinuationToken dize No Sorgu
MaxResults integer (int64) No Sorgu

nodeName

Tür: dize
Gerekli: Evet

Düğümün adı.

api-version

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

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

IncludeHealthState

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

Bir varlığın sistem durumunu ekleyin. Bu parametre false ise veya belirtilmemişse, döndürülen sistem durumu "Bilinmiyor" olur. true olarak ayarlandığında, sonuçlar birleştirilmeden önce sorgu düğüme ve sistem durumu sistemi hizmetine paralel olarak gider. Sonuç olarak, sorgu daha pahalıdır ve daha uzun sürebilir.

ContinuationToken

Tür: dize
Gerekli: Hayır

Devam 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ğere sahip 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

Sayfalanan 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 en büyük ileti boyutu kısıtlamalarına göre iletiye sığmıyorsa belirtilen en yüksek sonuçlardan daha az olabilir. Bu parametre sıfırsa veya belirtilmemişse, sayfalanan sorgu dönüş iletisine sığabilecek kadar çok sonuç içerir.

Yanıtlar

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

Örnekler

Maksimum sonuçları sınırla

Bu örnekte, belirli bir düğümde dağıtılan uygulamalar hakkında bilgi alırken sorgu tarafından döndürülen uygulama sayısının nasıl belirtileceğini gösterir. MaxResult parametresi kullanılarak sayfadaki sonuç sayısı en fazla 2 ile sınırlıdır. Bu örnekte sistem durumu istenmediğinden döndürülen sistem durumu Bilinmiyor olacaktır.

İstek

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?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.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Devamlılık belirtecini kullanan sayfa

Bu örnekte, belirli bir düğümde dağıtılan uygulamalar hakkında bilgi alırken kullanılabilen disk belleği işlevselliği gösterilmektedir. Bu örnekte ContinuationToken parametresi kullanılır. Bu parametrenin değeri önceki sorgudan sağlanır; bu örnekte yukarıda gösterilen örnek. Yanıt, kalan sonuçları ve boş bir ContinuationToken'ı içerir. Boş ContinuationToken, ek sonuçların kullanılamadığını gösterir.

İstek

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

200 Yanıt

Gövde
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Sonucun sistem durumunu dahil et

Bu örnekte, belirli bir düğümde dağıtılan uygulamalar hakkında bilgi alırken dağıtılan her uygulamanın sistem durumunun nasıl dahil olduğu gösterilmektedir.

İstek

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&IncludeHealthState=True

200 Yanıt

Gövde
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}