Mettre à jour les métadonnées Service Arm

Article
08/05/2023

Mises à jour les métadonnées Arm pour un service spécifique.

Requête

Méthode	URI de demande
POST	`/Services/{serviceId}/$/UpdateArmMetadata?api-version=9.0&timeout={timeout}&Force={Force}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`serviceId`	string	Oui	Chemin d’accès
`api-version`	string	Oui	Requête
`timeout`	integer (int64)	Non	Requête
`Force`	boolean	Non	Requête
`ServiceArmMetadataUpdateDescription`	ArmMetadata	Oui	body

`serviceId`

Type : chaîne
Obligatoire : Oui

Identité du service. Cet ID est généralement le nom complet du service sans le schéma d’URI « fabric: ». Depuis la version 6.0, les noms hiérarchiques sont séparés par le caractère « ~ ». Par exemple, si un service est nommé « fabric:/myapp/app1/svc1 », son identité de service est « myapp~app1~svc1 » dans les versions 6.0 et ultérieures et « myapp/app1/svc1 » dans les versions antérieures.

`api-version`

Type : chaîne
Obligatoire : Oui
Par défaut : 9.0

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 9.0 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Cette version est la dernière version prise en charge de l’API. Si une version inférieure de l’API est passée, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0 et que le runtime est 6.1, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera conformément à la version 6.0 documentée.

`timeout`

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

`Force`

Type : booléen
Obligatoire : Non

Forcer le paramètre utilisé pour empêcher la mise à jour accidentelle des métadonnées Arm.

`ServiceArmMetadataUpdateDescription`

Type : ArmMetadata
Obligatoire : Oui

Métadonnées Arm à assocer avec un service spécifique

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Une mise à jour réussie retourne 200 status code.
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via