Servicebeschrijving ophalen
Hiermee wordt de beschrijving van een bestaande Service Fabric-service opgehaald.
Hiermee wordt de beschrijving van een bestaande Service Fabric-service opgehaald. Een service moet worden gemaakt voordat de beschrijving kan worden verkregen.
Aanvraag
| Methode | Aanvraag-URI |
|---|---|
| GET | /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout} |
Parameters
| Naam | Type | Vereist | Locatie |
|---|---|---|---|
serviceId |
tekenreeks | Ja | Pad |
api-version |
tekenreeks | Ja | Query’s uitvoeren |
timeout |
geheel getal (int64) | Nee | Query’s uitvoeren |
serviceId
Type: tekenreeks
Vereist: Ja
De identiteit van de service. Deze id is doorgaans de volledige naam van de service zonder het URI-schema 'fabric:'.
Vanaf versie 6.0 worden hiërarchische namen gescheiden door het teken '~'.
Als de servicenaam bijvoorbeeld 'fabric:/myapp/app1/svc1' is, is de service-id 'myapp~app1~svc1' in 6.0+ en 'myapp/app1/svc1' in eerdere versies.
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.
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) | Een geslaagde bewerking retourneert de statuscode 200. |
ServiceBeschrijving |
| Alle andere statuscodes | Het gedetailleerde foutantwoord. |
FabricError |