DescribeMetricRuleTemplateList - - Centre de documentation Alibaba Cloud

Consulte les modèles d'alerte.

Description de l'opération

Cette rubrique fournit un exemple de requête de modèles d'alerte. Dans cet exemple, les modèles d'alerte suivants sont renvoyés dans la réponse : ECS_Template1 et ECS_Template2.

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.

cms:DescribeMetricRuleTemplateList

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Name	string	Non	Le nom du modèle d'alerte.	ECS_Template1
Keyword	string	Non	Le mot-clé du nom du modèle d'alerte.	ECS
TemplateId	integer	Non	L'identifiant du modèle d'alerte.	70****
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page.	10
History	boolean	Non	Indique si l'historique de l'application des modèles d'alerte aux groupes d'applications doit être affiché. Valeurs valides : true false (valeur par défaut)	false
Order	boolean	Non	L'ordre de tri. Valeurs valides : true (valeur par défaut) : ordre croissant false : ordre décroissant	true
OrderBy	string	Non	Le critère de tri. Valeurs valides : gmtMotified : trie les modèles d'alerte par heure de modification gmtCreate (valeur par défaut) : trie les modèles d'alerte par heure de création	gmtCreate

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
Code	integer	Le code d'état. Remarque Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message d'erreur.	The Request is not authorization
RequestId	string	L'identifiant de la requête.	659401C0-6214-5C02-972A-CFA929D717B7
Total	integer	Le nombre total d'entrées renvoyées.	2
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true
Templates	object
Template	array<object>	Les modèles d'alerte recherchés.
	array<object>	Aucune.
Description	string	The description of the alert template.	ECS的CPU使用率
GmtCreate	integer	The timestamp when the alert template was created. Unit: milliseconds.	1646018798000
Name	string	The name of the alert template.	ECS_Template1
RestVersion	integer	The version of the alert template. Default value: 0.	0
GmtModified	integer	The timestamp when the alert template was modified. Unit: milliseconds.	1646054798000
TemplateId	integer	The ID of the alert template.	70****
ApplyHistories	object
ApplyHistory	array<object>	The history of applying the alert templates to application groups.
	object	None
GroupId	integer	The ID of the application group.	3607****
GroupName	string	The name of the application group.	ECS_Group
ApplyTime	integer	The timestamp when the alert template was applied to the application group. Unit: milliseconds.	1646055898000

Exemples

JSON format

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Success": true,
  "Templates": {
    "Template": [
      {
        "Description": "ECS的CPU使用率",
        "GmtCreate": 1646018798000,
        "Name": "ECS_Template1",
        "RestVersion": 0,
        "GmtModified": 1646054798000,
        "TemplateId": 0,
        "ApplyHistories": {
          "ApplyHistory": [
            {
              "GroupId": 0,
              "GroupName": "ECS_Group",
              "ApplyTime": 1646055898000
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.