Aktualisieren von Dienstarmmetadaten

Artikel
08/05/2023

Updates die Armmetadaten für einen bestimmten Dienst.

Anforderung

Methode	Anforderungs-URI
POST	`/Services/{serviceId}/$/UpdateArmMetadata?api-version=9.0&timeout={timeout}&Force={Force}`

Parameter

Name	type	Erforderlich	Standort
`serviceId`	Zeichenfolge	Ja	Pfad
`api-version`	Zeichenfolge	Ja	Abfrage
`timeout`	ganze Zahl (int64)	Nein	Abfrage
`Force`	boolean	Nein	Abfrage
`ServiceArmMetadataUpdateDescription`	ArmMetadata	Ja	Body

`serviceId`

Typ: Zeichenfolge
Erforderlich: Ja

Die Identität (ID) des Diensts. Diese ID ist üblicherweise der vollständige Name des Diensts ohne das URI-Schema „fabric“. Ab Version 6.0 wird für hierarchische Namen das Zeichen „~“ als Trennzeichen verwendet. Wenn der Dienstname beispielsweise „fabric:/myapp/app1/svc1“ lautet, würde die Dienstidentität ab 6.0 „myapp~app1~svc1“ und in früheren Versionen „myapp/app1/svc1“ lauten.

`api-version`

Typ: Zeichenfolge
Erforderlich: Ja
Standard:

Die Version der API. Dieser Parameter ist erforderlich, und sein Wert muss "9.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. Diese Version 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 und die Runtime 6.1 ist, akzeptiert die Runtime Version 6.1 für diese API. Das Verhalten der API entspricht jedoch der dokumentierten Version 6.0.

`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.

`Force`

Typ: boolesch
Erforderlich: Nein

Erzwingen Sie den Parameter, der verwendet wird, um eine versehentliche Aktualisierung von Arm-Metadaten zu verhindern.

`ServiceArmMetadataUpdateDescription`

Typ: ArmMetadata
Erforderlich: Ja

Arm-Metadaten, die einem bestimmten Dienst zugeordnet werden sollen

Antworten

HTTP-Statuscode	BESCHREIBUNG	Antwortschema
200 (OK)	Ein erfolgreiches Update gibt 200 status Code zurück.
Alle anderen status Codes	Die detaillierte Fehlerantwort.	FabricError

Freigeben über