GetQueryOptimizeDataStats - - Centre de documentation Alibaba Cloud

Retourne les statistiques des modèles SQL à partir des données de gouvernance des requêtes.

Description de l'opération

Si vous utilisez un SDK Alibaba Cloud, assurez-vous que la version d'aliyun-sdk-core est ultérieure à la V2.1.8. Nous vous recommandons d'utiliser la version la plus récente.
La version de votre SDK Database Autonomy Service (DAS) doit être la V2.1.8 ou ultérieure.
Si vous utilisez un SDK pour appeler les opérations d'API de DAS, vous devez définir l'identifiant de la région sur cn-shanghai.
Cette opération prend en charge les moteurs de base de données suivants :
- ApsaraDB RDS for MySQL.
- PolarDB for MySQL.
- ApsaraDB RDS for PostgreSQL.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Engine	string	Oui	Le moteur de base de données. Valeurs valides : MySQL PolarDBMySQL PostgreSQL	MySQL
InstanceIds	string	Non	Les identifiants des instances. Séparez les identifiants multiples par des virgules (,).	rm-2ze8g2am97624****
TagNames	string	Non	Le paramètre réservé.	None
Keywords	string	Non	Les mots-clés du modèle SQL. Séparez les mots-clés multiples par des espaces.	select update
LogicalOperator	string	Non	La relation logique entre plusieurs mots-clés. Valeurs valides : or and	or
Rules	string	Non	Les balises utilisées pour filtrer les modèles SQL. Séparez les balises multiples par des virgules (,). Pour plus d'informations, consultez Gouvernance des requêtes.	DAS_NOT_IMPORTANT
DbNames	string	Non	Le nom de la base de données à interroger.	testdb01
Time	string	Oui	La plage de temps à interroger. Spécifiez l'heure au format d'horodatage UNIX. Unité : millisecondes.	1642953600000
PageSize	string	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	10
PageNo	string	Non	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
OrderBy	string	Non	Le champ selon lequel trier les entrées retournées. Valeur par défaut : count. Valeurs valides : count : le nombre d'exécutions. maxQueryTime : le temps d'exécution le plus long. avgQueryTime : le temps d'exécution moyen. maxLockTime : le temps d'attente de verrou le plus long. avgLockTime : le temps d'attente de verrou le plus long. maxRowsExamined : le plus grand nombre de lignes analysées. avgRowsExamined : le nombre moyen de lignes analysées. maxRowsSent : le plus grand nombre de lignes retournées. avgRowsSent : le nombre moyen de lignes retournées.	count
Asc	string	Non	Indique si les entrées retournées doivent être triées par ordre croissant. Valeur par défaut : true. Valeurs valides : true : trie les entrées retournées par ordre croissant. false : ne trie pas les entrées retournées par ordre croissant.	true
OnlyOptimizedSql	string	Non	Indique si seuls les modèles SQL devant être optimisés doivent être interrogés. Valeur par défaut : false. Valeurs valides : true : interroge uniquement les modèles SQL devant être optimisés. false : n'interroge pas uniquement les instructions SQL devant être optimisées.	false
SqlIds	string	Non	L'identifiant du modèle SQL. Vous pouvez interroger l'identifiant d'un modèle en appelant l'opération GetQueryOptimizeExecErrorStats.	2e8147b5ca2dfc640dfd5e43d96a****
Region	string	Non	La région dans laquelle l'instance réside. Valeurs valides : cn-china : Chine continentale cn-hongkong : Chine (Hong Kong) ap-southeast-1 : Singapour Ce paramètre prend effet uniquement si InstanceIds est laissé vide. Si vous laissez InstanceIds vide, le système obtient les données de la région définie par Region. Par défaut, Region est défini sur cn-china. Si vous spécifiez InstanceIds, Region ne prend pas effet et le système obtient les données de la région dans laquelle réside la première instance spécifiée. Remarque Définissez ce paramètre sur cn-china pour les instances créées dans les régions de la Chine continentale.	cn-china
User	string	Non	Le compte de la base de données à interroger.	testUser

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Code	string	Le code d'état HTTP retourné.	200
Message	string	Le message retourné.	Successful
Data	object	Les données retournées.
Total	integer	Le nombre total d'entrées retournées.	10
PageNo	integer	Le paramètre réservé.	None
PageSize	integer	Le paramètre réservé.	None
Extra	string	Le paramètre réservé.	None
List	array<object>	Les informations sur les modèles SQL.
	array<object>
InstanceId	string	The instance ID.	rm-2ze8g2am97624****
Dbname	string	The name of the database to which the SQL template belongs.	testdb01
SqlId	string	The SQL template ID.	2e8147b5ca2dfc640dfd5e43d96a****
SqlType	string	The type of the SQL statement.	INSERT
Psql	string	The SQL template.	select 1
SqlSample	string	The sample query that took the longest time to execute.	select 2
Count	integer	The number of times that the SQL template is executed.	100
MaxQueryTime	number	The longest query execution time. Unit: seconds.	1.1
AvgQueryTime	number	The average query execution time. Unit: seconds.	1.1
MaxLockTime	number	The longest lock wait time. Unit: seconds.	0.1
AvgLockTime	number	The average lock wait time. Unit: seconds.	0.1
MaxRowsExamined	integer	The largest number of scanned rows.	100000
AvgRowsExamined	number	The average number of scanned rows.	100.1
MaxRowsSent	integer	The largest number of returned rows.	10000
AvgRowsSent	number	The average number of returned rows.	100.1
MaxRowsAffected	integer	The largest number of rows affected by the SQL template. Remarque A value of -1 indicates that this parameter is not collected.	10000
AvgRowsAffected	number	The average number of rows affected by the SQL statement. Remarque A value of -1 indicates that this parameter is not collected.	100.1
RuleList	array<object>	The information about the rules.
	object
Name	string	The rule name.	DAS_NOT_IMPORTANT
Type	string	The type of the rule. Valid values: Predefined UserDefined	Predefined
User	string	The account of the database.	testUser
RequestId	string	L'identifiant de la requête.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 10,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlType": "INSERT",
        "Psql": "select 1",
        "SqlSample": "select 2",
        "Count": 100,
        "MaxQueryTime": 1.1,
        "AvgQueryTime": 1.1,
        "MaxLockTime": 0.1,
        "AvgLockTime": 0.1,
        "MaxRowsExamined": 100000,
        "AvgRowsExamined": 100.1,
        "MaxRowsSent": 10000,
        "AvgRowsSent": 100.1,
        "MaxRowsAffected": 10000,
        "AvgRowsAffected": 100.1,
        "RuleList": [
          {
            "Name": "DAS_NOT_IMPORTANT",
            "Type": "Predefined"
          }
        ],
        "User": "testUser"
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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.