ListTemplates - - Centre de documentation Alibaba Cloud

Consulte les modèles. Prend en charge plusieurs méthodes de filtrage.

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.

oos:ListTemplates

get

Template.

acs:oos:{#regionId}:{#accountId}:template/*

Template.

acs:oos:{#regionId}:{#accountId}:template/{#templateName}

oos:tag
oos:TLSVersion

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou
TemplateName	string	Non	Le nom du modèle. Tous les modèles dont le nom contient le nom de modèle spécifié sont renvoyés.	MyTemplate
TemplateFormat	string	Non	Le format du modèle. Valeurs valides : JSON YAML	YAML
ShareType	string	Non	Le type de partage. Valeurs valides : Public Private	Private
CreatedBy	string	Non	Le créateur du modèle. Pour les modèles officiels fournis par Alibaba Cloud, la valeur est ACS. Pour les modèles créés par les utilisateurs, vous pouvez spécifier un UID ou un nom d'utilisateur pour filtrer les modèles.	ACS
CreatedDateBefore	string	Non	Filtre les modèles dont l'heure de création est antérieure ou égale à l'heure spécifiée. Format : YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
CreatedDateAfter	string	Non	Filtre les modèles dont l'heure de création est postérieure ou égale à l'heure spécifiée. Format : YYYY-MM-DDThh:mm:ssZ	2019-05-16T10:26:14Z
Tags	object	Non	Les balises sous forme de paires clé-valeur. Le nombre de paires clé-valeur est compris entre 1 et 20.	{"k1":"k2","k2":"v2"}
Category	string	Non	La catégorie du modèle, telle que TimerTrigger, EventTrigger, AlarmTrigger ou Other.	TimerTrigger
MaxResults	integer	Non	Le nombre d'entrées par page. Valeurs valides : 10 à 100. Valeur par défaut : 50.	50
NextToken	string	Non	Le jeton utilisé pour récupérer la page de résultats suivante. Cette valeur est obtenue à partir de la réponse de la page actuelle si d'autres résultats sont disponibles.	xxx
SortField	string	Non	Le champ utilisé pour trier les résultats de la requête. Valeurs valides : TotalExecutionCount (par défaut) : nombre total d'exécutions Popularity : popularité TemplateName : nom du modèle CreatedDate : heure de création UpdatedDate : heure de mise à jour	Popularity
SortOrder	string	Non	L'ordre de tri. Valeurs valides : Ascending : ordre croissant Descending (par défaut) : ordre décroissant	Descending
HasTrigger	boolean	Non	Indique si le modèle possède un déclencheur.	true
TemplateType	string	Non	Le type de modèle. Valeurs valides : Automation : automatisation State : inventaire de configuration Package : package logiciel Valeurs valides : Automation : Automation. State : State. Package : Package.	Automation
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmxsn4m4******
IsFavorite	boolean	Non	Indique si le modèle est ajouté aux favoris.	true
IsExample	boolean	Non	Indique si le modèle est un modèle d'exemple.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton utilisé pour récupérer la page de résultats suivante. Cette valeur est obtenue à partir de la réponse de la page actuelle si d'autres résultats sont disponibles.	xxx
RequestId	string	L'identifiant de la requête.	BEF54BA-17B6-449F-A219-49ACB157E3
MaxResults	integer	Le nombre d'entrées par page.	50
Templates	array<object>	Les métadonnées du modèle.
	array<object>
Hash	string	Le hachage SHA-256 du contenu du modèle.	4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4
UpdatedDate	string	L'heure de la dernière mise à jour du modèle.	2019-05-16T10:26:14Z
UpdatedBy	string	L'utilisateur qui a effectué la dernière mise à jour du modèle.	root(13092000)
TemplateType	string	Le type de modèle.	private
Tags	object	Les balises sous forme de paires clé-valeur. Le nombre de paires clé-valeur est compris entre 1 et 20.	{"k1":"v1","k2":"v2"}
TemplateName	string	Le nom du modèle.	MyTemplate
TemplateVersion	string	La version du modèle, au format « v » suivi d'un nombre commençant par 1.	v1
TemplateFormat	string	Le format du modèle. Le système détermine le format, qui est JSON ou YAML.	JSON
Popularity	integer	La popularité du modèle public. La valeur est comprise entre 1 et 10. Une valeur plus élevée indique une plus grande popularité. Si ShareType est Private, la valeur de ce champ est `-1`. Remarque Ce champ n'est significatif que lorsque ShareType est Public.	8
TotalExecutionCount	integer	Le nombre total d'exécutions pour le modèle privé. Si ShareType est Public, la valeur de ce champ est `-1`. Remarque Ce champ n'est significatif que lorsque ShareType est Private.	5
Description	string	La description du modèle.	Décrire les instances d'un état donné
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmxsn4m4******
CreatedBy	string	Le créateur du modèle.	root(1309200)
CreatedDate	string	L'heure de création du modèle.	2019-05-16T10:26:14Z
Category	string	Le type de modèle.	TimerTrigger
HasTrigger	boolean	Indique si le modèle a été déclenché avec succès.	true
TemplateId	string	L'identifiant du modèle.	t-94753deed38
ShareType	string	Le type de partage du modèle. Les modèles créés par les utilisateurs ont un type de partage Private. Valeurs valides : Public Private	Public
IsFavorite	boolean	Indique si le modèle est ajouté aux favoris.	true
Publisher	string	L'éditeur.	aliyun
Constraints	string	Les contraintes.	{ "InstanceTypeFamilies": ["ecs.g8y", "ecs.c8y"], "ImageTypes": ["system"], "OSPlatforms": ["CentOS", "Ubuntu"], "OSVersions": ["CentOS7.9 64bit"] }
VersionName	string	Le nom de la version.	3

Exemples

JSON format

{
  "NextToken": "xxx",
  "RequestId": "BEF54BA-17B6-449F-A219-49ACB157E3",
  "MaxResults": 50,
  "Templates": [
    {
      "Hash": "4bc7d7a21b3e003434b9c223f6e6d2578b5ebfeb5be28c1fcf8a8a1b11907bb4",
      "UpdatedDate": "2019-05-16T10:26:14Z",
      "UpdatedBy": "root(13092000)",
      "TemplateType": "private",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "TemplateName": "MyTemplate",
      "TemplateVersion": "v1",
      "TemplateFormat": "JSON",
      "Popularity": 8,
      "TotalExecutionCount": 5,
      "Description": "Décrire les instances d'un état donné",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(1309200)",
      "CreatedDate": "2019-05-16T10:26:14Z",
      "Category": "TimerTrigger",
      "HasTrigger": true,
      "TemplateId": "t-94753deed38",
      "ShareType": "Public",
      "IsFavorite": true,
      "Publisher": "aliyun",
      "Constraints": "{\n  \"InstanceTypeFamilies\": [\"ecs.g8y\", \"ecs.c8y\"],\n  \"ImageTypes\": [\"system\"],\n  \"OSPlatforms\": [\"CentOS\", \"Ubuntu\"],\n  \"OSVersions\": [\"CentOS7.9 64bit\"]\n}",
      "VersionName": "3"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.