Pobieranie listy informacji o właściwościach
Pobiera informacje o wszystkich właściwościach usługi Service Fabric pod daną nazwą.
Nazwa usługi Service Fabric może mieć co najmniej jedną nazwaną właściwości, która przechowuje informacje niestandardowe. Ta operacja pobiera informacje o tych właściwościach na liście stronicowanej. Informacje obejmują nazwę, wartość i metadane dotyczące każdej właściwości.
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout} |
| Nazwa | Typ | Wymagane | Lokalizacja |
|---|---|---|---|
nameId |
ciąg | Tak | Ścieżka |
api-version |
ciąg | Tak | Zapytanie |
IncludeValues |
boolean | Nie | Zapytanie |
ContinuationToken |
ciąg | Nie | Zapytanie |
timeout |
liczba całkowita (int64) | Nie | Zapytanie |
Typ: ciąg
Wymagane: Tak
Nazwa usługi Service Fabric bez schematu identyfikatora URI "fabric:".
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.
Typ: wartość logiczna
Wymagane: Nie
Ustawienie domyślne: false
Umożliwia określenie, czy mają być uwzględniane wartości zwracanych właściwości. Prawda, jeśli wartości powinny być zwracane z metadanymi; Fałsz, aby zwrócić tylko metadane właściwości.
Typ: ciąg
Wymagane: Nie
Parametr tokenu kontynuacji służy do uzyskiwania następnego zestawu wyników. Token kontynuacji z wartością niepustą jest uwzględniany w odpowiedzi interfejsu API, gdy wyniki z systemu nie mieszczą się w jednej odpowiedzi. Po przekazaniu tej wartości do następnego wywołania interfejsu API interfejs API interfejs API zwraca następny zestaw wyników. Jeśli nie ma dalszych wyników, token kontynuacji nie zawiera wartości. Wartość tego parametru nie powinna być zakodowana pod adresem URL.
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.
| Kod stanu HTTP | Opis | Response Schema |
|---|---|---|
| 200 (OK) | Stronicowana lista właściwości usługi Service Fabric. |
PagedPropertyInfoList |
| Wszystkie inne kody stanu | Szczegółowa odpowiedź na błąd. |
FabricError |
W tym przykładzie pokazano, jak uzyskać wszystkie właściwości usługi Service Fabric pod daną nazwą.
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0
{
"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"
}
}
]
}
W tym przykładzie pokazano, jak uzyskać wszystkie właściwości usługi Service Fabric i ich wartości pod daną nazwą.
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True
{
"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"
}
}
]
}
W tym przykładzie pokazano, jak stronicować informacje o właściwościach pod daną nazwą usługi Service Fabric przy użyciu parametru ContinuationToken. Wartość tego parametru jest dostarczana z poprzedniego zapytania, w tym przypadku przykład pokazany powyżej. Odpowiedź zawiera pozostałe dwa wyniki i pusty ciąg ContinuationToken. Pusty ciąg ContinuationToken wskazuje, że dodatkowe wyniki nie są dostępne.
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349
{
"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"
}
}
]
}