DescribeProcessList - ApsaraDB for ClickHouse: Central de Documentação do Alibaba Cloud

Chama a operação DescribeProcessList para obter consultas em execução em um cluster do ApsaraDB for ClickHouse compatível com a comunidade.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

clickhouse:DescribeProcessList

get

*DBCluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para encontrar o ID da região.	cn-hangzhou
DBClusterId	string	Sim	O ID do cluster. Você pode chamar a operação DescribeDBClusters para encontrar informações sobre todos os clusters na região de destino, incluindo o ID do cluster.	cc-bp1190tj036am****
QueryDurationMs	integer	Não	A duração mínima da consulta. O valor mínimo é 1000. O valor padrão é 1000. A unidade é milissegundos. A resposta retorna consultas executadas por um tempo superior a essa duração.	500
InitialUser	string	Não	A conta do banco de dados.	user
Keyword	string	Não	A palavra-chave para a consulta.	join
Order	string	Não	A coluna a ser usada para classificação. Valores válidos: elapsed: O tempo total de execução. written_rows: O número de linhas gravadas. read_rows: O número de linhas lidas. memory_usage: A quantidade de memória utilizada.	elapsed
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 (Padrão) 50 100	30
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. O valor padrão é 1.	1
InitialQueryId	string	Não	O ID da consulta.	6c69d508-f05f-4c74-857c-d982b7e7e79f

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
RequestId	string	O ID da solicitação.	FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
ProcessList	object	A lista de processos.
TableSchema	object
ResultSet	array<object>	The details of the columns.
	object
Type	string	The type of the column.	String
Name	string	The name of the column.	InitialUser
Data	object
ResultSet	array<object>	The details of the tasks.
	object
QueryStartTime	string	The time when the query started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is in UTC.	2021-02-02T09:14:48Z
Query	string	The query statement.	select * from test order by score limit 1;
InitialAddress	string	The IP address of the client that initiated the query.	::ffff:10.1.XX.XX
InitialQueryId	string	The query ID.	2dd144fd-4230-4249-b15c-e63f964fbb5a
InitialUser	string	The database account.	test
QueryDurationMs	string	The query duration in milliseconds.	2000
Rows	string	O número de linhas retornadas para a consulta.	1145700
RowsBeforeLimitAtLeast	string	O tamanho da página em linhas.	1
Statistics	object	As estatísticas do resultado da consulta.
RowsRead	integer	The number of rows scanned.	1000000
ElapsedTime	number	The elapsed time.	4156
BytesRead	integer	The size of the scanned data, in bytes.	9141300000

Exemplos

Resposta de sucesso

JSON formato

{
  "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
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.