DescribeSqlLogTask - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma tarefa em lote do DAS Enterprise Edition chamando a operação DescribeSqlLogTask.

Descrição da operação

Antes de começar:

Use a versão mais recente do SDK do Alibaba Cloud ou do DAS.
Ao chamar o DAS usando o SDK, defina a região como cn-shanghai.

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

hdm:DescribeSqlLogTask

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	O ID da instância de banco de dados.	r-bp1nti25tc7bq5****
TaskId	string	Não	O ID da tarefa.	a4f5c4494dbd6713185d87a97aa53e8
PageNo	integer	Não	O número da página para a consulta paginada. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de registros por página para a consulta paginada. Valor máximo: 100. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O nó raiz ou diretório raiz.
Code	string	O código de status retornado.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, informações de exceção, como um código de erro, serão retornadas.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os dados retornados.
Name	string	O nome da tarefa.	SQL audit export 1
TaskId	string	O ID da tarefa.	9a4f5c4494dbd6713185d87a97aa53e8
TaskType	string	O tipo de tarefa. Valores válidos: Export: Tarefa de exportação. Query: Tarefa de consulta personalizada.	Query
CreateTime	integer	A hora de criação da tarefa. O valor é um timestamp UNIX em milissegundos.	1681363254423
Status	string	O status da tarefa. Valores válidos: INIT: Aguardando agendamento. RUNNING: Em execução. FAILED: Falhou. CANCELED: Cancelado. COMPLETED: Concluído. Nota Quando a tarefa estiver no estado COMPLETED, você poderá visualizar os resultados da tarefa offline.	COMPLETED
Expire	boolean	Indica se a tarefa expirou. true: A tarefa expirou. false: A tarefa não expirou.	false
Start	integer	A hora de início da consulta. O valor é um timestamp UNIX em milissegundos.	1596177993000
End	integer	A hora de término da consulta. O valor é um timestamp UNIX em milissegundos.	1608888296000
Filters	array<object>	As condições de filtro.
	object	A condição de filtro da consulta.
Key	string	O nome do parâmetro de filtro. Nota Para parâmetros de filtro suportados e seus valores, consulte Descrição complementar dos parâmetros de resposta.	keyWords
Value	any	O valor do parâmetro de filtro.	select
Total	integer	O número total de tarefas.	1
Queries	array<object>	O resultado da tarefa do nó de consulta offline. Este valor é retornado apenas quando TaskType está definido como Query.
	object	O resultado da tarefa do nó de consulta offline.
Vip	string	O endereço de resolução de endpoint do link de consulta.	10.146.XX.XX
NodeId	string	O ID do nó filho.	pi-bp1o58x3ib7e6****
SqlText	string	Os detalhes da instrução SQL.	SELECT @@session.transaction_read_only
SqlType	string	O tipo da instrução SQL. Valores válidos: SELECT UPDATE DELETE	SELECT
State	string	O resultado da execução. 0: Execução bem-sucedida. 1: Falha na execução.	0
DBName	string	O nome do banco de dados.	testdb01
SqlId	string	O ID do SQL.	a4111670e80596c5bf42cf5154438a91
ExecuteTime	string	A hora de execução no formato UTC: `yyyy-MM-ddTHH:mm:ssZ`.	2023-12-07T02:15:32Z
OriginTime	integer	O timestamp de execução. O valor é um timestamp UNIX em milissegundos.	1701886532000
AccountName	string	A conta do banco de dados.	testname
HostAddress	string	O endereço IP do cliente.	11.197.XX.XX
Consume	integer	A duração da execução em milissegundos.	58
LockTime	integer	O tempo de espera de bloqueio em milissegundos.	0
UpdateRows	integer	O número de linhas atualizadas.	0
ScanRows	integer	O número de linhas verificadas.	0
ReturnRows	integer	O número de linhas retornadas.	0
LogicRead	integer	O número de leituras lógicas.	0
PhysicSyncRead	integer	O número de leituras síncronas físicas.	0
PhysicAsyncRead	integer	O número de leituras assíncronas físicas.	0
ThreadId	integer	O ID do thread.	None
TrxId	string	O ID da transação.	200000
Ext	string	O campo de informações estendidas. Este é um parâmetro reservado.	None
Scnt	integer	O número de solicitações DN do nó de computação (CN) do PolarDB-X 2.0.	10
Rows	integer	O número total de linhas atualizadas ou retornadas pelo nó de computação do PolarDB-X 2.0.	10
Frows	integer	O número de linhas buscadas pelo nó de computação (CN) do PolarDB-X 2.0.	10
TraceId	string	O ID de rastreamento do PolarDB-X 2.0, que é o ID de execução da instrução SQL no nó de dados.	14c93b7c7bf00000
UseImciEngine	string	Indica se a instância do PolarDB for MySQL usa o In-Memory Column Index. true: O IMCI é usado. false: O IMCI não é usado.	true
ParallelDegree	string	O tempo de fila paralela da instância do PolarDB for MySQL em milissegundos.	10
ParallelQueueTime	string	O grau de paralelismo da instância do PolarDB for MySQL.	2
PhysicRead	integer	O número de leituras físicas.	0
CpuTime	integer	O tempo de execução da CPU em microssegundos.	100
Writes	integer	O número de gravações para o mecanismo RDS SQL Server.	10
Collection	string	Um parâmetro reservado.	None
SqlCommand	integer	O comando SQL na consulta.	sql
ConnectionId	string	O ID de conexão usado na consulta.	ld-******
Protected	string	Indica se o item de consulta está protegido.	MySQL
Params	string	A lista de parâmetros de consulta.	[1, "das"]
ClientIp	string	O endereço IP do cliente na consulta.	10.0.0.1xx
ClientPort	integer	O número da porta do cliente na consulta.	3306
RowKey	string	A chave da linha na consulta.	23
AffectColumns	string	As colunas afetadas.	["col1"]
TableName	string	O nome da tabela usado na consulta.	das
Export	string	A URL de download da tarefa de exportação. Este valor é retornado apenas quando TaskType está definido como Export.	"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"

Key suporta os seguintes parâmetros e valores:

KeyWords: As palavras-chave. Separe várias palavras-chave com espaços.
LogicalOperator: O operador lógico entre as palavras-chave. Valores válidos: and ou or.
AccountName: O nome de usuário. Você pode especificar vários nomes de usuário separados por vírgulas. O número máximo é 5.
dbName: O nome do banco de dados. Você pode especificar vários nomes de banco de dados separados por vírgulas. O número máximo é 5.
HostAddress: O endereço IP do cliente. Você pode especificar vários endereços IP separados por vírgulas. O número máximo é 5.
MaxConsume: A duração máxima de execução. Unidade: us.
MinConsume: A duração mínima de execução. Unidade: us.
MaxScanRows: O número máximo de linhas verificadas.
MinScanRows: O número mínimo de linhas verificadas.
SqlType: O tipo de SQL. Valores válidos: select, update, insert ou delete.
State: O resultado da execução. Valores válidos: 0 (sucesso) ou 1 (falha).
ThreadId: O ID do thread.
SortKey: O nome da coluna de ordenação. Valores válidos: ScanRows (número de linhas verificadas), UpdateRows (número de linhas atualizadas), Consume (duração da execução), ExecuteTime (tempo de execução), ReturnRows (número de linhas retornadas), LockTime (tempo de espera de bloqueio), Frows (número de linhas buscadas pelos nós de computação do PolarDB-X 2.0), Scnt (número de solicitações DN dos nós de computação do PolarDB-X 2.0), CpuTime (tempo de execução da CPU) ou PhysicalRead (leituras físicas).
SortMethod: A ordem de classificação. Valores válidos: DESC (decrescente) ou ASC (crescente). Valor padrão: DESC.
TraceId: O ID de rastreamento da instância PolarDB-X 2.0.
MinRows: O número mínimo de linhas atualizadas.
MaxRows: O número máximo de linhas atualizadas.
MinScnt: O número mínimo de solicitações DN dos nós de computação (CN) do PolarDB-X 2.0.
MaxScnt: O número máximo de solicitações DN dos nós de computação (CN) do PolarDB-X 2.0.
TrxId: O ID da transação.
Fail: O código de erro.
SqlId: O ID do SQL.

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Name": "SQL audit export 1",
    "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8\n",
    "TaskType": "Query",
    "CreateTime": 1681363254423,
    "Status": "COMPLETED",
    "Expire": true,
    "Start": 1596177993000,
    "End": 1608888296000,
    "Filters": [
      {
        "Key": "keyWords\n",
        "Value": "select"
      }
    ],
    "Total": 1,
    "Queries": [
      {
        "Vip": "10.146.XX.XX",
        "NodeId": "pi-bp1o58x3ib7e6****\n",
        "SqlText": "SELECT @@session.transaction_read_only",
        "SqlType": "SELECT",
        "State": "0",
        "DBName": "testdb01",
        "SqlId": "a4111670e80596c5bf42cf5154438a91",
        "ExecuteTime": "2023-12-07T02:15:32Z",
        "OriginTime": 1701886532000,
        "AccountName": "testname\n",
        "HostAddress": "11.197.XX.XX\n",
        "Consume": 58,
        "LockTime": 0,
        "UpdateRows": 0,
        "ScanRows": 0,
        "ReturnRows": 0,
        "LogicRead": 0,
        "PhysicSyncRead": 0,
        "PhysicAsyncRead": 0,
        "ThreadId": 0,
        "TrxId": "200000\n",
        "Ext": "None",
        "Scnt": 10,
        "Rows": 10,
        "Frows": 10,
        "TraceId": "14c93b7c7bf00000 ",
        "UseImciEngine": "true\n",
        "ParallelDegree": "10\n",
        "ParallelQueueTime": "2",
        "PhysicRead": 0,
        "CpuTime": 100,
        "Writes": 10,
        "Collection": "None",
        "SqlCommand": 0,
        "ConnectionId": "ld-******",
        "Protected": "MySQL",
        "Params": "[1, \"das\"]",
        "ClientIp": "10.0.0.1xx",
        "ClientPort": 3306,
        "RowKey": "23",
        "AffectColumns": "[\"col1\"]",
        "TableName": "das"
      }
    ],
    "Export": "\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\""
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.	Os parâmetros da solicitação são inválidos.
403	NoPermission	You are not authorized to do this action.	Você não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.