CreateAlarm - Auto Scaling - Centre de documentation Alibaba Cloud

Crée une tâche déclenchée par événement.

Description de l'opération

Si vous créez une tâche déclenchée par événement de type surveillance personnalisée (MetricType=custom), vous devez signaler au préalable des métriques de surveillance personnalisées à CloudMonitor. Pour plus d'informations, consultez Tâches déclenchées par événement de type surveillance personnalisée.
Lorsque vous créez une tâche déclenchée par événement, vous devez spécifier une métrique de surveillance (MetricName) et utiliser les informations de dimension (Dimension.N.DimensionKey et Dimension.N.DimensionValue) pour déterminer la portée d'agrégation des données de métrique de surveillance dans le groupe de mise à l'échelle. Par exemple, vous pouvez spécifier user_id et scaling_group pour agréger les données de métrique de surveillance de toutes les instances ECS ou instances de conteneur élastique dans le groupe de mise à l'échelle de l'utilisateur spécifié.
- Les métriques de surveillance des tâches déclenchées par événement de type surveillance personnalisée (MetricType=custom) dépendent de vos métriques de surveillance personnalisées.
- Pour plus d'informations sur les métriques de surveillance prises en charge par les tâches déclenchées par événement de type surveillance système (MetricType=system), consultez Tâches déclenchées par événement de type surveillance système.

Remarque

Dans les informations de dimension, user_id et scaling_group sont automatiquement renseignés par le système. Vous devez spécifier manuellement device et state. Pour plus d'informations, consultez les paramètres Dimension.N.DimensionKey et Dimension.N.DimensionValue.

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.

ess:CreateAlarm

create

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du groupe de mise à l'échelle.	cn-hangzhou
Name	string	Non	Le nom de la tâche déclenchée par événement.	TestAlarmTask
Description	string	Non	La description de la tâche déclenchée par événement.	Tâche d'alerte de test
ScalingGroupId	string	Oui	L'identifiant du groupe de mise à l'échelle associé à la tâche déclenchée par événement.	asg-bp18p2yfxow2dloq****
MetricName	string	Non	Le nom de la métrique de surveillance. Les valeurs valides varient en fonction du type de surveillance de la tâche déclenchée par événement : Si la tâche déclenchée par événement est de type surveillance personnalisée (MetricType=custom), les valeurs valides sont vos métriques de surveillance personnalisées. Si la tâche déclenchée par événement est de type surveillance système (MetricType=system), valeurs valides : CpuUtilization : (ECS) taux d'utilisation du processeur (%). ConcurrentConnections : (ECS) nombre de connexions simultanées à une instance ECS. IntranetTx : (ECS) trafic sortant sur le réseau interne (Kbit/min). IntranetRx : (ECS) trafic entrant sur le réseau interne (Kbit/min). VpcInternetTx : (ECS) trafic sortant sur Internet (Kbit/min). VpcInternetRx : (ECS) trafic entrant sur Internet (Kbit/min). SystemDiskReadBps : (ECS) débit de lecture du disque cloud système (octet/s). SystemDiskWriteBps : (ECS) débit d'écriture du disque cloud système (octet/s). SystemDiskReadOps : (ECS) IOPS de lecture du disque cloud système (nombre/s). SystemDiskWriteOps : (ECS) IOPS d'écriture du disque cloud système (nombre/s). CpuUtilizationAgent : (Agent) taux d'utilisation du processeur (%). GpuUtilizationAgent : (Agent) taux d'utilisation du GPU (%). GpuMemoryFreeUtilizationAgent : (Agent) taux d'inoccupation de la mémoire du GPU (%). GpuMemoryUtilizationAgent : (Agent) taux d'utilisation de la mémoire du GPU (%). MemoryUtilization : (Agent) taux d'utilisation de la mémoire (%). LoadAverage : (Agent) charge moyenne du système. TcpConnection : (Agent) nombre total de connexions TCP. TcpConnection : (Agent) nombre de connexions TCP établies. PackagesNetOut : (Agent) nombre de paquets envoyés par la carte réseau interne (nombre/s). PackagesNetIn : (Agent) nombre de paquets reçus par la carte réseau interne (nombre/s). PackagesNetOut : (Agent) nombre de paquets envoyés par la carte réseau publique (nombre/s). PackagesNetIn : (Agent) nombre de paquets reçus par la carte réseau publique (nombre/s). EciPodCpuUtilization : taux d'utilisation du processeur (%). EciPodMemoryUtilization : taux d'utilisation de la mémoire (%). LoadBalancerRealServerAverageQps : (ALB) QPS moyen par serveur dans un groupe de serveurs (nombre/s). Pour plus d'informations, consultez Tâches déclenchées par événement de type surveillance système.	CpuUtilization
MetricType	string	Non	Le type de la métrique de surveillance. Valeurs valides : system : utilise les métriques système de CloudMonitor. custom : utilise les métriques personnalisées signalées à CloudMonitor.	system
Period	integer	Non	La période statistique pour les données de métrique de surveillance. Unité : secondes. Valeurs valides : 15 60 120 300 900 Remarque Seuls les groupes de mise à l'échelle de type ECS prennent en charge une période statistique de 15 secondes. Valeur par défaut : 300.	300
Statistics	string	Non	La méthode utilisée pour agréger les données de métrique de surveillance. Valeurs valides : Average : valeur moyenne. Minimum : valeur minimale. Maximum : valeur maximale. Valeur par défaut : Average.	Average
Threshold	number	Non	Le seuil des métriques de surveillance. Une alerte est déclenchée et la règle de mise à l'échelle est exécutée lorsque l'expression de seuil est satisfaite pour le nombre de fois spécifié.	80.0
ComparisonOperator	string	Non	L'opérateur de comparaison entre la valeur agrégée de la métrique de surveillance et le seuil. Ce paramètre spécifie la relation sous laquelle la condition est satisfaite. Valeurs valides : La valeur agrégée est supérieure ou égale au seuil. Valeur : >=. La valeur agrégée est inférieure ou égale au seuil. Valeur : <=. La valeur agrégée est supérieure au seuil. Valeur : >. La valeur agrégée est inférieure au seuil. Valeur : <. Valeur par défaut : >=.	>=
EvaluationCount	integer	Non	Le nombre de fois consécutives où l'expression de seuil doit être satisfaite avant que la règle de mise à l'échelle ne soit exécutée. Par exemple, le taux d'utilisation moyen du processeur doit être supérieur ou égal à 80 % pendant trois périodes statistiques consécutives. Valeur par défaut : 3.	3
GroupId	integer	Non	L'identifiant du groupe d'applications CloudMonitor auquel la métrique de surveillance personnalisée appartient. Ce paramètre est requis uniquement lorsque MetricType est défini sur custom.	4055401
Effective	string	Non	La période d'effet de la tâche déclenchée par événement. Par défaut, la tâche déclenchée par événement est effective à tout moment. Ce paramètre suit les expressions cron. Le format par défaut est `X X X X X ?`, où : X : un espace réservé pour un champ, qui représente les secondes, les minutes, les heures, le jour du mois et le mois dans l'ordre. X peut être une valeur spécifique ou un caractère spécial ayant une signification logique. Pour plus d'informations sur les valeurs valides de X, consultez Expression Cron. ? : spécifie aucune valeur. Remarque La valeur de ce paramètre est dans le fuseau horaire UTC+8 par défaut. Vous pouvez ajouter les informations de fuseau horaire `TZ=+yy` avant l'expression cron pour spécifier un fuseau horaire, où y représente la valeur numérique du fuseau horaire. Par exemple, `TZ=+00 * * 1-2 * * ?` spécifie que la tâche déclenchée par événement est effective entre 01:00 et 02:59 dans le fuseau horaire UTC+0 chaque jour. Exemples : `* * * * * ?` : effective à tout moment. `* * 17-18 * * ?` : effective entre 17:00 et 18:59 dans le fuseau horaire UTC+8 chaque jour. `TZ=+00 * * 1-2 * * ?` : effective entre 01:00 et 02:59 dans le fuseau horaire UTC+0 chaque jour.	TZ=+00 * * 1-2 * * ?
AlarmAction	array	Non	L'identifiant unique de la règle de mise à l'échelle associée à la tâche déclenchée par événement.	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
	string	Non	L'identifiant unique de la règle de mise à l'échelle associée à la tâche déclenchée par événement.	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
Dimension	array<object>	Non	La liste des dimensions associées à la métrique de surveillance.
	object	Non	La liste des dimensions associées à la métrique de surveillance.
DimensionKey	string	Non	La clé de la dimension associée à la métrique de surveillance. Les valeurs valides varient en fonction du type de surveillance de la tâche déclenchée par événement : Si la tâche déclenchée par événement est de type surveillance personnalisée (MetricType=custom), vous pouvez spécifier n'importe quelle valeur. Si la tâche déclenchée par événement est de type surveillance système (MetricType=system), valeurs valides : user_id : l'identifiant de votre compte. scaling_group : le groupe de mise à l'échelle à surveiller. device : le type de périphérique de contrôleur d'interface réseau (NIC). state : l'état de la connexion TCP. rulePool : le groupe de serveurs spécifié pour le nœud de métriques de surveillance QPS de l'ALB.	device
DimensionValue	string	Non	La valeur de la dimension associée à la métrique de surveillance. Les valeurs valides sont déterminées par Dimension.N.DimensionKey : Si Dimension.N.DimensionKey est une valeur personnalisée, ce qui signifie que la tâche déclenchée par événement est de type surveillance personnalisée (MetricType=custom), vous pouvez spécifier n'importe quelle valeur. Si Dimension.N.DimensionKey est une valeur spécifiée par le système, ce qui signifie que la tâche déclenchée par événement est de type surveillance système (MetricType=system), valeurs valides : user_id : automatiquement renseigné par le système. scaling_group : automatiquement renseigné par le système. device : eth0 : pour les instances de réseau classique, eth0 représente la carte réseau interne. Pour les instances connectées à un VPC, seule la carte réseau eth0 existe. eth1 : pour les instances de réseau classique, eth1 représente la carte réseau publique. state : TCP_TOTAL : le nombre total de connexions TCP. ESTABLISHED : le nombre de connexions TCP établies. rulePool : l'identifiant du groupe de serveurs ALB. Exemple : sgp-xxxxx.	eth0
Expression	array<object>	Non	Les informations sur les règles d'alerte multi-métriques.
	object	Non	Les informations sur les règles d'alerte multi-métriques.
MetricName	string	Non	Le nom de la métrique de surveillance dans la règle d'alerte multi-métriques. Les valeurs valides varient en fonction du type de surveillance de la tâche déclenchée par événement : Si la tâche déclenchée par événement est de type surveillance personnalisée (MetricType=custom), les valeurs valides sont vos métriques de surveillance personnalisées. Si la tâche déclenchée par événement est de type surveillance système (MetricType=system), valeurs valides : CpuUtilization : (ECS) taux d'utilisation du processeur (%). ConcurrentConnections : (ECS) nombre de connexions simultanées à une instance ECS. IntranetTx : (ECS) trafic sortant sur le réseau interne (Kbit/min). IntranetRx : (ECS) trafic entrant sur le réseau interne (Kbit/min). VpcInternetTx : (ECS) trafic sortant sur Internet (Kbit/min). VpcInternetRx : (ECS) trafic entrant sur Internet (Kbit/min). SystemDiskReadBps : (ECS) débit de lecture du disque cloud système (octet/s). SystemDiskWriteBps : (ECS) débit d'écriture du disque cloud système (octet/s). SystemDiskReadOps : (ECS) IOPS de lecture du disque cloud système (nombre/s). SystemDiskWriteOps : (ECS) IOPS d'écriture du disque cloud système (nombre/s). CpuUtilizationAgent : (Agent) taux d'utilisation du processeur (%). GpuUtilizationAgent : (Agent) taux d'utilisation du GPU (%). GpuMemoryFreeUtilizationAgent : (Agent) taux d'inoccupation de la mémoire du GPU (%). GpuMemoryUtilizationAgent : (Agent) taux d'utilisation de la mémoire du GPU (%). MemoryUtilization : (Agent) taux d'utilisation de la mémoire (%). LoadAverage : (Agent) charge moyenne du système. TcpConnection : (Agent) nombre total de connexions TCP. TcpConnection : (Agent) nombre de connexions TCP établies. PackagesNetOut : (Agent) nombre de paquets envoyés par la carte réseau interne (nombre/s). PackagesNetIn : (Agent) nombre de paquets reçus par la carte réseau interne (nombre/s). PackagesNetOut : (Agent) nombre de paquets envoyés par la carte réseau publique (nombre/s). PackagesNetIn : (Agent) nombre de paquets reçus par la carte réseau publique (nombre/s). EciPodCpuUtilization : taux d'utilisation du processeur (%). EciPodMemoryUtilization : taux d'utilisation de la mémoire (%). LoadBalancerRealServerAverageQps : (ALB) QPS moyen par serveur dans un groupe de serveurs (nombre/s). Pour plus d'informations, consultez Tâches déclenchées par événement de type surveillance système.	CpuUtilization
ComparisonOperator	string	Non	L'opérateur de comparaison entre la valeur agrégée de la métrique de surveillance et le seuil dans la règle d'alerte multi-métriques. Ce paramètre spécifie la relation sous laquelle la condition est satisfaite. Valeurs valides : La valeur agrégée est supérieure ou égale au seuil. Valeur : >=. La valeur agrégée est inférieure ou égale au seuil. Valeur : <=. La valeur agrégée est supérieure au seuil. Valeur : >. La valeur agrégée est inférieure au seuil. Valeur : <. Valeur par défaut : >=.	>=
Period	integer	Non	La période statistique pour les données de métrique de surveillance dans la règle d'alerte multi-métriques. Unité : secondes. Valeurs valides : 15 60 120 300 900 Remarque Seuls les groupes de mise à l'échelle de type ECS prennent en charge une période statistique de 15 secondes. Valeur par défaut : 300.	900
Statistics	string	Non	La méthode utilisée pour agréger les données de métrique de surveillance dans la règle d'alerte multi-métriques. Valeurs valides : Average : valeur moyenne. Minimum : valeur minimale. Maximum : valeur maximale. Valeur par défaut : Average.	Average
Threshold	number	Non	Le seuil des métriques de surveillance dans la règle d'alerte multi-métriques. Une alerte est déclenchée et la règle de mise à l'échelle est exécutée lorsque l'expression de seuil est satisfaite pour le nombre de fois spécifié.	40.0
ExpressionsLogicOperator	string	Non	La relation entre plusieurs conditions d'alerte de métriques. Valeurs valides : `&&` : une alerte est déclenchée uniquement lorsque toutes les métriques de surveillance satisfont aux conditions d'alerte. Une alerte est déclenchée uniquement lorsque toutes les expressions de la règle d'alerte multi-métriques sont évaluées à `true`. `\|\|` : une alerte est déclenchée lorsqu'une métrique de surveillance quelconque satisfait à la condition d'alerte. Valeur par défaut : `&&`.	&&

Éléments de réponse

Élément	Type	Description	Exemple
	object
AlarmTaskId	string	L'identifiant de la tâche déclenchée par événement.	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Exemples

JSON format

{
  "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.