DescribeSQLPatterns - - Centre de documentation Alibaba Cloud

Obtient les modèles SQL d'un cluster AnalyticDB for MySQL pour une plage de dates spécifiée.

Description de l'opération

Point de terminaison public global : adb.aliyuncs.com.
Point de terminaison public régional : adb.<region-id>.aliyuncs.com. Par exemple : adb.cn-hangzhou.aliyuncs.com.
Point de terminaison VPC régional : adb-vpc.<region-id>.aliyuncs.com. Par exemple : adb-vpc.cn-hangzhou.aliyuncs.com.

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.

adb:DescribeSQLPatterns

list

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster. Remarque Vous pouvez appeler l'opération DescribeDBClusters pour obtenir les détails, y compris les identifiants des clusters, de tous les clusters AnalyticDB for MySQL dans une région spécifique.	am-bp1r053byu48p****
StartTime	string	Oui	Le début de la plage de temps à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque Vous pouvez interroger les données des 14 derniers jours uniquement. Par exemple, si l'heure actuelle est 2021-11-22T12:00:00Z, l'heure la plus ancienne que vous pouvez interroger est 2021-11-09T12:00:00Z. L'intervalle entre l'heure de début et l'heure de fin ne peut pas dépasser 24 heures.	2021-09-30T00:10:00Z
EndTime	string	Oui	La fin de la plage de temps à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque L'heure de fin doit être postérieure à l'heure de début.	2021-09-30T00:15:00Z
RegionId	string	Oui	L'identifiant de la région. Remarque Vous pouvez appeler l'opération DescribeRegions pour obtenir les régions et zones de disponibilité disponibles pour AnalyticDB for MySQL, y compris les identifiants de région.	cn-hangzhou
Keyword	string	Non	Le mot-clé pour filtrer les modèles SQL.	SELECT
Order	string	Oui	Indique comment trier les résultats de la requête. Définissez ce paramètre sur une chaîne JSON. Exemple : [{"Field":"AverageQueryTime","Type":"Asc"}]. La chaîne JSON contient les champs suivants : `Field` : le champ de tri. Valeurs valides : `PatternCreationTime` : l'heure de soumission la plus ancienne du modèle SQL dans la plage de temps spécifiée. `AverageQueryTime` : le temps de requête total moyen du modèle SQL dans la plage de temps spécifiée. `MaxQueryTime` : le temps de requête total maximum du modèle SQL dans la plage de temps spécifiée. `AverageExecutionTime` : le temps d'exécution moyen du modèle SQL dans la plage de temps spécifiée. `MaxExecutionTime` : le temps d'exécution maximum du modèle SQL dans la plage de temps spécifiée. `AveragePeakMemory` : l'utilisation moyenne de la mémoire de crête du modèle SQL dans la plage de temps spécifiée. `MaxPeakMemory` : l'utilisation maximale de la mémoire de crête du modèle SQL dans la plage de temps spécifiée. `AverageScanSize` : la quantité moyenne de données analysées par le modèle SQL dans la plage de temps spécifiée. `MaxScanSize` : la quantité maximale de données analysées par le modèle SQL dans la plage de temps spécifiée. `QueryCount` : le nombre de fois que le modèle SQL est exécuté dans la plage de temps spécifiée. `FailedCount` : le nombre d'exécutions échouées pour le modèle SQL dans la plage de temps spécifiée. `Type` : l'ordre de tri. Valeurs valides (insensibles à la casse) : `Asc` : ordre croissant. `Desc` : ordre décroissant.	[{"Field":"AverageQueryTime","Type":"Asc"}]
PageNumber	integer	Non	Le numéro de page. La valeur doit être un entier supérieur à 0. Remarque La valeur par défaut est 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30 50 100 Remarque La valeur par défaut est 30.	30
Lang	string	Non	La langue de la réponse. Ce paramètre est utilisé pour localiser les messages tels que les détails des erreurs. Valeurs valides : zh : chinois simplifié (par défaut) en : anglais ja : japonais zh-tw : chinois traditionnel	zh
UserName	string	Non	Le nom d'utilisateur utilisé pour filtrer les modèles SQL. Si vous spécifiez ce paramètre, seuls les modèles SQL de l'utilisateur spécifié sont renvoyés.	test_user
SqlPatternHash	integer	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées pour la requête.
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées renvoyées par page.	30
TotalCount	integer	Le nombre total d'entrées renvoyées.	1
PatternDetails	array<object>	Les détails des modèles SQL.
	object	Les détails d'un modèle SQL.
SQLPattern	string	L'instruction du modèle SQL.	SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
PatternId	string	L'identifiant du modèle SQL.	5575924945138******
User	string	Le nom d'utilisateur de la base de données qui a soumis les instructions SQL correspondant à ce modèle.	reporter
AccessIp	string	L'adresse IP du client à partir de laquelle les instructions SQL correspondant à ce modèle ont été soumises.	192.168.xx.xx
Tables	string	La table de base de données analysée par les requêtes de ce modèle.	tpch.orders
PatternCreationTime	string	L'heure la plus ancienne à laquelle une requête correspondant à ce modèle a été soumise dans la plage de temps spécifiée. L'heure est au format `YYYY-MM-DD HH:MM:SS`.	2021-11-12 03:06:00
AverageQueryTime	number	Le temps de requête moyen pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en millisecondes.	4
MaxQueryTime	integer	Le temps de requête maximum pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en millisecondes.	2341
AverageExecutionTime	number	Le temps d'exécution moyen pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en millisecondes.	234.78
MaxExecutionTime	integer	Le temps d'exécution maximum pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en millisecondes.	2142
AveragePeakMemory	number	L'utilisation moyenne de la mémoire de crête pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en octets.	234.22
MaxPeakMemory	integer	L'utilisation maximale de la mémoire de crête pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en octets.	234149
AverageScanSize	number	La taille moyenne d'analyse des données pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en octets.	234149.23
MaxScanSize	integer	La taille maximale d'analyse des données pour les instructions correspondant à ce modèle SQL dans la plage de temps spécifiée, en octets.	234149
QueryCount	integer	Le nombre d'exécutions pour les instructions correspondant à ce modèle dans la plage de temps spécifiée.	345
FailedCount	integer	Le nombre d'exécutions échouées pour les instructions correspondant à ce modèle dans la plage de temps spécifiée.	234
Blockable	boolean	Indique si les requêtes correspondant à ce modèle peuvent être bloquées. Valeurs valides : true : le modèle SQL peut être bloqué. false : le modèle SQL ne peut pas être bloqué. Remarque AnalyticDB for MySQL prend en charge le blocage uniquement pour les instructions `SELECT` et `INSERT`.	true
QueryTimeSum	number	Le temps de requête total pour les instructions correspondant à ce modèle, en millisecondes.	5
QueryTimePercentage	number	Le pourcentage du temps de requête total de tous les modèles consommé par les requêtes de ce modèle.	10
PeakMemorySum	number	La mémoire de crête totale utilisée par les instructions correspondant à ce modèle, en octets.	5
PeakMemoryPercentage	number	Le pourcentage de l'utilisation totale de la mémoire de crête de tous les modèles consommé par les requêtes de ce modèle.	10
ScanSizeSum	number	La taille totale d'analyse des données pour les instructions correspondant à ce modèle, en octets.	5
ScanSizePercentage	number	Le pourcentage de la taille totale d'analyse des données de tous les modèles consommé par les requêtes de ce modèle.	80
AverageOperatorCost	number	Le coût CPU moyen pour les instructions correspondant à ce modèle, en millisecondes.	5
MaxOperatorCost	number	Le coût CPU maximum pour les instructions correspondant à ce modèle, en millisecondes.	5
OperatorCostSum	number	Le coût CPU total pour les instructions correspondant à ce modèle, en millisecondes.	5
OperatorCostPercentage	number	Le pourcentage du coût CPU total de tous les modèles consommé par les requêtes de ce modèle.	20
AverageScanCost	number	Le coût CPU moyen des analyses de tables pour les instructions correspondant à ce modèle, en millisecondes.	5
MaxScanCost	number	Le coût CPU maximum des analyses de tables pour les instructions correspondant à ce modèle, en millisecondes.	5
ScanCostSum	number	Le coût CPU total des analyses de tables pour les instructions correspondant à ce modèle, en millisecondes.	5
ScanCostPercentage	number	Le pourcentage du coût CPU total de toutes les analyses de tables consommé par les requêtes de ce modèle.	5
RequestId	string	L'identifiant de la requête.	6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******

Exemples

JSON format

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "PatternDetails": [
    {
      "SQLPattern": "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
      "PatternId": "5575924945138******",
      "User": "reporter",
      "AccessIp": "192.168.xx.xx",
      "Tables": "tpch.orders",
      "PatternCreationTime": "2021-11-12 03:06:00",
      "AverageQueryTime": 4,
      "MaxQueryTime": 2341,
      "AverageExecutionTime": 234.78,
      "MaxExecutionTime": 2142,
      "AveragePeakMemory": 234.22,
      "MaxPeakMemory": 234149,
      "AverageScanSize": 234149.23,
      "MaxScanSize": 234149,
      "QueryCount": 345,
      "FailedCount": 234,
      "Blockable": true,
      "QueryTimeSum": 5,
      "QueryTimePercentage": 10,
      "PeakMemorySum": 5,
      "PeakMemoryPercentage": 10,
      "ScanSizeSum": 5,
      "ScanSizePercentage": 80,
      "AverageOperatorCost": 5,
      "MaxOperatorCost": 5,
      "OperatorCostSum": 5,
      "OperatorCostPercentage": 20,
      "AverageScanCost": 5,
      "MaxScanCost": 5,
      "ScanCostSum": 5,
      "ScanCostPercentage": 5
    }
  ],
  "RequestId": "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.