DescribePatternPerformance - - Centre de documentation Alibaba Cloud

Consulte les métriques d'un modèle SQL, telles que la durée de requête et l'utilisation moyenne de la mémoire sur une période donnée.

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:DescribePatternPerformance

get

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 informations sur tous les clusters AnalyticDB for MySQL d'une région, y compris les identifiants des clusters.	am-****************
StartTime	string	Oui	Le début de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque Seules les données des 14 derniers jours peuvent être interrogées. Par exemple, si la date actuelle est le 22 novembre (UTC+8), vous pouvez interroger les données d'une journée remontant jusqu'au 9 novembre en définissant StartTime sur 2021-11-08T16:00:00Z. Si vous définissez StartTime sur une valeur antérieure à 2021-11-08T16:00:00Z, le paramètre Performances est vide. La plage de temps maximale pouvant être spécifiée est de 24 heures.	2021-11-18T00:00:00Z
EndTime	string	Oui	La fin de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 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-11-18T18:05:00Z
RegionId	string	Oui	L'identifiant de la région du cluster. Remarque Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
PatternId	string	Oui	L'identifiant du modèle SQL. Remarque Vous pouvez appeler l'opération DescribeSQLPatterns pour obtenir les informations sur tous les modèles SQL d'un cluster AnalyticDB for MySQL sur une période donnée, y compris les identifiants des modèles SQL.	3847585356974******

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
EndTime	string	L'heure de fin de la requête. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2021-11-18T18:05Z
RequestId	string	L'identifiant de la requête.	210f47011634026610213529******
StartTime	string	L'heure de début de la requête. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2021-11-18T00:00Z
Performances	array<object>	Les métriques de performances interrogées.
	array<object>	La métrique de performances interrogée.
Key	string	La métrique de performances qui a été interrogée. Valeurs valides : AnalyticDB_PatternQueryCount : le nombre total de requêtes exécutées en association avec le modèle SQL. AnalyticDB_PatternQueryTime : le temps total consommé par les requêtes exécutées en association avec le modèle SQL. AnalyticDB_PatternExecutionTime : la durée d'exécution totale des requêtes exécutées en association avec le modèle SQL. AnalyticDB_PatternPeakMemory : l'utilisation maximale de la mémoire des requêtes exécutées en association avec le modèle SQL. AnalyticDB_PatternScanSize : la quantité de données analysées dans les requêtes exécutées en association avec le modèle SQL.	AnalyticDB_PatternQueryCount
Unit	string	L'unité de la métrique de performances. Valeurs valides : Lorsque la métrique de performances est liée à la durée de la requête (la valeur de `Key` est `AnalyticDB_PatternQueryTime` ou `AnalyticDB_PatternExecutionTime`), ms est renvoyé. Lorsque la métrique de performances est liée à l'utilisation de la mémoire (la valeur de `Key` est `AnalyticDB_PatternPeakMemory`), MB est renvoyé. Lorsque la métrique de performances est liée à la quantité de données analysées (la valeur de `Key` est `AnalyticDB_PatternScanSize`), MB est renvoyé. Lorsque la métrique de performances est liée au nombre de requêtes (la valeur de `Key` est `AnalyticDB_PatternQueryCount`), ce paramètre est vide.	ms
Series	array<object>	Les métriques de performances interrogées.
	object	Les métriques de performances interrogées.
Values	array	The queried performance metrics.
	string	The value of the performance metric.	[ "2021-11-18 13:38:00", "224" ]
Name	string	The name of the performance metric value. Valid values: When the `Key` parameter is set to `AnalyticDB_PatternQueryCount`, `pattern_query_count` is returned, which indicates the number of executions of the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternQueryTime`, the following values are returned: `average_query_time`, which indicates the average total amount of time consumed by the SQL statements in association with the SQL pattern. `max_query_time`, which indicates the maximum total amount of time consumed by the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternExecutionTime`, the following values are returned: `average_execution_time`, which indicates the average execution duration of the SQL statements in association with the SQL pattern. `max_execution_time`, which indicates the maximum execution duration of the SQL statements in association with the SQL pattern. When the `Key` parameter is set to `AnalyticDB_PatternPeakMemory`, the following values are returned: `average_peak_memory`, which indicates the average peak memory usage of the SQL statements in association with the SQL pattern. `max_peak_memory`, which indicates the maximum peak memory usage of the SQL statements in association with the SQL pattern. When the `Key` parameter is set `AnalyticDB_PatternScanSize`, the following values are returned: `average_scan_size`, which indicates the average amount of data scanned by the SQL statements in association with the SQL pattern. `max_scan_size`, which indicates the maximum amount of data scanned by the SQL statements in association with the SQL pattern.	max_query_time
AccessIp	string	L'adresse IP du client SQL qui soumet le modèle SQL.	172.16.14.*
FailedCount	integer	Le nombre de modèles SQL en échec dans la plage de temps.	0
QueryCount	integer	Le nombre de requêtes exécutées en association avec le modèle SQL dans la plage de temps.	35018
SQLPattern	string	L'instruction SQL qui représente le modèle SQL.	SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?
Tables	string	Les tables associées au modèle SQL.	tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation
User	string	Le compte de base de données utilisé pour exécuter l'instruction SQL.	test

Exemples

JSON format

{
  "EndTime": "2021-11-18T18:05Z",
  "RequestId": "210f47011634026610213529******",
  "StartTime": "2021-11-18T00:00Z",
  "Performances": [
    {
      "Key": "AnalyticDB_PatternQueryCount",
      "Unit": "ms",
      "Series": [
        {
          "Values": [
            "[               \"2021-11-18 13:38:00\",               \"224\"             ]"
          ],
          "Name": "max_query_time"
        }
      ]
    }
  ],
  "AccessIp": "172.16.14.*",
  "FailedCount": 0,
  "QueryCount": 35018,
  "SQLPattern": "SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?",
  "Tables": "tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation",
  "User": "test"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.