Aracılığıyla paylaş


Özellik Bilgisi Listesini Al

Belirli bir ad altındaki tüm Service Fabric özellikleriyle ilgili bilgileri alır.

Service Fabric adı, özel bilgileri depolayan bir veya daha fazla adlandırılmış özelliğe sahip olabilir. Bu işlem, bu özelliklerle ilgili bilgileri sayfalanmış bir listede alır. Bilgiler, özelliklerin her biri hakkında ad, değer ve meta verileri içerir.

İstek

Yöntem İstek URI'si
GET /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parametreler

Ad Tür Gerekli Konum
nameId string Yes Yol
api-version string Yes Sorgu
IncludeValues 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 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.


IncludeValues

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

Döndürülen özelliklerin değerlerinin eklenip eklenmeyeceğini belirtmeye izin verir. Değerlerin meta verilerle döndürülmesi gerekiyorsa True; Yalnızca özellik meta verilerini döndürmek için False.


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.


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 özelliklerinin sayfalanmış listesi.
PagedPropertyInfoList
Diğer tüm durum kodları Ayrıntılı hata yanıtı.
Doku Oluşturucu

Örnekler

Özellik bilgileri listesini alma

Bu örnekte, tüm Service Fabric özelliklerinin belirli bir ad altında nasıl alınacakları gösterilmektedir.

İstek

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0

200 Yanıt

Gövde
{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

Değer içeren özellik bilgileri listesini alma

Bu örnekte, tüm Service Fabric özelliklerinin ve değerlerinin belirli bir ad altında nasıl alındıkları gösterilmektedir.

İstek

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True

200 Yanıt

Gövde
{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Value": {
        "Kind": "Int64",
        "Data": "4534"
      },
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Value": {
        "Kind": "Binary",
        "Data": [
          "6",
          "7",
          "8",
          "9",
          "10"
        ]
      },
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

Devamlılık belirtecini kullanan sayfa

Bu örnek, ContinuationToken parametresini kullanarak belirli bir Service Fabric adı altındaki özellikler 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 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/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349

200 Yanıt

Gövde
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "VolatileQueueAppData",
      "Value": {
        "Kind": "Double",
        "Data": "67.89"
      },
      "Metadata": {
        "TypeId": "Double",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
        "SequenceNumber": "8"
      }
    }
  ]
}