Ottenere la descrizione del servizio
Mostra la descrizione di un servizio di Service Fabric esistente.
Mostra la descrizione di un servizio di Service Fabric esistente. Prima di poter ottenere la descrizione, è necessario creare un servizio.
Richiesta
Metodo | URI richiesta |
---|---|
GET | /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout} |
Parametri
Nome | Tipo | Necessario | Posizione |
---|---|---|---|
serviceId |
string | Sì | Percorso |
api-version |
string | Sì | Query |
timeout |
integer (int64) | No | Query |
serviceId
Tipo: stringa
Obbligatorio: Sì
L'identità del servizio. Questo ID è in genere il nome completo del servizio senza lo schema URI 'fabric:'.
A partire dalla versione 6.0, i nomi gerarchici sono delimitati dal carattere "~".
Ad esempio, se il nome del servizio è "fabric:/myapp/app1/svc1", l'identità del servizio sarà "myapp~app1~svc1" in 6.0+ e "myapp/app1/svc1" nelle versioni precedenti.
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.
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) | Un'operazione riuscita restituirà il codice di stato 200. |
ServiceDescription |
Tutti gli altri codici di stato | Risposta dettagliata all'errore. |
FabricError |