GetTemplate - - Centre de documentation Alibaba Cloud

Consulte les détails d'un modèle en spécifiant une pile, un groupe de piles, un ensemble de modifications ou un modèle personnalisé.

Description de l'opération

Cette rubrique fournit un exemple montrant comment consulter les détails d'un modèle dont l'identifiant est 5ecd1e10-b0e9-4389-a565-e4c15efc**** dans la région cn-hangzhou.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ros:GetTemplate

get

stack.

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

modèle.

acs:ros:*:{#accountId}:template/{#templateId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
StackId	string	Non	L'identifiant de la pile. Remarque Vous ne devez spécifier qu'un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName et TemplateId.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	Non	L'identifiant de la région de la pile ou du groupe de piles auquel le modèle appartient. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
ChangeSetId	string	Non	L'identifiant de l'ensemble de modifications. Remarque Vous ne devez spécifier qu'un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName et TemplateId.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateId	string	Non	L'identifiant du modèle. Les modèles partagés et privés sont tous deux pris en charge. Pour un modèle partagé, le TemplateId est identique au TemplateARN. Utilisez cette valeur pour la requête. Remarque Vous ne devez spécifier qu'un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName et TemplateId.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	Non	La version du modèle. Ce paramètre prend effet uniquement lorsque TemplateId est spécifié. Pour un modèle partagé, ce paramètre n'est pris en charge que lorsque VersionOption est défini sur AllVersions. Pour plus d'informations, consultez SetTemplatePermission. Valeurs valides : v1 à v65000, et Draft. Valeurs valides pour les modèles partagés : v1 à v65000.	v1
TemplateStage	string	Non	L'étape du modèle. Ce paramètre prend effet uniquement lorsque StackId, ChangeSetId ou StackGroupName est spécifié. Valeurs valides : Processed : le modèle analysé et transformé. Il s'agit de la valeur par défaut. Original : le modèle d'origine spécifié par l'utilisateur.	Processed
IncludePermission	string	Non	Indique si les informations de partage du modèle doivent être consultées. Valeurs valides : Enabled : consulte les informations de partage. Disabled : ne consulte pas les informations de partage. Il s'agit de la valeur par défaut. Remarque Seul le propriétaire du modèle peut consulter les informations de partage.	Enabled
StackGroupName	string	Non	Le nom du groupe de piles. Remarque Vous ne devez spécifier qu'un seul des paramètres suivants : StackId, ChangeSetId, StackGroupName et TemplateId.	MyStackGroup
IncludeTags	string	Non	Indique si les informations de balise doivent être consultées. Valeurs valides : Enabled : consulte les informations de balise. Disabled : ne consulte pas les informations de balise. Il s'agit de la valeur par défaut. Remarque Ce paramètre prend effet uniquement lorsque TemplateId est spécifié.	Enabled

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

Éléments de réponse

Élément	Type	Description	Exemple
	object
TemplateARN	string	L'ARN du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
Description	string	La description du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié.	ROS template for create ECS instance.
RequestId	string	L'identifiant de la requête.	B288A0BE-D927-4888-B0F7-B35EF84****
CreateTime	string	L'heure de création du modèle. L'heure est affichée au format YYYY-MM-DDThh:mm:ss. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Remarque Si TemplateVersion est spécifié, l'heure de création du modèle de la version spécifiée est renvoyée. Si TemplateVersion n'est pas spécifié, l'heure de création du modèle de la version par défaut est renvoyée.	2020-11-18T08:49:26
StackGroupName	string	Le nom du groupe de piles. Ce paramètre n'est renvoyé que lorsque StackGroupName est spécifié.	MyStackGroup
TemplateVersion	string	La version du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Si TemplateVersion n'est pas spécifié ou ne prend pas effet, ce paramètre indique la version actuelle du modèle. Pour un modèle partagé, ce paramètre n'est renvoyé que lorsque VersionOption est défini sur AllVersions.	v1
TemplateBody	string	Le contenu du modèle.	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetId	string	L'identifiant de l'ensemble de modifications. Ce paramètre n'est renvoyé que lorsque ChangeSetId est spécifié.	e85abe0c-6528-43fb-ae93-fdf8de22****
OwnerId	string	L'identifiant du compte Alibaba Cloud auquel le modèle appartient. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié.	151266687691****
UpdateTime	string	L'heure de la dernière mise à jour du modèle. L'heure est affichée au format YYYY-MM-DDThh:mm:ss. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Remarque Si TemplateVersion est spécifié, l'heure de la dernière mise à jour du modèle de la version spécifiée est renvoyée. Si TemplateVersion n'est pas spécifié, l'heure de la dernière mise à jour du modèle est renvoyée.	2020-12-07T06:11:48
Permissions	array<object>	L'état de partage du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié et que IncludePermission est défini sur Enabled. Remarque Si TemplateVersion n'est pas spécifié ou ne prend pas effet, l'état de partage du modèle est renvoyé. Si TemplateVersion est spécifié et prend effet, l'état de partage du modèle associé à la version est renvoyé.
	object
VersionOption	string	L'option de version partagée. Ce paramètre n'est renvoyé que lorsque ShareOption est défini sur ShareToAccounts. Valeurs valides : AllVersions : partage toutes les versions du modèle partagé. Latest : partage uniquement la dernière version du modèle partagé. Lorsqu'une nouvelle version est ajoutée au modèle partagé, la version partagée change en conséquence pour rester toujours la plus récente. Current : partage uniquement la dernière version actuelle du modèle partagé. Lorsqu'une nouvelle version est ajoutée au modèle partagé, la version partagée reste inchangée. Specified : partage uniquement une version spécifiée du modèle partagé.	AllVersions
AccountId	string	Le compte Alibaba Cloud avec lequel le modèle est partagé.	142437958638****
ShareOption	string	L'option de partage. Valeur valide : ShareToAccounts, ce qui indique que le modèle est partagé avec d'autres comptes Alibaba Cloud.	ShareToAccounts
TemplateVersion	string	La version du modèle partagé. Ce paramètre est renvoyé lorsque ShareOption est défini sur ShareToAccounts et que VersionOption est défini sur Specified ou Current. Lorsque le paramètre TemplateVersion est défini sur Draft, si la version Draft existe, Draft est renvoyé. Si la version Draft n'existe pas ou a été supprimée, la dernière version actuelle est renvoyée. Valeurs valides : v1 à v65000, et Draft.	v1
ShareSource	string	La source de la relation de partage. Valeurs valides : ROS : la relation de partage est établie à l'aide de la console ou de l'API ROS. ResourceDirectory : la relation de partage est établie pour les comptes d'un annuaire de ressources à l'aide de la fonctionnalité de partage de ressources dans Resource Management. Remarque Le partage depuis ROS et le partage depuis Resource Directory disposent de quotas indépendants. Le partage depuis Resource Directory ne peut pas être annulé ou remplacé à l'aide de la console ou de l'API ROS. Le partage depuis Resource Directory peut remplacer le partage depuis ROS.	ROS
TemplateName	string	Le nom du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Remarque Si TemplateVersion est spécifié, le nom du modèle associé à la version est renvoyé. Si TemplateVersion n'est pas spécifié, le nom du modèle est renvoyé.	MyTemplate
RegionId	string	L'identifiant de la région de la pile ou du groupe de piles auquel le modèle appartient. Ce paramètre n'est renvoyé que lorsque StackId, ChangeSetId ou StackGroupName est spécifié.	cn-hangzhou
TemplateId	string	L'identifiant du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Pour un modèle partagé, la valeur renvoyée est identique au TemplateARN.	a52f81be-496f-4e1c-a286-8852ab54****
StackId	string	L'identifiant de la pile. Ce paramètre n'est renvoyé que lorsque StackId est spécifié.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ShareType	string	Le type de partage du modèle. Ce paramètre n'est renvoyé que lorsque TemplateId est spécifié. Valeurs valides : Private : le modèle appartient à l'utilisateur. Shared : le modèle est partagé par un autre utilisateur.	Private
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxazb4ph6aiy****
Interface	string	La description de l'interface.	{}
Tags	array<object>	Les balises du modèle.
	object	Les balises du modèle.
Key	string	La clé de balise du modèle.	usage
Value	string	La valeur de balise du modèle.	test
AdditionalInfo	object	Les informations supplémentaires du modèle public.	{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["Other"]},"Provider":"ROS","Categories":["Solution"]}

Exemples

JSON format

{
  "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description": "Modèle ROS pour créer une instance ECS",
  "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****\t",
  "ShareType": "Private",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Interface": "{}",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "AdditionalInfo": {
    "DeploymentDuration": null,
    "Title": "Instantané_ElasticSearch_Auto-Hébergé_Enregistré_sur_OSS",
    "Labels": {
      "ResourceTypes": [
        "ALIYUN::ECS::Instance",
        "ALIYUN::ECS::SecurityGroup",
        "ALIYUN::ECS::VPC",
        "ALIYUN::ECS::VSwitch",
        "ALIYUN::OSS::Bucket",
        "ALIYUN::ROS::WaitCondition",
        "ALIYUN::ROS::WaitConditionHandle"
      ],
      "DeployTypes": [
        "ROS"
      ],
      "ApplicationScenes": [
        "other"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.