GetTemplate - - Centre de documentation Alibaba Cloud

Cet exemple récupère les détails d'un modèle dont l'ID est 5ecd1e10-b0e9-4389-a565-e4c15efc**** et l'ID de région est cn-hangzhou.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetTemplate	Opération à effectuer. Définissez la valeur sur GetTemplate.
StackId	String	Non	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID de la pile. Remarque Spécifiez un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName ou TemplateId.
RegionId	String	Oui	cn-hangzhou	ID de la région à laquelle appartient la pile ou le groupe de piles défini dans le modèle. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
ChangeSetId	String	Non	1f6521a4-05af-4975-afe9-bc4b45ad****	ID du jeu de modifications. Remarque Spécifiez un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName ou TemplateId.
TemplateId	String	Non	5ecd1e10-b0e9-4389-a565-e4c15efc****	ID du modèle. Ce paramètre s'applique aux modèles partagés et privés. Si le modèle est partagé, la valeur du paramètre TemplateId est identique à celle du paramètre TemplateARN. Utilisez l'ID du modèle pour interroger un modèle partagé. Remarque Spécifiez un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName ou TemplateId.
TemplateVersion	String	Non	v1	Version du modèle. Ce paramètre ne prend effet que si vous spécifiez le paramètre TemplateId. Si le modèle est partagé, spécifiez ce paramètre uniquement si vous définissez le paramètre VersionOption sur AllVersions. Valeurs valides : v1 à v100.
TemplateStage	String	Non	Processed	Étape du modèle. Ce paramètre ne prend effet que si vous spécifiez le paramètre StackId, ChangeSetId ou StackGroupName. Valeur par défaut : Processed. Valeurs valides : Processed : renvoie le modèle traité contenant les transformations. Original : renvoie le modèle original que vous avez spécifié.
IncludePermission	String	Non	Enabled	Indique s'il faut interroger les informations de partage du modèle. Valeur par défaut : Disabled. Valeurs valides : Enabled Disabled Remarque Seul le propriétaire du modèle peut interroger les informations de partage du modèle.
StackGroupName	String	Non	MyStackGroup	Nom du groupe de piles. Remarque Spécifiez un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName ou TemplateId.
IncludeTags	String	Non	Enabled	Indique s'il faut interroger les informations relatives aux tags. Valeur par défaut : Disabled. Valeurs valides : Enabled Disabled Remarque Ce paramètre ne prend effet que si vous spécifiez le paramètre TemplateId.

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
TemplateARN	String	acs:ros::151266687691:template/a52f81be-496f-4e1c-a286-8852ab54*	Alibaba Cloud Resource Name (ARN) du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié.
Description	String	ROS template for create ECS instance.	Description du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84****	ID de la requête.
CreateTime	String	2020-11-18T08:49:26	Heure de création du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Remarque Si le paramètre TemplateVersion est spécifié, l'heure de création de la version spécifiée par ce paramètre est renvoyée. Si le paramètre TemplateVersion n'est pas spécifié, l'heure de création de la version par défaut du modèle est renvoyée.
StackGroupName	String	MyStackGroup	Nom du groupe de piles. Ce paramètre n'est renvoyé que si le paramètre StackGroupName est spécifié.
TemplateVersion	String	v1	Version du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Si le paramètre TemplateVersion n'est pas spécifié ou ne prend pas effet, la valeur de ce paramètre correspond à la version par défaut du modèle. Si le modèle est partagé, ce paramètre n'est renvoyé que si le paramètre VersionOption est défini sur AllVersions.
TemplateBody	String	{"ROSTemplateFormatVersion": "2015-09-01"}	Corps du modèle.
ChangeSetId	String	e85abe0c-6528-43fb-ae93-fdf8de22****	ID du jeu de modifications. Ce paramètre n'est renvoyé que si le paramètre ChangeSetId est spécifié.
OwnerId	String	151266687691****	ID du compte Alibaba Cloud auquel appartient le modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié.
UpdateTime	String	2020-12-07T06:11:48	Dernière heure de mise à jour du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Remarque Si le paramètre TemplateVersion est spécifié, la dernière heure de mise à jour de la version spécifiée par ce paramètre est renvoyée. Si le paramètre TemplateVersion n'est pas spécifié, la dernière heure de mise à jour de la version par défaut du modèle est renvoyée.
Permissions	Array of Permission		Détails du statut de partage du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié et si le paramètre IncludePermission est défini sur Enabled. Remarque Si le paramètre TemplateVersion n'est pas spécifié ou ne prend pas effet, les détails du statut de partage de la version par défaut du modèle sont renvoyés. Si le paramètre TemplateVersion est spécifié et prend effet, les détails du statut de partage de la version spécifiée par ce paramètre sont renvoyés.
VersionOption	String	AllVersions	Option de version pour le modèle partagé. Ce paramètre n'est renvoyé que si le paramètre ShareOption est défini sur ShareToAccounts. Valeurs valides : AllVersions : toutes les versions du modèle sont partagées. Latest : seule la dernière version du modèle est partagée. Lorsque la version du modèle est mise à jour, ROS met à jour la version partagée vers la dernière version. Current : seule la version par défaut du modèle au moment de la configuration du partage est partagée. Lorsque la version du modèle est mise à jour, ROS ne met pas à jour la version partagée. Specified : seule la version spécifiée du modèle est partagée.
AccountId	String	142437958638****	ID du compte Alibaba Cloud avec lequel le modèle est partagé.
ShareOption	String	ShareToAccounts	Option de partage. La valeur est définie sur ShareToAccounts, ce qui indique que le modèle est partagé avec un ou plusieurs comptes Alibaba Cloud.
TemplateVersion	String	v1	Version du modèle partagé. Ce paramètre n'est renvoyé que si le paramètre ShareOption est défini sur ShareToAccounts et si le paramètre VersionOption est défini sur Specified ou Current. Valeurs valides : v1 à v100.
ShareSource	String	ROS	Service utilisé pour le partage de ressources. Valeurs valides : ROS : les ressources sont partagées depuis ROS via la console ROS ou en appelant l'API ROS. ResourceDirectory : les ressources sont partagées avec les comptes d'un annuaire de ressources depuis Resource Management à l'aide de la fonctionnalité de partage de ressources. Remarque Le nombre de comptes avec lesquels les ressources sont partagées depuis ROS est indépendant du nombre de comptes avec lesquels les ressources sont partagées depuis l'annuaire de ressources. Les ressources partagées depuis ROS ne peuvent pas remplacer ou écraser les ressources partagées depuis l'annuaire de ressources. Les ressources partagées depuis l'annuaire de ressources peuvent écraser les ressources partagées depuis ROS.
TemplateName	String	MyTemplate	Nom du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Remarque Si le paramètre TemplateVersion est spécifié, le nom de la version spécifiée par ce paramètre est renvoyé. Si le paramètre TemplateVersion n'est pas spécifié, le nom de la version par défaut du modèle est renvoyé.
RegionId	String	cn-hangzhou	ID de la région à laquelle appartient la pile ou le groupe de piles défini dans le modèle. Ce paramètre n'est renvoyé que si le paramètre StackId, ChangeSetId ou StackGroupName est spécifié.
TemplateId	String	a52f81be-496f-4e1c-a286-8852ab54****	ID du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Si le modèle est partagé, la valeur de ce paramètre est identique à celle du paramètre TemplateARN.
StackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	ID de la pile. Ce paramètre n'est renvoyé que si le paramètre StackId est spécifié.
ShareType	String	Private	Type de partage du modèle. Ce paramètre n'est renvoyé que si le paramètre TemplateId est spécifié. Valeurs valides : Private : le modèle ne peut être utilisé que par son propriétaire. Shared : le modèle est partagé avec d'autres utilisateurs.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	ID du groupe de ressources.
Interface	String	{}	Description de l'interface utilisateur web dans la console ROS.
Tags	Array of Tags		Tags du modèle.
Key	String	usage	Clé du tag.
Value	String	test	Valeur du tag.

Exemples

Exemple de requête

http(s)://ros.aliyuncs.com/?Action=GetTemplate
&RegionId=cn-hangzhou
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&IncludePermission=Enabled
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<GetTemplateResponse>
    <TemplateARN>acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****</TemplateARN>
    <Description>ROS template for create ECS instance.</Description>
    <RequestId>B288A0BE-D927-4888-B0F7-B35EF84****</RequestId>
    <CreateTime>2020-11-18T08:49:26</CreateTime>
    <StackGroupName>MyStackGroup</StackGroupName>
    <TemplateVersion>v1</TemplateVersion>
    <TemplateBody>{"ROSTemplateFormatVersion": "2015-09-01"}</TemplateBody>
    <ChangeSetId>e85abe0c-6528-43fb-ae93-fdf8de22****</ChangeSetId>
    <OwnerId>151266687691****</OwnerId>
    <UpdateTime>2020-12-07T06:11:48</UpdateTime>
    <Permissions>
        <VersionOption>AllVersions</VersionOption>
        <AccountId>142437958638****</AccountId>
        <ShareOption>ShareToAccounts</ShareOption>
        <TemplateVersion>v1</TemplateVersion>
        <ShareSource>ROS</ShareSource>
    </Permissions>
    <TemplateName>MyTemplate</TemplateName>
    <RegionId>cn-hangzhou</RegionId>
    <TemplateId>a52f81be-496f-4e1c-a286-8852ab54****</TemplateId>
    <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
    <ShareType>Private</ShareType>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <Interface>{}</Interface>
    <Tags>
        <Key>usage</Key>
        <Value>test</Value>
    </Tags>
</GetTemplateResponse>

JSON format

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

{
  "TemplateARN" : "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description" : "ROS template for create ECS instance.",
  "RequestId" : "B288A0BE-D927-4888-B0F7-B35EF84****",
  "CreateTime" : "2020-11-18T08:49:26",
  "StackGroupName" : "MyStackGroup",
  "TemplateVersion" : "v1",
  "TemplateBody" : "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetId" : "e85abe0c-6528-43fb-ae93-fdf8de22****",
  "OwnerId" : "151266687691****",
  "UpdateTime" : "2020-12-07T06:11:48",
  "Permissions" : {
    "VersionOption" : "AllVersions",
    "AccountId" : "142437958638****",
    "ShareOption" : "ShareToAccounts",
    "TemplateVersion" : "v1",
    "ShareSource" : "ROS"
  },
  "TemplateName" : "MyTemplate",
  "RegionId" : "cn-hangzhou",
  "TemplateId" : "a52f81be-496f-4e1c-a286-8852ab54****",
  "StackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
  "ShareType" : "Private",
  "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
  "Interface" : "{}",
  "Tags" : [ {
    "Key" : "usage",
    "Value" : "test"
  } ]
}

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
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	Message d'erreur indiquant que le jeu de modifications spécifié n'existe pas. name représente le nom ou l'ID du jeu de modifications, et stack représente le nom ou l'ID de la pile.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	Message d'erreur indiquant que le jeu de modifications spécifié n'existe pas. ID représente l'ID du jeu de modifications.
404	StackNotFound	The Stack ({name}) could not be found.	Message d'erreur indiquant que la pile n'existe pas. name représente le nom ou l'ID de la pile.
404	TemplateNotFound	The Template { ID } could not be found.	Message d'erreur indiquant que le modèle spécifié n'existe pas. ID représente l'ID du modèle.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	Message d'erreur indiquant que le modèle ou la version de modèle spécifiée n'existe pas. ID représente l'ID du modèle. version représente la version du modèle.
404	StackGroupNotFound	The StackGroup ({name}) could not be found.	Message d'erreur indiquant que le groupe de piles spécifié n'existe pas. name représente le nom du groupe de piles.