CreateTemplate - - Centre de documentation Alibaba Cloud

Cette rubrique explique comment créer un modèle. Dans cet exemple, un modèle nommé MyTemplate est créé dans la région China (Hangzhou). Le paramètre TemplateBody est défini sur {"ROSTemplateFormatVersion": "2015-09-01"}.

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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateTemplate	Opération à effectuer. Définissez la valeur sur CreateTemplate.
TemplateURL	String	Non	oss://ros/template/demo	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 bucket Alibaba Cloud Object Storage Service (OSS), par exemple oss://ros/stack-policy/demo ou oss://ros/stack-policy/demo?RegionId=cn-hangzhou. La taille du corps du modèle doit être comprise entre 1 et 1 024 octets. Si vous ne spécifiez pas la région du bucket OSS, la valeur du paramètre RegionId est utilisée. Remarque Vous devez spécifier le paramètre TemplateBody ou TemplateURL.
Description	String	Non	It is a demo.	Description du modèle. Elle peut contenir jusqu'à 256 caractères.
TemplateBody	String	Non	{"ROSTemplateFormatVersion":"2015-09-01"}	Structure contenant le corps du modèle. La taille du corps du modèle doit être 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 Vous devez spécifier le paramètre TemplateBody ou TemplateURL. Vous pouvez créer un modèle Terraform en fonction de vos besoins métier. L'exemple de code suivant illustre la création d'un modèle Terraform : `{ "ROSTemplateFormatVersion": "2015-09-01", "Transform": "Aliyun::Terraform-v1.0", "Workspace": { "main.tf": "variable \"name\" { default = \"auto_provisioning_group\"}" }, "Outputs": {} }` Pour plus d'informations sur les modèles Terraform, consultez la page Structure des modèles Terraform.
TemplateName	String	Oui	MyTemplate	Nom du modèle. Le nom peut contenir jusqu'à 255 caractères, y compris des chiffres, des lettres, des traits d'union (-) et des traits de soulignement (_). Il doit commencer par un chiffre ou une lettre.
ResourceGroupId	String	Non	rg-acfmxazb4ph6aiy****	ID du groupe de ressources. Pour plus d'informations sur les groupes de ressources, consultez la section « Groupe de ressources » de la page Présentation de Resource Management.
Tags.N.Key	String	Oui	usage	Clé du tag N à ajouter au modèle. Remarque Le paramètre Tags est facultatif. Si vous spécifiez le paramètre Tags, vous devez également spécifier le paramètre Tags.N.Key.
Tags.N.Value	String	Non	test	Valeur du tag N à ajouter au modèle.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	8C5D90E1-66B6-496C-9371-3807F8DA80A8	ID de la requête.
TemplateId	String	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID du modèle.

Exemples

Exemples de requêtes

http(s)://ros.aliyuncs.com/?Action=CreateTemplate
&TemplateName=MyTemplate
&TemplateBody={"ROSTemplateFormatVersion":"2015-09-01"}
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<CreateTemplateResponse>
        <RequestId>8C5D90E1-66B6-496C-9371-3807F8DA80A8</RequestId>
        <TemplateId>5ecd1e10-b0e9-4389-a565-e4c15efc****</TemplateId>
</CreateTemplateResponse>

JSON format

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

{
  "RequestId" : "8C5D90E1-66B6-496C-9371-3807F8DA80A8",
  "TemplateId" : "5ecd1e10-b0e9-4389-a565-e4c15efc****"
}

Codes d'erreur

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

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidSchema	{reason}.	Le message d'erreur indique que le format du modèle n'est pas valide. reason indique la cause de l'erreur.
400	InvalidTemplateAttribute	The Referenced Attribute ({resource} {name}) is incorrect.	Le message d'erreur indique que le modèle contient une référence non valide à la propriété de ressource dans la section Outputs. resource indique le nom de la ressource. name indique le nom de la propriété.
400	InvalidTemplatePropertyType	The specified value type of ({resource} {section}) is incorrect.	Le message d'erreur 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.
400	InvalidTemplateReference	The specified reference "{name}" (in {referencer}) is incorrect.	Le message d'erreur 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érent.
400	InvalidTemplateSection	The template section is invalid: {section}.	Le message d'erreur indique que le modèle contient une section non valide. section indique le nom de la section.
400	InvalidTemplateVersion	The template version is invalid: {reason}.	Le message d'erreur indique que la version du modèle n'est pas valide. reason indique la cause de l'erreur.