DescribeApplicationScalingRule - - Centre de documentation Alibaba Cloud

Décrit une stratégie de mise à l'échelle automatique pour une application.

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.

sae:DescribeApplicationScalingRule

get

*All Resource

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/scale/applicationScalingRule HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Oui	L'identifiant de l'application.	a0d2e04c-159d-40a8-b240-d2f2c263****
ScalingRuleName	string	Oui	Le nom de la stratégie de mise à l'échelle automatique.	test

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les informations renvoyées.
RequestId	string	L'identifiant de la requête.	73404D3D-EE4F-4CB2-B197-5C46F6A1****
TraceId	string	L'identifiant de trace. Utilisez cet identifiant pour interroger les détails d'une requête.	0b57ff7e16243300839193068e****
Data	object	Les données renvoyées.
Timer	object	La stratégie de mise à l'échelle planifiée.
EndDate	string	The end date of a short-term scheduled scaling policy. The following list describes the valid values: If you leave both BeginDate and EndDate empty, the policy is a long-term policy. This is the default value. If you specify a date, for example, you set BeginDate to 2021-03-25 and EndDate to 2021-04-25, the policy is effective for one month.	2021-04-25
BeginDate	string	The start date of a short-term scheduled scaling policy. The following list describes the valid values: If you leave both BeginDate and EndDate empty, the policy is a long-term policy. This is the default value. If you specify a date, for example, you set BeginDate to 2021-03-25 and EndDate to 2021-04-25, the policy is effective for one month.	2021-03-25
Schedules	array<object>	The points in time when the auto scaling policy is triggered within a day.
	object	The data of a point in time.
AtTime	string	The point in time. Format: HH:mm.	08:00
TargetReplicas	integer	The target number of instances.	2
MinReplicas	integer	The minimum number of instances.	1
MaxReplicas	integer	The maximum number of instances.	10
Period	string	The period in which the scheduled scaling policy is executed. Valid values: *** * **: The policy is executed at a specified time every day. * Fri,Mon: The policy is executed at a specified time on one or more days of a week. You can select multiple days. The time is in GMT+8. Valid values: Sun: Sunday Mon: Monday Tue: Tuesday Wed: Wednesday Thu: Thursday Fri: Friday Sat: Saturday 1,2,3,28,31 * *: The policy is executed at a specified time on one or more days of a month. You can select multiple days. The value can be an integer from 1 to 31. If a month does not have a 31st day, the policy is not executed on that day.	* * *
UpdateTime	integer	L'heure à laquelle la stratégie de mise à l'échelle automatique a été mise à jour. Unité : millisecondes.	1624330075827
AppId	string	L'identifiant de l'application.	a0d2e04c-159d-40a8-b240-d2f2c263****
CreateTime	integer	L'heure à laquelle la stratégie de mise à l'échelle automatique a été créée. Unité : millisecondes.	1624329843790
LastDisableTime	integer	L'heure à laquelle la stratégie de mise à l'échelle automatique a été désactivée pour la dernière fois.	1641882854484
ScaleRuleEnabled	boolean	Indique si la stratégie de mise à l'échelle automatique est activée. Valeurs valides :\n\n- true : la stratégie est activée.\n\n- false : la stratégie est désactivée.	true
ScaleRuleType	string	Le type de la stratégie de mise à l'échelle automatique. Valeurs valides : timing : mise à l'échelle planifiée. metric : mise à l'échelle basée sur des métriques. mix : mise à l'échelle hybride.	timing
Metric	object	La stratégie de mise à l'échelle basée sur des métriques.
Metrics	array<object>	The list of metric-based scaling policies.
	object	The metric data.
MetricTargetAverageUtilization	integer	The target value of the metric. The target CPU utilization. Unit: percent. The target memory usage. Unit: percent. The number of queries per second (QPS). The response time. Unit: milliseconds. The average number of active TCP connections per second. The QPS of a public-facing SLB instance. The response time of a public-facing SLB instance. Unit: milliseconds. The QPS of a private SLB instance. The response time of a private SLB instance. Unit: milliseconds.	20
MetricType	string	The metric that is used to trigger the auto scaling policy. Valid values: CPU: CPU utilization. MEMORY: memory usage. QPS: the average QPS of a single instance of a Java application in one minute. RT: the average response time (RT) of all service interfaces of a Java application in one minute. tcpActiveConn: the average number of active TCP connections of a single instance in 30 seconds. SLB_QPS: the average QPS of a single instance for a public-facing SLB instance in 15 seconds. SLB_RT: the average RT of a public-facing SLB instance in 15 seconds. INTRANET_SLB_QPS: the average QPS of a single instance for a private SLB instance in 15 seconds. INTRANET_SLB_RT: the average RT of a private SLB instance in 15 seconds.	CPU
SlbProject	string	The SLB access log Project.	test
SlbLogstore	string	The SLB access log Logstore.	test
Vport	string	The port of the SLB instance.	80
SlbId	string	The ID of the SLB instance.	lb-xxx
MetricsStatus	object	The status of the metric-based scaling policy.
DesiredReplicas	integer	The target number of instances.	2
NextScaleTimePeriod	integer	The period of the next metric-based scaling.	3
CurrentReplicas	integer	The current number of instances.	2
LastScaleTime	string	The time of the last scaling activity.	2022-01-11T08:14:32Z
CurrentMetrics	array<object>	The data of the current metric-based scaling.
	object	The metric data.
Type	string	The type of the metric. This parameter is associated with the monitoring metric. Resource: the metric value of cpu or memory. Pods: the metric value of tcpActiveConn. External: the metric value of arms or slb.	Resource
CurrentValue	integer	The current value.	0
Name	string	The name of the metric. cpu: CPU utilization. memory: memory usage. arms_incall_qps: the average QPS of a single instance of a Java application in one minute. arms_incall_rt: the average RT of all service interfaces of a Java application in one minute. tcpActiveConn: the number of active TCP connections. slb_incall_qps: the QPS of a public-facing SLB instance. slb_incall_rt: the RT of a public-facing SLB instance. intranet_slb_incall_qps: the QPS of a private SLB instance. intranet_slb_incall_rt: the RT of a private SLB instance.	cpu
NextScaleMetrics	array<object>	The list of metrics for the next scaling activity.
	object	The metric data.
NextScaleOutAverageUtilization	integer	The metric threshold for the next scale-out. The value is a percentage.	21
NextScaleInAverageUtilization	integer	The metric threshold for the next scale-in. The value is a percentage.	10
Name	string	The name of the metric. cpu: CPU utilization. memory: memory usage. arms_incall_qps: the average QPS of a single instance of a Java application in one minute. arms_incall_rt: the average RT of all service interfaces of a Java application in one minute. tcpActiveConn: the number of active TCP connections. slb_incall_qps: the QPS of a public-facing SLB instance. slb_incall_rt: the RT of a public-facing SLB instance. intranet_slb_incall_qps: the QPS of a private SLB instance. intranet_slb_incall_rt: the RT of a private SLB instance.	cpu
MaxReplicas	integer	The maximum number of instances.	3
MinReplicas	integer	The minimum number of instances.	1
ScaleUpRules	object	The scale-out rules.
Step	integer	The scaling step size for scale-outs. The maximum number of instances that can be added at a time.	100
StabilizationWindowSeconds	integer	The cooldown period for scale-outs. The value can be an integer from 0 to 3600. Unit: seconds. Default value: 0.	300
Disabled	boolean	Indicates whether scale-in is disabled. Valid values: true: enabled. false: disabled. Remarque If you enable this feature, the application is never scaled in. This prevents business risks that are caused by scale-ins during peak hours. By default, this feature is disabled.	false
ScaleDownRules	object	The scale-in rules.
Step	integer	The scaling step size for scale-ins. The maximum number of instances that can be removed at a time.	100
StabilizationWindowSeconds	integer	The cooldown period for scale-ins. The value can be an integer from 0 to 3600. Unit: seconds. Default value: 0.	300
Disabled	boolean	Indicates whether scale-in is disabled. Valid values: true: enabled. false: disabled. Remarque If you enable this feature, the application is never scaled in. This prevents business risks that are caused by scale-ins during peak hours. By default, this feature is disabled.	false
ScaleRuleName	string	Le nom de la stratégie de mise à l'échelle automatique.	test
MinReadyInstances	integer	Le nombre minimum d'instances prêtes. Valeurs valides : Si vous définissez ce paramètre sur 0, l'application est interrompue lors d'une mise à niveau. Si vous définissez ce paramètre sur -1, le système utilise une valeur recommandée pour le nombre minimum d'instances prêtes. Cette valeur correspond à 25 % du nombre actuel d'instances. Par exemple, si le nombre actuel d'instances est de 5, le nombre minimum d'instances prêtes est de 2 après l'arrondi à l'entier supérieur de 5 × 25 % = 1,25. Remarque Définissez le nombre minimum d'instances prêtes sur une valeur supérieure ou égale à 1 pour chaque déploiement par roulement afin de garantir la continuité de service.	1
MinReadyInstanceRatio	integer	Le pourcentage du nombre minimal d'instances prêtes. Valeurs valides : -1 : une valeur initiale, qui indique qu'aucun pourcentage n'est utilisé. 0 à 100 : un pourcentage arrondi à l'entier supérieur. Par exemple, si vous définissez ce paramètre sur 50 % et que le nombre actuel d'instances est de 5, le nombre minimal d'instances prêtes est de 3. Remarque Si vous spécifiez à la fois MinReadyInstances et MinReadyInstanceRatio, et que la valeur de MinReadyInstanceRatio n'est pas -1, la valeur de MinReadyInstanceRatio prévaut. Par exemple, si MinReadyInstances est défini sur 5 et que MinReadyInstanceRatio est défini sur 50, la valeur 50 est utilisée pour calculer le nombre minimal d'instances prêtes.	-1
Message	string	Les informations supplémentaires. Valeurs valides : Si la requête aboutit, success est renvoyé. Si la requête échoue, un code d'erreur spécifique est renvoyé.	success
ErrorCode	string	Le code d'erreur. Valeurs valides : Si la requête aboutit, le champ ErrorCode n'est pas renvoyé. Si la requête échoue, le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Code	string	Le code d'état HTTP ou un code d'erreur POP. Valeurs valides : 2xx : L'opération a réussi. 3xx : Une redirection est requise. 4xx : Une erreur de requête s'est produite. 5xx : Une erreur de serveur s'est produite.	200
Success	boolean	Indique si l'instance d'application a été redémarrée avec succès. true : Le redémarrage a réussi. false : Le redémarrage a échoué.	true

Exemples

JSON format

{
  "RequestId": "73404D3D-EE4F-4CB2-B197-5C46F6A1****",
  "TraceId": "0b57ff7e16243300839193068e****",
  "Data": {
    "Timer": {
      "EndDate": "2021-04-25",
      "BeginDate": "2021-03-25",
      "Schedules": [
        {
          "AtTime": "08:00",
          "TargetReplicas": 2,
          "MinReplicas": 1,
          "MaxReplicas": 10
        }
      ],
      "Period": "* * *"
    },
    "UpdateTime": 1624330075827,
    "AppId": "a0d2e04c-159d-40a8-b240-d2f2c263****",
    "CreateTime": 1624329843790,
    "LastDisableTime": 1641882854484,
    "ScaleRuleEnabled": true,
    "ScaleRuleType": "timing",
    "Metric": {
      "Metrics": [
        {
          "MetricTargetAverageUtilization": 20,
          "MetricType": "CPU",
          "SlbProject": "test",
          "SlbLogstore": "test",
          "Vport": "80",
          "SlbId": "lb-xxx"
        }
      ],
      "MetricsStatus": {
        "DesiredReplicas": 2,
        "NextScaleTimePeriod": 3,
        "CurrentReplicas": 2,
        "LastScaleTime": "2022-01-11T08:14:32Z",
        "CurrentMetrics": [
          {
            "Type": "Resource",
            "CurrentValue": 0,
            "Name": "cpu"
          }
        ],
        "NextScaleMetrics": [
          {
            "NextScaleOutAverageUtilization": 21,
            "NextScaleInAverageUtilization": 10,
            "Name": "cpu"
          }
        ]
      },
      "MaxReplicas": 3,
      "MinReplicas": 1,
      "ScaleUpRules": {
        "Step": 100,
        "StabilizationWindowSeconds": 300,
        "Disabled": false
      },
      "ScaleDownRules": {
        "Step": 100,
        "StabilizationWindowSeconds": 300,
        "Disabled": false
      }
    },
    "ScaleRuleName": "test",
    "MinReadyInstances": 1,
    "MinReadyInstanceRatio": -1
  },
  "Message": "success",
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.