Delen via

Lijst met subnaamgegevens ophalen

  • Artikel

Inventariseert alle Service Fabric-namen onder een bepaalde naam.

Inventariseert alle Service Fabric-namen onder een bepaalde naam. Als de subnamen niet in een pagina passen, wordt één pagina met resultaten geretourneerd, evenals een vervolgtoken, dat kan worden gebruikt om de volgende pagina op te halen. Het uitvoeren van een query op een naam die niet bestaat, mislukt.

Aanvraag

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

Parameters

Naam Type Vereist Locatie
nameId tekenreeks Ja Pad
api-version tekenreeks Ja Query’s uitvoeren
Recursive booleaans No Query’s uitvoeren
ContinuationToken tekenreeks No Query’s uitvoeren
timeout geheel getal (int64) Nee Query’s uitvoeren

nameId

Type: tekenreeks
Vereist: Ja

De Service Fabric-naam, zonder het URI-schema 'fabric:'.

api-version

Type: tekenreeks
Vereist: Ja
Standaardinstelling: 6.0

De versie van de API. Deze parameter is vereist en de waarde moet '6.0' zijn.

Service Fabric REST API-versie is gebaseerd op de runtimeversie waarin de API is geïntroduceerd of is gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de meest recente ondersteunde versie van de API. Als een lagere API-versie wordt doorgegeven, kan het geretourneerde antwoord afwijken van het antwoord dat in deze specificatie wordt beschreven.

Bovendien accepteert de runtime elke versie die hoger is dan de meest recente ondersteunde versie tot de huidige versie van de runtime. Dus als de nieuwste API-versie 6.0 is, maar als de runtime 6.1 is, accepteert de runtime versie 6.1 voor die API om het schrijven van de clients gemakkelijker te maken. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.

Recursive

Type: Booleaanse waarde
Vereist: Nee
Standaardinstelling: false

Hiermee kunt u opgeven dat de uitgevoerde zoekopdracht recursief moet zijn.

ContinuationToken

Type: tekenreeks
Vereist: Nee

De parameter voor het vervolgtoken wordt gebruikt om de volgende set resultaten te verkrijgen. Een vervolgtoken met een niet-lege waarde wordt opgenomen in het antwoord van de API wanneer de resultaten van het systeem niet in één antwoord passen. Wanneer deze waarde wordt doorgegeven aan de volgende API-aanroep, retourneert de API de volgende set resultaten. Als er geen verdere resultaten zijn, bevat het vervolgtoken geen waarde. De waarde van deze parameter mag geen URL-codering hebben.

timeout

Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiefMaximum: 4294967295
InclusiefMinimum: 1

De servertime-out voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten tot de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.

Antwoorden

HTTP-statuscode Beschrijving Antwoordschema
200 (OK) Een paginalijst met Service Fabric-namen.
 PagedSubNameInfoList
Alle andere statuscodes Het gedetailleerde foutantwoord.
 FabricError

Voorbeelden

Subnamen ophalen

In dit voorbeeld ziet u hoe u informatie kunt ophalen over alle subnamen van een bepaalde Service Fabric-naam.

Aanvraag

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

200-antwoord

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

Subnamen recursief zoeken

In dit voorbeeld ziet u hoe u recursief informatie kunt ophalen over alle onderliggende subnamen van een bepaalde Service Fabric-naam.

Aanvraag

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

200-antwoord

Hoofdtekst
{
  "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 met vervolgtoken

In dit voorbeeld ziet u hoe u door de informatie over subnamen onder een bepaalde Service Fabric-naam bladert met behulp van de parameter ContinuationToken. De waarde van deze parameter is afkomstig van de vorige query, in dit geval het voorbeeld hierboven. Het antwoord bevat de resterende twee resultaten en een leeg ContinuationToken. Het lege ContinuationToken geeft aan dat er geen aanvullende resultaten beschikbaar zijn.

Aanvraag

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

200-antwoord

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