CreateStackGroup - - Centre de documentation Alibaba Cloud

Un groupe de piles est une collection de piles Resource Orchestration Service (ROS) que vous pouvez gérer comme une unité. Vous pouvez utiliser un modèle ROS associé à un groupe de piles pour créer des piles dans plusieurs comptes Alibaba Cloud et différentes régions.

Vous pouvez créer un groupe de piles avec des autorisations gérées par l'utilisateur ou gérées par le service :

Si vous utilisez un compte Alibaba Cloud pour créer un groupe de piles géré par l'utilisateur, le compte administrateur et le compte d'exécution sont des comptes Alibaba Cloud.
Si vous activez un annuaire de ressources et utilisez le compte de gestion ou un compte administrateur délégué de cet annuaire pour créer un groupe de piles géré par le service, le compte administrateur correspond au compte de gestion ou au compte administrateur délégué, tandis que le compte d'exécution est un membre de l'annuaire de ressources.

Pour plus d'informations sur les groupes de piles, consultez la rubrique Présentation.

Cette rubrique explique comment créer un groupe de piles géré par l'utilisateur nommé MyStackGroup à l'aide d'un modèle. Dans cet exemple, l'ID du modèle est 5ecd1e10-b0e9-4389-a565-e4c15efc****. L'ID de région du groupe de piles est cn-hangzhou.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateStackGroup	L'opération à effectuer. Définissez la valeur sur CreateStackGroup.
RegionId	String	Oui	cn-hangzhou	L'ID de région du groupe de piles. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
StackGroupName	String	Oui	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	Non	StackGroup Description	La description du groupe de piles. La description doit contenir entre 1 et 256 caractères.
TemplateBody	String	Non	{"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 afin d'éviter les échecs de requête causés par des URL excessivement longues. Remarque Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL ou TemplateId.
TemplateURL	String	Non	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 Alibaba Cloud Object Storage Service (OSS), tel que oss://ros/template/demo ou oss://ros/template/demo?RegionId=cn-hangzhou. Le corps du modèle doit avoir une taille comprise entre 1 et 524 288 octets. Si vous ne spécifiez pas l'ID de région du compartiment OSS, la valeur du paramètre RegionId est utilisée. Remarque Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL ou TemplateId.
ClientToken	String	Non	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 qu'elle 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 la rubrique Garantir l'idempotence.
AdministrationRoleName	String	Non	AliyunROSStackGroupAdministrationRole	Le nom du rôle RAM que vous spécifiez pour le compte administrateur lors de la création d'un groupe de piles géré par l'utilisateur. ROS assume le rôle d'administrateur pour effectuer les opérations. Si vous ne spécifiez pas ce paramètre, la valeur par défaut AliyunROSStackGroupAdministrationRole est utilisée. ROS utilise le rôle d'administrateur pour assumer le rôle d'exécution AliyunROSStackGroupExecutionRole afin d'effectuer des opérations sur les piles du groupe de piles. Le nom doit contenir entre 1 et 64 caractères et peut inclure des lettres, des chiffres et des traits d'union (-).
ExecutionRoleName	String	Non	AliyunROSStackGroupExecutionRole	Le nom du rôle RAM que vous spécifiez pour le compte d'exécution lors de la création d'un groupe de piles géré par l'utilisateur. Le rôle d'administrateur AliyunROSStackGroupAdministrationRole assume le rôle d'exécution pour effectuer les opérations. Si vous ne spécifiez pas ce paramètre, la valeur par défaut AliyunROSStackGroupExecutionRole est utilisée. ROS assume le rôle d'exécution pour effectuer des opérations sur les piles du groupe de piles. Le nom doit contenir entre 1 et 64 caractères et peut inclure des lettres, des chiffres et des traits d'union (-).
TemplateId	String	Non	5ecd1e10-b0e9-4389-a565-e4c15efc****	L'ID du modèle. Ce paramètre s'applique aux modèles partagés et privés. Remarque Spécifiez un seul des paramètres suivants : TemplateBody, TemplateURL ou TemplateId.
TemplateVersion	String	Non	v1	La version du modèle. Si vous ne spécifiez pas ce paramètre, la dernière version est utilisée. Remarque Ce paramètre prend effet uniquement lorsque le paramètre TemplateId est spécifié.
Parameters.N.ParameterKey	String	Oui	Amount	Le nom du paramètre N. Si vous ne spécifiez pas le nom et la valeur d'un paramètre, ROS utilise le nom et la valeur par défaut définis dans le modèle. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez le paramètre Parameters, vous devez spécifier le paramètre Parameters.N.ParameterKey.
Parameters.N.ParameterValue	String	Oui	12	La valeur du paramètre N. Valeur maximale de N : 200. Remarque Le paramètre Parameters est facultatif. Si vous spécifiez le paramètre Parameters, vous devez spécifier le paramètre Parameters.N.ParameterValue.
ResourceGroupId	String	Non	rg-acfmxazb4ph6aiy****	L'ID du groupe de ressources. Si vous ne spécifiez pas ce paramètre, le groupe de piles est ajouté au groupe de ressources par défaut. Pour plus d'informations sur les groupes de ressources, consultez la section « Groupe de ressources » de la rubrique Qu'est-ce que Resource Management ?.
PermissionModel	String	Non	SELF_MANAGED	Le modèle d'autorisation. Valeur par défaut : SELF_MANAGED. Valeurs valides : SELF_MANAGED : le modèle d'autorisation géré par l'utilisateur. Si vous créez un groupe de piles géré par l'utilisateur, vous devez créer des rôles RAM dans les comptes administrateur et d'exécution et établir une relation de confiance entre les comptes. Vous pouvez ensuite déployer des piles dans le compte d'exécution. SERVICE_MANAGED : le modèle d'autorisation géré par le service. Si vous créez un groupe de piles géré par le service, 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 dans le compte d'exécution. Remarque Lorsque vous utilisez le modèle d'autorisation géré par le service pour déployer des piles, assurez-vous que votre compte est le compte de gestion ou un compte administrateur délégué dans l'annuaire de ressources et que la fonctionnalité d'accès de confiance est activée pour votre compte. Pour plus d'informations, consultez les rubriques Étape 1 : (Facultatif) Créer un compte administrateur délégué et Étape 2 : Activer l'accès de confiance.
Tags.N.Key	String	Oui	usage	La clé du tag N que vous souhaitez ajouter au groupe de piles. Remarque Le paramètre Tags est facultatif. Si vous spécifiez le paramètre Tags, vous devez spécifier le paramètre Tags.N.Key.
Tags.N.Value	String	Non	test	La valeur du tag N que vous souhaitez ajouter au groupe de piles.
AutoDeployment	Object	Non		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	Oui	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, ROS ajoute automatiquement les piles du groupe de piles à ce membre. Si vous supprimez un membre du dossier, ROS supprime automatiquement les piles de ce membre. false : désactive le déploiement automatique. Après la désactivation du déploiement automatique, les piles restent inchangées lorsque vous modifiez les membres du dossier.
RetainStacksOnAccountRemoval	Boolean	Non	true	Indique si les piles doivent être conservées au sein d'un membre lorsque vous supprimez ce 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.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	L'ID de la requête.
StackGroupId	String	2c036e78-9e82-428e-afd6-177f5d04****	L'ID du groupe de piles.

Exemples

Exemples de requêtes

http(s)://ros.aliyuncs.com/?Action=CreateStackGroup
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&PermissionModel=SELF_MANAGED
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<CreateStackGroupResponse>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <StackGroupId>2c036e78-9e82-428e-afd6-177f5d04****</StackGroupId>
</CreateStackGroupResponse>

Format JSON

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

{
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroupId" : "2c036e78-9e82-428e-afd6-177f5d04****"
}

Codes d'erreur

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

Code d'erreur	Message d'erreur	Code d'état HTTP	Description
CircularDependency	Circular Dependency Found: {reason}.	400	Le message d'erreur renvoyé indique que le modèle contient des dépendances circulaires. reason indique la cause de l'erreur.
InvalidSchema	{reason}.	400	Le message d'erreur renvoyé indique que le format du modèle n'est pas valide. reason indique la cause de l'erreur.
InvalidTemplateAttribute	The Referenced Attribute ({resource} {name}) is incorrect.	400	Le message d'erreur renvoyé indique que la propriété de ressource référencée dans la section Outputs du modèle n'est pas valide. resource indique le nom de la ressource. name indique le nom de la propriété.
InvalidTemplatePropertyType	The specified value type of ({resource} {section}) is incorrect.	400	Le message d'erreur renvoyé indique que le type de la propriété de ressource définie dans une section du modèle n'est pas valide. 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 renvoyé indique que le modèle contient une référence non valide. 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 renvoyé indique que le modèle contient une section non valide. section indique le nom de la section.
InvalidTemplateVersion	The template version is invalid: {reason}.	400	Le message d'erreur renvoyé indique que la version du modèle n'est pas valide. reason indique la cause de l'erreur.
UnknownUserParameter	The Parameter ({name}) was not defined in template.	400	Le message d'erreur renvoyé 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 renvoyé indique qu'aucune valeur n'est spécifiée pour un paramètre dans le modèle. name indique le nom du paramètre.
StackGroupExists	The StackGroup ({name}) already exists.	409	Le message d'erreur renvoyé indique qu'un groupe de piles portant le même nom existe déjà. name indique le nom du groupe de piles.
TemplateNotFound	The Tempalte ({ ID }) could not be found.	404	Le message d'erreur renvoyé indique que le modèle 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 renvoyé 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.