UpdateStackGroup - - Centre de documentation Alibaba Cloud

Dans cet exemple, le contenu du modèle {"ROSTemplateFormatVersion": "2015-09-01"} est spécifié pour mettre à jour un groupe de piles nommé MyStackGroup. Le groupe de piles bénéficie d'autorisations autogérées et est déployé dans la région Chine (Hangzhou).

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateStackGroup	L'action que vous souhaitez effectuer. Définissez la valeur sur UpdateStackGroup.
RegionId	String	Yes	cn-hangzhou	L'ID de région du groupe de piles. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste actualisée des régions Alibaba Cloud.
StackGroupName	String	Yes	MyStackGroup	Le nom du groupe de piles. Le nom doit être unique au sein d'une région. Le nom peut comporter jusqu'à 255 caractères et contenir des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre.
Description	String	No	My Stack Group	La description du groupe de piles. La description doit comporter entre 1 et 256 caractères.
AccountIds	Array of String	No	["151266687691**","141261387191**"]	Les ID des comptes dans lesquels vous souhaitez déployer des piles en utilisant des autorisations autogérées. Vous pouvez spécifier un maximum de 20 ID de compte.
RegionIds	Array of String	No	["cn-hangzhou","cn-beijing"]	Les ID de région des instances de pile. Vous pouvez spécifier un maximum de 20 ID de région.
TemplateBody	String	No	{"ROSTemplateFormatVersion": "2015-09-01"}	La structure contenant le corps du modèle. Le corps du modèle doit avoir une taille comprise entre 1 et 524 288 octets. Si la taille du corps du modèle dépasse la limite supérieure, nous vous recommandons d'ajouter des paramètres au corps de la requête HTTP POST pour éviter les échecs de requête causés par des URL excessivement longues. Remarque Vous devez spécifier un seul des paramètres TemplateBody, TemplateURL et TemplateId.
TemplateURL	String	No	oss://ros-template/demo	L'URL du fichier contenant le corps du modèle. L'URL doit pointer vers un modèle situé sur un serveur web HTTP ou HTTPS ou dans un compartiment Object Storage Service (OSS) Alibaba Cloud. Le corps du modèle doit avoir une taille comprise entre 1 et 524 288 octets. Exemples : oss://ros/template/demo et oss://ros/template/demo?RegionId=cn-hangzhou. Si vous ne spécifiez pas l'ID de région du compartiment OSS, la valeur du paramètre RegionId est utilisée. Remarque Vous devez spécifier un seul des paramètres TemplateBody, TemplateURL et TemplateId.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer que le jeton est unique parmi différentes requêtes. Le jeton peut comporter jusqu'à 64 caractères et contenir des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). Pour plus d'informations, consultez Assurer l'idempotence.
OperationDescription	String	No	Update stack instances in hangzhou	La description de l'opération de mise à jour du groupe de piles.
OperationPreferences	Map	No	{"FailureToleranceCount": 1,"MaxConcurrentCount": 2}	Les préférences de l'opération de mise à jour du groupe de piles. Les paramètres suivants sont disponibles : {"FailureToleranceCount": N} Le nombre maximal de comptes dans lesquels les échecs d'opération de pile sont autorisés dans chaque région. Si cette valeur est dépassée dans une région, ROS arrête l'opération dans cette région. Si ROS arrête l'opération dans une région, l'opération n'est pas effectuée dans les autres régions. Valeurs valides pour N : 0 à 20. Si vous ne spécifiez pas de valeur pour le paramètre FailureToleranceCount, la valeur par défaut 0 est utilisée. {"FailureTolerancePercentage": N} Le pourcentage de comptes dans lesquels les échecs d'opération de pile sont autorisés dans chaque région. Si cette valeur est dépassée dans une région, ROS arrête l'opération dans cette région. Valeurs valides pour N : 0 à 100. Si le nombre de comptes spécifié par le pourcentage n'est pas un nombre entier, ROS arrondit le nombre à l'entier inférieur. Si vous ne spécifiez pas de valeur pour le paramètre FailureTolerancePercentage, la valeur par défaut 0 est utilisée. {"MaxConcurrentCount": N} Le nombre maximal de comptes dans lesquels les piles peuvent être déployées simultanément dans chaque région. Valeurs valides pour N : 1 à 20. Si vous ne spécifiez pas de valeur pour le paramètre MaxConcurrentCount, la valeur par défaut 1 est utilisée. {"MaxConcurrentPercentage": N} Le pourcentage de comptes dans lesquels les piles peuvent être déployées simultanément dans chaque région. Valeurs valides pour N : 1 à 100. Si le nombre de comptes spécifié par le pourcentage n'est pas un nombre entier, ROS arrondit le nombre à l'entier inférieur. Si vous ne spécifiez pas de valeur pour le paramètre MaxConcurrentPercentage, la valeur par défaut 1 est utilisée. {"RegionConcurrencyType": N} Indique si les piles peuvent être déployées en parallèle dans plusieurs régions. Valeurs valides : SEQUENTIAL : déploie les piles dans les régions spécifiées une par une, séquentiellement. Ainsi, les piles ne sont déployées que dans une seule région à la fois. Il s'agit de la valeur par défaut. PARALLEL : déploie les piles dans toutes les régions spécifiées en parallèle. Séparez plusieurs paramètres par des virgules (,). Remarque Vous ne pouvez spécifier qu'un seul des paramètres MaxConcurrentCount et MaxConcurrentPercentage. Vous ne pouvez spécifier qu'un seul des paramètres FailureToleranceCount et FailureTolerancePercentage.
AdministrationRoleName	String	No	AliyunROSStackGroupAdministrationRole	Le nom du rôle RAM à endosser par le compte administrateur dans ROS. Ce paramètre est requis si vous souhaitez accorder des autorisations autogérées au groupe de piles. Si vous ne spécifiez pas de valeur pour ce paramètre, la valeur par défaut AliyunROSStackGroupAdministrationRole est utilisée. Vous pouvez utiliser le rôle administrateur dans ROS pour endosser le rôle d'exécution AliyunROSStackGroupExecutionRole afin d'effectuer des opérations sur les piles correspondant aux instances de pile dans le groupe de piles. Le nom doit comporter entre 1 et 64 caractères et peut contenir des lettres, des chiffres et des traits d'union (-).
ExecutionRoleName	String	No	AliyunROSStackGroupExecutionRole	Le nom du rôle RAM à endosser par le rôle administrateur AliyunROSStackGroupAdministrationRole. Ce paramètre est requis si vous souhaitez accorder des autorisations autogérées au groupe de piles. Si vous ne spécifiez pas de valeur pour ce paramètre, la valeur par défaut AliyunROSStackGroupExecutionRole est utilisée. Vous pouvez utiliser ce rôle dans ROS pour effectuer des opérations sur les piles correspondant aux instances de pile dans le groupe de piles. Le nom doit comporter entre 1 et 64 caractères et peut contenir des lettres, des chiffres et des traits d'union (-).
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	L'ID du modèle. Ce paramètre s'applique aux modèles partagés et privés. Remarque Vous devez spécifier un seul des paramètres TemplateBody, TemplateURL et TemplateId.
TemplateVersion	String	No	v1	La version du modèle. Si vous ne spécifiez pas de version, la dernière version est utilisée. Remarque Ce paramètre prend effet uniquement si le paramètre TemplateId est défini.
PermissionModel	String	No	SELF_MANAGED	Le modèle d'autorisation. Valeurs valides : SELF_MANAGED : le modèle d'autorisation autogéré. Il s'agit de la valeur par défaut. Si vous utilisez le modèle autogéré pour le groupe de piles, vous devez créer des rôles RAM pour les comptes administrateur et d'exécution, et établir une relation de confiance entre les comptes pour déployer des piles au sein du compte d'exécution. SERVICE_MANAGED : le modèle d'autorisation géré par le service. Si vous utilisez le modèle géré par le service pour le groupe de piles, ROS crée des rôles liés au service pour les comptes administrateur et d'exécution, et le compte administrateur utilise son rôle pour déployer des piles au sein du compte d'exécution. Remarque Si des instances de pile ont déjà été créées dans le groupe de piles, vous ne pouvez pas changer le mode d'autorisation du groupe de piles. Si vous souhaitez utiliser le modèle d'autorisation géré par le service pour déployer des piles, votre compte doit être le compte de gestion ou un compte administrateur délégué de votre annuaire de ressources, et la fonctionnalité d'accès approuvé doit être activée pour le compte. Pour plus d'informations, consultez Étape 1 : (Facultatif) Créer un compte administrateur délégué et Étape 2 : Activer l'accès approuvé.
AutoDeployment	Object	No		Les informations relatives aux paramètres de déploiement automatique. Remarque Ce paramètre est requis uniquement si le paramètre PermissionModel est défini sur SERVICE_MANAGED.
Enabled	Boolean	Yes	true	Indique si le déploiement automatique est activé. Valeurs valides : true : active le déploiement automatique. Si vous ajoutez un membre au dossier auquel appartient le groupe de piles après avoir activé le déploiement automatique, le groupe de piles déploie ses instances de pile au sein du membre. Si vous supprimez un membre du dossier, le groupe de piles supprime les instances de pile déployées au sein du membre. false : désactive le déploiement automatique. Après la désactivation du déploiement automatique, les instances de pile restent inchangées même si les membres du dossier changent.
RetainStacksOnAccountRemoval	Boolean	No	true	Indique si les piles doivent être conservées dans un membre lorsque vous supprimez le membre du dossier. Valeurs valides : true : conserve les piles. false : supprime les piles. Remarque Ce paramètre est requis si le paramètre Enabled est défini sur true.
DeploymentTargets	Object	No		Les dossiers dans lesquels vous souhaitez utiliser les autorisations gérées par le service pour mettre à jour les piles.
RdFolderIds	Array of String	No	["fd-4PvlVLOL8v"]	Les ID de dossier dans l'annuaire de ressources. Vous pouvez spécifier un maximum de cinq ID de dossier. Vous devez définir au moins l'un des paramètres RdFolderIds et AccountIds. Les paramètres sont soumis aux conditions suivantes : Si vous définissez uniquement le paramètre RdFolderIds, les piles sont déployées au sein de tous les membres des dossiers spécifiés. Si vous spécifiez le dossier Root, ROS déploie les piles au sein de tous les membres de l'annuaire de ressources. Si vous définissez uniquement le paramètre AccountIds, les piles sont déployées au sein des membres spécifiés. Si vous définissez les deux paramètres, les comptes spécifiés par AccountIds doivent être contenus dans les dossiers spécifiés par RdFolderIds. Remarque Pour afficher les ID de dossier, accédez à la page Overview dans la console Resource Management. Pour plus d'informations, consultez Afficher les informations de base d'un dossier.
AccountIds	Array of String	No	["151266687691**","141261387191**"]	Les ID des membres dans l'annuaire de ressources. Vous pouvez spécifier un maximum de 20 ID de membre. Remarque Pour afficher les ID de membre, accédez à la page Overview dans la console Resource Management. Pour plus d'informations, consultez Afficher les informations détaillées d'un membre.
Parameters.N.ParameterKey	String	Yes	Amount	La clé du paramètre N. Si vous ne spécifiez pas la clé et la valeur du paramètre, ROS utilise la clé et la valeur par défaut du modèle. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous définissez le paramètre Parameters, vous devez définir le paramètre Parameters.N.ParameterKey.
Parameters.N.ParameterValue	String	Yes	1	La valeur du paramètre N. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous définissez le paramètre Parameters, vous devez définir le paramètre Parameters.N.ParameterValue.

Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	L'ID de la requête.
OperationId	String	6da106ca-1784-4a6f-a7e1-e723863d****	L'ID de l'opération.

Exemples

Exemples de requêtes

http(s)://ros.aliyuncs.com/?Action=UpdateStackGroup
&TemplateBody={"ROSTemplateFormatVersion": "2015-09-01"}
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateStackGroupResponse>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <OperationId>6da106ca-1784-4a6f-a7e1-e723863d****</OperationId>
</UpdateStackGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "OperationId" : "6da106ca-1784-4a6f-a7e1-e723863d****"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.

Error code	Error message	HTTP status code	Description
CircularDependency	Circular Dependency Found: {reason}.	400	Le message d'erreur indique que le modèle contient des dépendances circulaires. reason indique la cause spécifique de l'erreur.
InvalidSchema	{reason}.	400	Le message d'erreur indique que le format du modèle est invalide. reason indique la cause spécifique de l'erreur.
InvalidTemplateAttribute	The Referenced Attribute ({resource} {name}) is incorrect.	400	Le message d'erreur indique que l'attribut de ressource référencé dans le modèle est invalide. resource indique le nom de la ressource. name indique le nom de l'attribut.
InvalidTemplatePropertyType	The specified value type of ({resource} {section}) is incorrect.	400	Le message d'erreur indique que le type de la section de ressource spécifiée définie dans le modèle est invalide. resource indique le nom de la ressource. section indique le nom de la section.
InvalidTemplateReference	The specified reference "{name}" (in {referencer}) is incorrect.	400	Le message d'erreur indique que le modèle contient une référence invalide. name indique le nom de la référence. referencer indique le nom du référençant.
InvalidTemplateSection	The template section is invalid: {section}.	400	Le message d'erreur indique que le modèle contient une section invalide. section indique le nom de la section.
InvalidTemplateVersion	The template version is invalid: {reason}.	400	Le message d'erreur indique que la version du modèle est invalide. reason indique la cause spécifique de l'erreur.
UnknownUserParameter	The Parameter ({name}) was not defined in template.	400	Le message d'erreur indique que le paramètre spécifié n'est pas défini dans le modèle. name indique le nom du paramètre.
UserParameterMissing	The Parameter {name} was not provided.	400	Le message d'erreur indique qu'aucune valeur n'a été spécifiée pour le paramètre défini dans le modèle. name indique le nom du paramètre.
StackGroupOperationInProgress	Another Operation on StackGroup ({name})s is in progress.	409	Le message d'erreur indique qu'une opération est en cours sur le groupe de piles. name indique le nom du groupe de piles.
TemplateNotFound	The Tempalte ({ ID }) could not be found.	404	Le message d'erreur indique que le modèle spécifié n'existe pas. ID indique l'ID du modèle.
TemplateNotFound	The Template { ID } with version { version } could not be found.	404	Le message d'erreur indique que le modèle ou la version de modèle spécifié n'existe pas. ID indique l'ID du modèle. version indique la version du modèle.