Uppdatera tjänstarmmetadata

Artikel
08/05/2023

Uppdateringar armmetadata för en specifik tjänst.

Förfrågan

Metod	URI för förfrågan
POST	`/Services/{serviceId}/$/UpdateArmMetadata?api-version=9.0&timeout={timeout}&Force={Force}`

Parametrar

Namn	Typ	Obligatorisk	Location
`serviceId`	sträng	Ja	Sökväg
`api-version`	sträng	Ja	Söka i data
`timeout`	heltal (int64)	No	Söka i data
`Force`	boolean	No	Söka i data
`ServiceArmMetadataUpdateDescription`	ArmMetadata	Yes	Brödtext

`serviceId`

Typ: sträng
Obligatoriskt: Ja

Tjänstens identitet. Det här ID:t är vanligtvis det fullständiga namnet på tjänsten utan URI-schemat "fabric:". Från och med version 6.0 avgränsas hierarkiska namn med tecknet "~". Om tjänstnamnet till exempel är "fabric:/myapp/app1/svc1" skulle tjänstidentiteten vara "myapp~app1~svc1" i 6.0+ och "myapp/app1/svc1" i tidigare versioner.

`api-version`

Typ: sträng
Obligatoriskt: Ja
Standard: 9.0

Versionen av API:et. Den här parametern krävs och dess värde måste vara "9.0".

Service Fabric REST API-versionen baseras på körningsversionen där API:et introducerades eller ändrades. Service Fabric Runtime stöder mer än en version av API:et. Den här versionen är den senaste versionen av API:et som stöds. Om en lägre API-version skickas kan det returnerade svaret skilja sig från det som beskrivs i den här specifikationen.

Dessutom accepterar körningen alla versioner som är högre än den senaste versionen som stöds fram till den aktuella versionen av körningen. Så om den senaste API-versionen är 6.0 och körningen är 6.1 accepterar körningen version 6.1 för det API:et. Beteendet för API:et kommer dock att vara enligt den dokumenterade 6.0-versionen.

`timeout`

Typ: heltal (int64)
Obligatoriskt: Nej
Standard: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Serverns timeout för att utföra åtgärden i sekunder. Den här tidsgränsen anger hur lång tid klienten är villig att vänta på att den begärda åtgärden ska slutföras. Standardvärdet för den här parametern är 60 sekunder.

`Force`

Typ: booleskt
Obligatoriskt: Nej

Tvinga parametern som används för att förhindra oavsiktlig uppdatering av armmetadata.

`ServiceArmMetadataUpdateDescription`

Typ: ArmMetadata
Obligatoriskt: Ja

Armmetadata som ska assoceras med en specifik tjänst

Svar

HTTP-statuskod	Description	Svarsschema
200 (OK)	En lyckad uppdatering returnerar statuskoden 200.
Alla andra statuskoder	Det detaljerade felsvaret.	FabricError

Dela via