DescribeProcessList - - Centre de documentation Alibaba Cloud

Consulte les requêtes en cours d'exécution dans un cluster ApsaraDB for ClickHouse Community-compatible Edition.

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.

clickhouse:DescribeProcessList

get

*DBCluster

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
DBClusterId	string	Oui	L'identifiant du cluster. Vous pouvez appeler l'opération DescribeDBClusters pour obtenir tous les clusters de la région cible, y compris leurs identifiants.	cc-bp1190tj036am****
QueryDurationMs	integer	Non	La durée minimale de la requête. Valeur minimale : 1000. Valeur par défaut : 1000. Unité : millisecondes. La réponse renvoie les requêtes dont la durée d'exécution dépasse cette valeur.	500
InitialUser	string	Non	Le compte de la base de données.	user
Keyword	string	Non	Le mot-clé de la requête.	join
Order	string	Non	La colonne selon laquelle trier les résultats. Valeurs valides : elapsed : temps d'exécution cumulé written_rows : nombre de lignes écrites read_rows : nombre de lignes lues memory_usage : utilisation de la mémoire	elapsed
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30 (par défaut) 50 100	30
PageNumber	integer	Non	Le numéro de page. Valeurs valides : un entier supérieur à 0 et jusqu'à la valeur maximale du type de données Integer. Valeur par défaut : 1.	1
InitialQueryId	string	Non	L'identifiant de l'instruction de requête.	6c69d508-f05f-4c74-857c-d982b7e7e79f

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les résultats renvoyés.
RequestId	string	L'identifiant de la requête.	FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
ProcessList	object	La liste des processus.
TableSchema	object
ResultSet	array<object>	Les détails de la liste.
	object
Type	string	Le type de colonne.	String
Name	string	Le nom de la colonne.	InitialUser
Data	object
ResultSet	array<object>	Les détails du processus.
	object
QueryStartTime	string	L'heure de début de la requête. Format : yyyy-MM-ddTHH:mm:ssZ (heure UTC).	2021-02-02T09:14:48Z
Query	string	L'instruction de requête.	select * from test order by score limit 1;
InitialAddress	string	L'adresse IP du client qui a initié la requête.	::ffff:10.1.XX.XX
InitialQueryId	string	L'identifiant de la requête.	2dd144fd-4230-4249-b15c-e63f964fbb5a
InitialUser	string	Le compte de la base de données.	test
QueryDurationMs	string	La durée de la requête. Unité : millisecondes.	2000
Rows	string	Le nombre de lignes de données renvoyées par la requête.	1145700
RowsBeforeLimitAtLeast	string	La taille de la page.	1
Statistics	object	Les informations statistiques des résultats de la requête.
RowsRead	integer	Le nombre de lignes analysées.	1000000
ElapsedTime	number	Le temps de réponse moyen. Unité : millisecondes.	4156
BytesRead	integer	La taille des données analysées. Unité : octets.	9141300000

Exemples

JSON format

{
  "RequestId": "FD61BB0D-788A-5185-A8E3-1B90BA8F6F04",
  "ProcessList": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "String",
          "Name": "InitialUser"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "QueryStartTime": "2021-02-02T09:14:48Z",
          "Query": "select * from test order by score limit 1;",
          "InitialAddress": "::ffff:10.1.XX.XX",
          "InitialQueryId": "2dd144fd-4230-4249-b15c-e63f964fbb5a",
          "InitialUser": "test",
          "QueryDurationMs": "2000"
        }
      ]
    },
    "Rows": "1145700",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 1000000,
      "ElapsedTime": 4156,
      "BytesRead": 9141300000
    }
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
500	InternalError	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.

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

Notes de version

Consultez Notes de version pour la liste complète.