Abrufen von Diensttypinformationen nach Name

  • Artikel

Ruft die Informationen zu einem bestimmten Diensttyp ab, der von einem bereitgestellten Anwendungstyp in einem Service Fabric-Cluster unterstützt wird.

Ruft die Informationen zu einem bestimmten Diensttyp ab, der von einem bereitgestellten Anwendungstyp in einem Service Fabric-Cluster unterstützt wird. Der angegebene Anwendungstyp muss vorhanden sein. Andernfalls wird der Status 404 zurückgegeben. Eine Antwort 204 wird zurückgegeben, wenn der angegebene Diensttyp nicht im Cluster gefunden wird.

Anforderung

Methode Anforderungs-URI
GET /ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&timeout={timeout}

Parameter

Name type Erforderlich Standort
applicationTypeName Zeichenfolge Ja Pfad
serviceTypeName Zeichenfolge Ja Pfad
api-version Zeichenfolge Ja Abfrage
ApplicationTypeVersion Zeichenfolge Ja Abfrage
timeout ganze Zahl (int64) Nein Abfrage

applicationTypeName

Typ: Zeichenfolge
Erforderlich: Ja

Der Name des Anwendungstyps.

serviceTypeName

Typ: Zeichenfolge
Erforderlich: Ja

Gibt den Namen eines Service Fabric-Diensttyps an.

api-version

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "6.0" sein.

Die Service Fabric-REST-API-Version basiert auf der Laufzeitversion, in der die API eingeführt oder geändert wurde. Die Service Fabric-Runtime unterstützt mehrere Versionen der API. Dies ist die neueste unterstützte Version der API. Wenn eine niedrigere API-Version übergeben wird, unterscheidet sich die zurückgegebene Antwort möglicherweise von der in dieser Spezifikation dokumentierten.

Darüber hinaus akzeptiert die Runtime jede Version, die höher als die neueste unterstützte Version bis zur aktuellen Version der Runtime ist. Wenn also die neueste API-Version 6.0 ist, aber die Runtime 6.1 ist, akzeptiert die Runtime Version 6.1 für diese API, um das Schreiben der Clients zu erleichtern. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

ApplicationTypeVersion

Typ: Zeichenfolge
Erforderlich: Ja

Die Version des Anwendungstyps.

timeout

Typ: integer (int64)
Erforderlich: Nein
Standard:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Der Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieser Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter ist 60 Sekunden.

Antworten

HTTP-Statuscode BESCHREIBUNG Antwortschema
200 (OK) Ein bestimmter Diensttyp, der von einem bereitgestellten Anwendungstyp unterstützt wird.
 ServiceTypeInfo
204 (NoContent) Eine Antwort 204 wird zurückgegeben, wenn der angegebene Diensttyp nicht im Cluster gefunden wird.
Alle anderen status Codes Die detaillierte Fehlerantwort.
 FabricError

Beispiele

Rufen Sie Informationen zu allen Knoten ab.

In diesem Beispiel wird gezeigt, wie Sie Informationen zu einem bestimmten Diensttyp abrufen. Eine Antwort 204 wird zurückgegeben, wenn der angegebene Diensttyp nicht im Cluster gefunden wird.

Anforderung

GET http://localhost:19080/ApplicationTypes/Application2Type/$/GetServiceTypes/Actor1ActorServiceType?api-version=6.0&ApplicationTypeVersion=1.0.0

Antwort 200

Text
{
  "ServiceTypeDescription": {
    "IsStateful": true,
    "ServiceTypeName": "Actor1ActorServiceType",
    "PlacementConstraints": "",
    "HasPersistedState": true,
    "Kind": "Stateful",
    "Extensions": [
      {
        "Key": "__GeneratedServiceType__",
        "Value": "<GeneratedNames xmlns=\"http://schemas.microsoft.com/2015/03/fabact-no-schema\">\r\n            <DefaultService Name=\"Actor1ActorService\" />\r\n            <ReplicatorEndpoint Name=\"Actor1ActorServiceReplicatorEndpoint\" />\r\n            <ReplicatorConfigSection Name=\"Actor1ActorServiceReplicatorConfig\" />\r\n            <ReplicatorSecurityConfigSection Name=\"Actor1ActorServiceReplicatorSecurityConfig\" />\r\n            <StoreConfigSection Name=\"Actor1ActorServiceLocalStoreConfig\" />\r\n            <ServiceEndpointV2 Name=\"Actor1ActorServiceEndpointV2\" />\r\n          </GeneratedNames>"
      }
    ],
    "LoadMetrics": [],
    "ServicePlacementPolicies": []
  },
  "ServiceManifestVersion": "1.0.0",
  "ServiceManifestName": "Actor1Pkg",
  "IsServiceGroup": false
}

Antwort 204

Text

Der Antworttext ist leer.