GetAutoThrottleRules - - Centre de documentation Alibaba Cloud

Consulte les règles de limitation automatique SQL d'une instance de base de données.

Description de l'opération

Avant d'appeler cette opération, prenez note des éléments suivants :

Si vous utilisez un SDK pour appeler les opérations d'API de Database Autonomy Service (DAS), vous devez définir l'identifiant de la région sur cn-shanghai.
L'instance de base de données que vous souhaitez gérer doit être de l'un des types suivants :
- ApsaraDB RDS for MySQL High-availability Edition ou Enterprise Edition exécutant MySQL 5.6, MySQL 5.7 ou MySQL 8.0
- PolarDB for MySQL Cluster Edition exécutant MySQL 5.6, MySQL 5.7 ou MySQL 8.0

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.

hdm:GetAutoThrottleRules

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ConsoleContext	string	Non	Le paramètre réservé.	None
InstanceIds	string	Non	Les identifiants des instances de base de données. Définissez ce paramètre sur un tableau JSON composé de plusieurs identifiants d'instance. Séparez les identifiants d'instance par des virgules (,). Exemple : `['Instance ID1','Instance ID2']`. Par défaut, si vous laissez ce paramètre vide, toutes les instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL a été activée dans le compte Alibaba Cloud actuel sont renvoyées. Les types d'instances de base de données suivants sont renvoyés : Instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL est actuellement activée. Instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL a été activée par le passé mais est actuellement désactivée. Les instances de base de données libérées ne sont pas incluses.	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709**']

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Code	integer	Le code d'état HTTP renvoyé.	200
Message	string	Le message renvoyé. Remarque Si la requête a réussi, Successful est renvoyé. Si la requête a échoué, un message d'erreur contenant des informations telles qu'un code d'erreur est renvoyé.	Successful
Data	object	Les données renvoyées.
TotalAutoThrottleRulesCount	integer	Le nombre de bases de données pour lesquelles la fonctionnalité de limitation automatique SQL a été activée.	3
EnableAutoThrottleCount	integer	Le nombre d'instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL est actuellement activée.	1
TurnOffAutoThrottleCount	integer	Le nombre d'instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL a été activée par le passé mais est actuellement désactivée.	1
NeverEnableAutoThrottleOrReleasedInstanceCount	integer	Le nombre d'instances de base de données qui n'existent pas ou pour lesquelles la fonctionnalité de limitation automatique SQL n'a jamais été activée. Remarque Si une instance de base de données n'existe pas, cela signifie que l'instance a été libérée ou que l'identifiant d'instance spécifié n'est pas valide.	1
EnableAutoThrottleList	array<object>	Les instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL est actuellement activée.
	object
AbnormalDuration	number	The maximum period of time during which an exception occurs when automatic SQL throttling is triggered. Unit: minutes.	2
CpuUsage	number	The CPU utilization threshold.	70
CpuSessionRelation	string	The logical relationship between the CPU utilization threshold and the maximum number of active sessions. Valid values: AND OR	AND
ActiveSessions	integer	The maximum number of active sessions.	32
MaxThrottleTime	number	The maximum throttling duration. Unit: minutes.	10
AllowThrottleStartTime	string	The start time of the throttling window. The value of this parameter is in UTC.	00:00Z
AllowThrottleEndTime	string	The end time of the throttling window. The value of this parameter is in UTC.	23:59Z
Visible	boolean	Indicates whether the automatic SQL throttling feature is enabled. Valid values: true false	true
AutoKillSession	boolean	Indicates whether abnormal SQL statements in execution are terminated at a time. Valid values: Remarque Abnormal SQL statements use the same template as the SQL statements that need to be throttled. true false	true
InstanceId	string	The database instance ID.	rm-2ze8g2am97624****
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
TurnOffAutoThrottleList	array<object>	Les instances de base de données pour lesquelles la fonctionnalité de limitation automatique SQL a été activée par le passé mais est actuellement désactivée.
	object
AbnormalDuration	number	The maximum period of time during which the automatic SQL throttling feature is triggered. Unit: minutes.	2
CpuUsage	number	The CPU utilization threshold.	80
AllowThrottleEndTime	string	The end time of the throttling window. The value of this parameter is in UTC.	23:59Z
InstanceId	string	The database instance ID.	rm-2ze9xrhze0709****
Visible	boolean	Indicates whether the automatic SQL throttling feature is enabled. Valid values: true false	false
CpuSessionRelation	string	The logical relationship between the CPU utilization threshold and the maximum number of active sessions. Valid values: AND OR	OR
AutoKillSession	boolean	Indicates whether abnormal SQL statements in execution are terminated at a time. Valid values: Remarque Abnormal SQL statements use the same template as the SQL statements that need to be throttled. true false	true
ActiveSessions	integer	The maximum number of active sessions.	64
MaxThrottleTime	number	The maximum throttling duration. Unit: minutes.	10
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
AllowThrottleStartTime	string	The start time of the throttling window. The value of this parameter is in UTC.	00:00Z
NeverEnableAutoThrottleOrReleasedInstanceIdList	array	Le nombre d'instances de base de données qui n'existent pas ou pour lesquelles la fonctionnalité de limitation automatique SQL n'a jamais été activée. Remarque Si une instance de base de données n'existe pas, cela signifie que l'instance a été libérée ou que l'identifiant d'instance spécifié n'est pas valide.
	string	L'identifiant de l'instance de base de données.	rm-2vc54m2a6pd6p****
RequestId	string	L'identifiant de la requête.	7172BECE-588A-5961-8126-C216E16B****
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true

Exemples

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoThrottleRulesCount": 3,
    "EnableAutoThrottleCount": 1,
    "TurnOffAutoThrottleCount": 1,
    "NeverEnableAutoThrottleOrReleasedInstanceCount": 1,
    "EnableAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 70,
        "CpuSessionRelation": "AND",
        "ActiveSessions": 32,
        "MaxThrottleTime": 10,
        "AllowThrottleStartTime": "00:00Z",
        "AllowThrottleEndTime": "23:59Z",
        "Visible": true,
        "AutoKillSession": true,
        "InstanceId": "rm-2ze8g2am97624****",
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 80,
        "AllowThrottleEndTime": "23:59Z",
        "InstanceId": "rm-2ze9xrhze0709****",
        "Visible": false,
        "CpuSessionRelation": "OR",
        "AutoKillSession": true,
        "ActiveSessions": 64,
        "MaxThrottleTime": 10,
        "UserId": "140692647406****",
        "AllowThrottleStartTime": "00:00Z"
      }
    ],
    "NeverEnableAutoThrottleOrReleasedInstanceIdList": [
      "rm-2vc54m2a6pd6p****"
    ]
  },
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Notes de version

Consultez Notes de version pour la liste complète.