Ottenere l'elenco delle informazioni sulle proprietà

Ottiene informazioni su tutte le proprietà di Service Fabric con un determinato nome.

Un nome di Service Fabric può avere una o più proprietà denominate che archiviano informazioni personalizzate. Questa operazione ottiene le informazioni su queste proprietà in un elenco di paging. Le informazioni includono nome, valore e metadati di ogni proprietà.

Richiesta

Metodo	URI richiesta
GET	/Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parametri

Nome	Tipo	Necessario	Posizione
nameId	string	Sì	Percorso
api-version	string	Sì	Query
IncludeValues	boolean	No	Query
ContinuationToken	string	No	Query
timeout	integer (int64)	No	Query

---

nameId

Tipo: string
Obbligatorio: Sì

Nome di Service Fabric, senza lo schema URI "fabric:".

---

api-version

Tipo: string
Obbligatorio: Sì
Impostazione predefinita: 6.0

Versione dell'API. Questo parametro è obbligatorio e il relativo valore deve essere '6.0'.

La versione dell'API REST di Service Fabric è basata sulla versione di runtime in cui è stata introdotta o modificata l'API. Il runtime di Service Fabric supporta più versioni dell'API. Questa è la versione più recente supportata dell'API. Se viene passata una versione precedente dell'API, la risposta restituita può essere diversa da quella documentata in questa specifica.

Inoltre, il runtime accetta qualsiasi versione superiore alla versione supportata più recente fino alla versione corrente del runtime. Se quindi la versione più recente dell'API è 6.0, ma se il runtime è 6.1, per semplificare la scrittura dei client, il runtime accetterà la versione 6.1 per tale API. Tuttavia, il comportamento dell'API sarà in base alla versione 6.0 documentata.

---

IncludeValues

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Consente di specificare se includere i valori delle proprietà restituite. True se i valori devono essere restituiti con i metadati. False per restituire solo i metadati della proprietà.

---

ContinuationToken

Tipo: string
Obbligatorio: No

Il parametro del token di continuazione viene utilizzato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto è incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla successiva chiamata API, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene alcun valore. Il valore di questo parametro non deve essere codificato in URL.

---

timeout

Tipo: integer (int64)
Obbligatorio: No
Impostazione predefinita: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata di attesa che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi.

Risposte

Codice di stato HTTP	Descrizione	Schema di risposta
200 (OK)	Elenco di pagine delle proprietà di Service Fabric.	PagedPropertyInfoList
Tutti gli altri codici di stato	Risposta dettagliata all'errore.	FabricError

Esempio

Ottenere l'elenco delle informazioni sulle proprietà

Questo esempio illustra come ottenere tutte le proprietà di Service Fabric con un nome specificato.

Richiesta

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

200 Risposta

Corpo

{
  "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"
      }
    }
  ]
}

Ottenere l'elenco delle informazioni sulle proprietà con i valori

Questo esempio illustra come ottenere tutte le proprietà di Service Fabric e i relativi valori con un nome specificato.

Richiesta

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

200 Risposta

Corpo

{
  "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"
      }
    }
  ]
}

Pagina che usa il token di continuazione

Questo esempio illustra come scorrere le informazioni sulle proprietà con un determinato nome di Service Fabric usando il parametro ContinuationToken. Il valore di questo parametro viene fornito dalla query precedente, in questo caso l'esempio illustrato in precedenza. La risposta contiene i due risultati rimanenti e un oggetto ContinuationToken vuoto. Il valore ContinuationToken vuoto indica che i risultati aggiuntivi non sono disponibili.

Richiesta

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

200 Risposta

Corpo

{
  "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"
      }
    }
  ]
}