Condividi tramite

Ottenere l'elenco informazioni nome secondario

  • Articolo

Enumera tutti i nomi di Service Fabric con un nome specificato.

Enumera tutti i nomi di Service Fabric con un nome specificato. Se i nomi secondari non rientrano in una pagina, viene restituita una pagina di risultati e un token di continuazione, che può essere usato per ottenere la pagina successiva. L'esecuzione di query su un nome che non esiste avrà esito negativo.

Richiesta

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

Parametri

Nome Tipo Necessario Posizione
nameId string Sì Percorso
api-version string Sì Query
Recursive 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.

Recursive

Tipo: booleano
Obbligatorio: No
Impostazione predefinita: false

Consente di specificare che la ricerca eseguita deve essere ricorsiva.

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 con paging dei nomi di Service Fabric.
 PagedSubNameInfoList
Tutti gli altri codici di stato Risposta dettagliata all'errore.
 FabricError

Esempio

Ottenere i nomi secondari

Questo esempio illustra come ottenere informazioni su tutti i sottonome di un determinato nome di Service Fabric.

Richiesta

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

200 Risposta

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

Ricerca ricorsiva dei sottonome secondari

Questo esempio illustra come ottenere in modo ricorsivo informazioni su tutti i sottonome figlio di un determinato nome di Service Fabric.

Richiesta

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

200 Risposta

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

Pagina che usa il token di continuazione

Questo esempio illustra come scorrere le informazioni sui sottonome 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/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

200 Risposta

Corpo
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}