Ottenere informazioni sulla proprietà

  • Articolo

Ottiene la proprietà di Service Fabric specificata.

Ottiene la proprietà di Service Fabric specificata con un determinato nome. Questa proprietà restituirà sempre sia il valore che i metadati.

Richiesta

Metodo URI richiesta
GET /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout}

Parametri

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

nameId

Tipo: stringa
Obbligatorio: Sì

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

api-version

Tipo: stringa
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 api inferiore, 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. Quindi, se la versione dell'API più recente è 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.

PropertyName

Tipo: stringa
Obbligatorio: Sì

Specifica il nome della proprietà da ottenere.

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 del tempo 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) Dettagli sulla proprietà Service Fabric.
 Propertyinfo
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

Ottenere informazioni sulle proprietà

In questo esempio viene illustrato come ottenere una proprietà di Service Fabric in un determinato nome.

Richiesta

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

Risposta 200

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