Alt Ad Bilgi Listesi Al
Tüm Service Fabric adlarını belirli bir ad altında numaralandırır.
Tüm Service Fabric adlarını belirli bir ad altında numaralandırır. Alt adlar bir sayfaya sığmazsa, bir sonuç sayfası ve bir sonraki sayfayı almak için kullanılabilecek bir devamlılık belirteci döndürülür. Var olmayan bir adı sorgulama başarısız olur.
İstek
Yöntem | İstek URI'si |
---|---|
GET | /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parametreler
Ad | Tür | Gerekli | Konum |
---|---|---|---|
nameId |
string | Yes | Yol |
api-version |
string | Yes | Sorgu |
Recursive |
boolean | No | Sorgu |
ContinuationToken |
dize | No | Sorgu |
timeout |
integer (int64) | No | Sorgu |
nameId
Tür: dize
Gerekli: Evet
'fabric:' URI şeması olmadan Service Fabric adı.
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.
Recursive
Tür: boole
Gerekli: Hayır
Varsayılan: false
Gerçekleştirilen aramanın özyinelemeli olması gerektiğini belirtmeye izin verir.
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.
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) | Service Fabric adlarının sayfalanmış listesi. |
PagedSubNameInfoList |
Diğer tüm durum kodları | Ayrıntılı hata yanıtı. |
Doku Oluşturucu |
Örnekler
Alt adları alma
Bu örnekte, belirli bir Service Fabric adının tüm alt adları hakkında bilgi alma gösterilmektedir.
İstek
GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0
200 Yanıt
Gövde
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/CalculatorApp",
"fabric:/samples/mynames"
]
}
Alt adları özyinelemeli olarak arama
Bu örnekte, belirli bir Service Fabric adının tüm alt alt adları hakkında özyinelemeli olarak bilgi alma gösterilmektedir.
İstek
GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True
200 Yanıt
Gövde
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/apps",
"fabric:/samples/data",
"fabric:/samples/CalculatorApp",
"fabric:/samples/CalculatorApp/CalculatorService",
"fabric:/samples/CalculatorApp/CalculatorService/Name-1",
"fabric:/samples/CalculatorApp/CalculatorService/Name-2",
"fabric:/samples/mynames/name-1"
]
}
Devamlılık belirtecini kullanan sayfa
Bu örnekte ContinuationToken parametresi kullanılarak belirli bir Service Fabric adı altındaki alt adlarla ilgili bilgilerin nasıl sayfalara eklenmeleri 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/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349
200 Yanıt
Gövde
{
"ContinuationToken": "",
"IsConsistent": true,
"SubNames": [
"fabric:/samples/apps/VolatileQueueApp",
"fabric:/samples/apps/NotepadApp"
]
}