GetFullRequestStatResultByInstanceId - - Centre de documentation Alibaba Cloud

Collecte de manière asynchrone les statistiques complètes des requêtes dans les résultats de SQL Explorer d'une instance de base de données par identifiant SQL.

Description de l'opération

Remarque

GetFullRequestStatResultByInstanceId est une opération asynchrone. Après l'envoi d'une requête, les résultats complets ne sont pas retournés immédiatement. Si la valeur du paramètre isFinish est false dans la réponse, patientez 1 seconde puis renvoyez une requête. Si la valeur du paramètre isFinish est true, les résultats complets sont retournés.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
UserId	string	Non	L'identifiant du compte Alibaba Cloud qui a été utilisé pour créer l'instance de base de données.	196278346919****
InstanceId	string	Oui	L'identifiant de l'instance.	rm-2ze8g2am97624****
NodeId	string	Non	L'identifiant du nœud.	pi-bp12v7243x012****
SqlId	string	Non	L'identifiant SQL.	d71f82be1eef72bd105128204d2e****
OriginHost	string	Non	L'adresse IP du client qui exécute l'instruction SQL.	172.26.XX.XXX
Keyword	string	Non	Les mots-clés utilisés pour la requête.	dbtest01
Start	integer	Oui	Le début de la plage horaire à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1645581813000
End	integer	Oui	La fin de la plage horaire à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1645668213000
OrderBy	string	Non	Le champ selon lequel trier les entrées retournées. Valeur par défaut : count. Valeurs valides :	count
Asc	boolean	Non	Indique si les résultats doivent être triés par ordre croissant. Par défaut, les résultats ne sont pas triés par ordre croissant.	Désactivé
PageNo	integer	Oui	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Oui	Le nombre d'entrées par page. Valeur par défaut : 20.	20
SqlType	string	Non	Le type d'instruction SQL. Valeurs valides : SELECT, INSERT, UPDATE, DELETE, LOGIN, LOGOUT, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE, DROP, SET, DESC, REPLACE, CALL, BEGIN, DESCRIBE, ROLLBACK, FLUSH, USE, SHOW, START, COMMIT et RENAME.	SELECT
DbName	string	Non	Le nom de la base de données.	dbtest01
Role	string	Non	Le rôle du nœud dans l'instance PolarDB-X 2.0. Valeurs valides :	polarx_cn

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Message	string	Le message retourné.	Réussi
RequestId	string	L'identifiant de la requête.	7172BECE-588A-5961-8126-C216E16B****
Data	object	Les données retournées.
Result	object	Les données complètes de requête retournées.
List	array<object>	The full request data.
	object
SqlId	string	The SQL ID.	d71f82be1eef72bd105128204d2e****
AvgFetchRows	integer	The average number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
AvgLockWaitTime	number	The average lock wait latency. Unit: seconds.	0.00009589874265269765
AvgLogicalRead	number	The average number of logical reads.	654.4470327860251
AvgPhysicalAsyncRead	integer	The average number of physical asynchronous reads.	0
AvgPhysicalSyncRead	integer	The average number of physical synchronous reads.	0
AvgExaminedRows	number	The average number of scanned rows. Remarque This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
AvgReturnedRows	number	The average number of returned rows.	10000
AvgUpdatedRows	integer	The average number of updated rows. Remarque This parameter is returned only for ApsaraDB RDS for MySQL and PolarDB-X 2.0 databases.	10000
AvgRt	number	The average execution duration.	2.499
AvgSqlCount	integer	The average number of SQL statements.	10000
Count	integer	The total number of executions.	100000
CountRate	number	The percentage of the total number of executions.	0.0586
Database	string	The name of the database.	dbtest01
ErrorCount	integer	The number of failed executions.	1
FetchRows	integer	The number of rows that are fetched by compute nodes from data nodes on the PolarDB-X 2.0 instance.	0
Ip	string	The IP address of the database instance.	rm-uf6dyi58dm6**.mysql.rds.aliy**.com
LockWaitTime	number	The lock wait latency. Unit: seconds.	1089.4177720290281
LogicalRead	integer	The number of logical reads.	7.434573266E9
PhysicalAsyncRead	integer	The number of physical asynchronous reads.	0
PhysicalSyncRead	integer	The number of physical synchronous reads.	0
Port	integer	The port number that is used to connect to the database instance.	3306
Psql	string	The SQL template.	select * from dbtest01 where ****
Rows	integer	The total number of rows updated or returned by the compute nodes of the PolarDB-X 2.0 instance.	0
ExaminedRows	integer	The total number of scanned rows. Remarque This parameter is returned only for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and PolarDB for MySQL databases.	10000
RtGreaterThanOneSecondCount	integer	The number of SQL statements that take longer than 1 second to execute.	20
RtRate	number	The execution duration percentage.	2.499
SqlCount	integer	The number of SQL statements.	200
SumUpdatedRows	integer	The total number of updated rows.	100
Tables	array	The names of tables in the database.
	string	The names of tables in the database.	tabletest01,tabletest02
Version	integer	The version number.	1
VpcId	string	The virtual private cloud (VPC) ID.	vpc-2zentqj1sk4qmolci****
Total	integer	The total number of entries returned.	1
Fail	boolean	Indique si la requête asynchrone a échoué. Valeurs valides :	false
IsFinish	boolean	Indique si la requête asynchrone est terminée. Valeurs valides :	true
ResultId	string	L'identifiant de la requête.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
State	string	L'état de la requête asynchrone. Valeurs valides :	SUCCESS
Timestamp	integer	L'heure à laquelle la requête asynchrone a été envoyée. La valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1645668213000
Code	integer	Le code d'état HTTP retourné.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides :	true

Exemples

JSON format

{
  "Message": "Successful",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Data": {
    "Result": {
      "List": [
        {
          "SqlId": "d71f82be1eef72bd105128204d2e****",
          "AvgFetchRows": 0,
          "AvgLockWaitTime": 0.00009589874265269765,
          "AvgLogicalRead": 654.4470327860251,
          "AvgPhysicalAsyncRead": 0,
          "AvgPhysicalSyncRead": 0,
          "AvgExaminedRows": 10000,
          "AvgReturnedRows": 10000,
          "AvgUpdatedRows": 10000,
          "AvgRt": 2.499,
          "AvgSqlCount": 10000,
          "Count": 100000,
          "CountRate": 0.0586,
          "Database": "dbtest01",
          "ErrorCount": 1,
          "FetchRows": 0,
          "Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
          "LockWaitTime": 1089.4177720290281,
          "LogicalRead": 7434573266,
          "PhysicalAsyncRead": 0,
          "PhysicalSyncRead": 0,
          "Port": 3306,
          "Psql": "select * from dbtest01 where ****",
          "Rows": 0,
          "ExaminedRows": 10000,
          "RtGreaterThanOneSecondCount": 20,
          "RtRate": 2.499,
          "SqlCount": 200,
          "SumUpdatedRows": 100,
          "Tables": [
            "tabletest01,tabletest02"
          ],
          "Version": 1,
          "VpcId": "vpc-2zentqj1sk4qmolci****"
        }
      ],
      "Total": 1
    },
    "Fail": false,
    "IsFinish": true,
    "ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
    "State": "SUCCESS",
    "Timestamp": 1645668213000
  },
  "Code": 200,
  "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.