Hämta egenskapsinformationslista
Hämtar information om alla Service Fabric-egenskaper under ett givet namn.
Ett Service Fabric-namn kan ha en eller flera namngivna egenskaper som lagrar anpassad information. Den här åtgärden hämtar information om dessa egenskaper i en sidlista. Informationen innehåller namn, värde och metadata om var och en av egenskaperna.
Förfrågan
| Metod | URI för förfrågan |
|---|---|
| GET | /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parametrar
| Namn | Typ | Obligatorisk | Location |
|---|---|---|---|
nameId |
sträng | Ja | Sökväg |
api-version |
sträng | Ja | Söka i data |
IncludeValues |
boolean | No | Söka i data |
ContinuationToken |
sträng | No | Söka i data |
timeout |
heltal (int64) | No | Söka i data |
nameId
Typ: sträng
Obligatoriskt: Ja
Service Fabric-namnet utan URI-schemat fabric:.
api-version
Typ: sträng
Obligatoriskt: Ja
Standard: 6.0
Versionen av API:et. Den här parametern krävs och dess värde måste vara "6.0".
Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Det här är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.
Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0, men om körningen är 6.1, för att göra det enklare att skriva klienterna, accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.
IncludeValues
Typ: booleskt
Obligatoriskt: Nej
Standard: false
Tillåter att du anger om värdena för de egenskaper som returneras ska inkluderas. Sant om värden ska returneras med metadata; Falskt för att endast returnera egenskapsmetadata.
ContinuationToken
Typ: sträng
Obligatoriskt: Nej
Parametern fortsättningstoken används för att hämta nästa uppsättning resultat. En fortsättningstoken med ett icke-tomt värde ingår i API:ets svar när resultatet från systemet inte får plats i ett enda svar. När det här värdet skickas till nästa API-anrop returnerar API:et nästa uppsättning resultat. Om det inte finns några ytterligare resultat innehåller fortsättningstoken inget värde. Värdet för den här parametern ska inte vara URL-kodat.
timeout
Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.
Svar
| HTTP-statuskod | Description | Svarsschema |
|---|---|---|
| 200 (OK) | En sidlista med Service Fabric-egenskaper. |
PagedPropertyInfoList |
| Alla andra statuskoder | Det detaljerade felsvaret. |
FabricError |
Exempel
Hämta egenskapsinformationslista
Det här exemplet visar hur du hämtar alla Service Fabric-egenskaper under ett visst namn.
Förfrågan
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0
200-svar
Brödtext
{
"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"
}
}
]
}
Hämta egenskapsinformationslista med värden
Det här exemplet visar hur du hämtar alla Service Fabric-egenskaper och deras värden under ett visst namn.
Förfrågan
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True
200-svar
Brödtext
{
"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"
}
}
]
}
Sida med fortsättningstoken
Det här exemplet visar hur du bläddrar igenom informationen om egenskaper under ett angivet Service Fabric-namn med hjälp av parametern ContinuationToken. Värdet för den här parametern anges från föregående fråga, i det här fallet exemplet som visas ovan. Svaret innehåller de återstående två resultaten och en tom ContinuationToken. Den tomma ContinuationToken anger att ytterligare resultat inte är tillgängliga.
Förfrågan
GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349
200-svar
Brödtext
{
"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"
}
}
]
}