Udostępnij za pośrednictwem

Pobieranie informacji o właściwości

  • Artykuł

Pobiera określoną właściwość usługi Service Fabric.

Pobiera określoną właściwość usługi Service Fabric pod daną nazwą. Będzie to zawsze zwracać zarówno wartość, jak i metadane.

Żądanie

Metoda Identyfikator URI żądania
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

Parametry

Nazwa Typ Wymagane Lokalizacja
nameId ciąg Tak Ścieżka
api-version ciąg Tak Zapytanie
PropertyName ciąg Tak Zapytanie
timeout liczba całkowita (int64) Nie Zapytanie

nameId

Typ: ciąg
Wymagane: Tak

Nazwa usługi Service Fabric bez schematu identyfikatora URI "fabric:".

api-version

Typ: ciąg
Wymagane: Tak
Ustawienie domyślne: 6.0

Wersja interfejsu API. Ten parametr jest wymagany, a jego wartość musi mieć wartość "6.0".

Wersja interfejsu API REST usługi Service Fabric jest oparta na wersji środowiska uruchomieniowego, w której wprowadzono lub zmieniono interfejs API. Środowisko uruchomieniowe usługi Service Fabric obsługuje więcej niż jedną wersję interfejsu API. Jest to najnowsza obsługiwana wersja interfejsu API. Jeśli zostanie przekazana niższa wersja interfejsu API, zwrócona odpowiedź może być inna niż ta udokumentowana w tej specyfikacji.

Ponadto środowisko uruchomieniowe akceptuje każdą wersję, która jest wyższa niż najnowsza obsługiwana wersja do bieżącej wersji środowiska uruchomieniowego. Jeśli więc najnowsza wersja interfejsu API to 6.0, ale jeśli środowisko uruchomieniowe ma wartość 6.1, aby ułatwić pisanie klientów, środowisko uruchomieniowe zaakceptuje wersję 6.1 dla tego interfejsu API. Jednak zachowanie interfejsu API będzie zgodnie z udokumentowaną wersją 6.0.

PropertyName

Typ: ciąg
Wymagane: Tak

Określa nazwę właściwości do pobrania.

timeout

Typ: liczba całkowita (int64)
Wymagane: Nie
Ustawienie domyślne: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Limit czasu serwera na potrzeby wykonywania operacji w sekundach. Ten limit czasu określa czas trwania, przez który klient chce poczekać na ukończenie żądanej operacji. Wartość domyślna tego parametru to 60 sekund.

Odpowiedzi

Kod stanu HTTP Opis Response Schema
200 (OK) Szczegółowe informacje na temat właściwości usługi Service Fabric.
 Propertyinfo
Wszystkie inne kody stanu Szczegółowa odpowiedź na błąd.
 FabricError

Przykłady

Pobieranie informacji o właściwości

W tym przykładzie pokazano, jak uzyskać właściwość usługi Service Fabric pod daną nazwą.

Żądanie

GET http://localhost:19080/Names/samples/apps/$/GetProperty?api-version=6.0&PropertyName=AppData

200 Odpowiedź

Treść
{
  "Name": "CalculatorAppData",
  "Value": {
    "Kind": "String",
    "Data": "1+2=3"
  },
  "Metadata": {
    "TypeId": "String",
    "CustomTypeId": "EquationType",
    "Parent": "fabric:/samples/apps",
    "SizeInBytes": "12",
    "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
    "SequenceNumber": "12"
  }
}