Opdracht Infrastructuur aanroepen
Roept een beheeropdracht aan op het opgegeven infrastructuurservice-exemplaar.
Voor clusters waarvoor een of meer exemplaren van de infrastructuurservice zijn geconfigureerd, biedt deze API een manier om infrastructuurspecifieke opdrachten te verzenden naar een bepaald exemplaar van de infrastructuurservice.
Beschikbare opdrachten en de bijbehorende antwoordindelingen variëren, afhankelijk van de infrastructuur waarop het cluster wordt uitgevoerd.
Deze API ondersteunt het Service Fabric-platform; het is niet bedoeld om rechtstreeks vanuit uw code te worden gebruikt.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| POST | /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
api-version |
tekenreeks | Ja | Query’s uitvoeren |
Command |
tekenreeks | Ja | Query’s uitvoeren |
ServiceId |
tekenreeks | No | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
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 gewijzigd. Service Fabric-runtime ondersteunt meer dan één versie van de API. Dit is de nieuwste 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.
Daarnaast 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 eenvoudiger te maken om de clients te schrijven. Het gedrag van de API is echter volgens de gedocumenteerde versie 6.0.
Command
Type: tekenreeks
Vereist: Ja
De tekst van de opdracht die moet worden aangeroepen. De inhoud van de opdracht is infrastructuurspecifiek.
ServiceId
Type: tekenreeks
Vereist: Nee
De identiteit van de infrastructuurservice. Dit is de volledige naam van de infrastructuurservice zonder het URI-schema 'fabric:'. Deze parameter is alleen vereist voor het cluster met meer dan één exemplaar van de infrastructuurservice die wordt uitgevoerd.
timeout
Type: geheel getal (int64)
Vereist: Nee
Standaardinstelling: 60
InclusiveMaximum: 4294967295
InclusiefMinimum: 1
De time-out van de server voor het uitvoeren van de bewerking in seconden. Deze time-out geeft de tijdsduur aan die de client bereid is te wachten totdat de aangevraagde bewerking is voltooid. De standaardwaarde voor deze parameter is 60 seconden.
Antwoorden
| HTTP-statuscode | Beschrijving | Antwoordschema |
|---|---|---|
| 200 (OK) | Het antwoord van de infrastructuurservice. De antwoordindeling is een JSON-stroom. De inhoud van het antwoord is afhankelijk van welke opdracht is uitgegeven. |
tekenreeks |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |