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

Consulta a lista de tarefas de log de auditoria de uma instância.

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

list

*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****
NodeId	string	Não	O ID do nó. Nota Este parâmetro é aplicável apenas a instâncias da Edição Cluster. Você pode especificar um nó para consultar suas tarefas em lote. Se você não especificar este parâmetro, as tarefas em lote do nó primário serão retornadas por padrão.	pi-bp1o58x3ib7e6****
Filters	array<object>	Não	A lista de condições de filtro de consulta.
	object	Não	A condição de filtro de consulta.
Key	string	Não	O parâmetro de filtro. Nota Para parâmetros de filtro suportados e seus valores, consulte Descrição complementar dos parâmetros de solicitação.	keyWords
Value	string	Não	O valor do parâmetro de filtro.	select
StartTime	integer	Não	A hora inicial da consulta. Especifique um timestamp UNIX em milissegundos.	1596177993000
EndTime	integer	Não	A hora final da consulta. Especifique um timestamp UNIX em milissegundos.	1608888296000
PageNo	integer	Não	O número da página para a consulta paginada. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de registros por página. Valor máximo: 100. Valor padrão: 10.	10

Parâmetros e valores suportados para Key:

taskId: O ID da tarefa.
keyWords: O nome da tarefa.
status: O filtro de status. Valores válidos: INIT (agendamento pendente), RUNNING (em execução), FAILED (falhou), CANCELED (cancelada) e COMPLETED (concluída).

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
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, uma mensagem de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os dados retornados.
List	array<object>	A lista de informações retornadas.
	array<object>	A lista de informações retornadas.
TaskId	string	O ID da tarefa.	9a4f5c4494dbd6713185d87a97aa53e8
InstanceId	string	O ID da instância de banco de dados.	r-bp1nti25tc7bq5****
Name	string	O nome da tarefa.	SQL audit export 1
Start	integer	A hora inicial da tarefa. O valor é um timestamp UNIX em milissegundos.	1683859555482
End	integer	A hora final da tarefa. O valor é um timestamp UNIX em milissegundos.	1705975320000
Status	string	O status da tarefa. Valores válidos: INIT: Agendamento pendente. RUNNING: Em execução. FAILED: Falhou. CANCELED: Cancelada. COMPLETED: Concluída. Nota Quando a tarefa estiver no estado COMPLETED, você poderá visualizar os resultados da tarefa em lote.	RUNNING
LogCount	integer	O número total de logs.	99999
Progress	integer	O progresso da tarefa.	100
ScanFileSize	integer	O número de arquivos verificados.	3000
Expire	boolean	Indica se a tarefa expirou. Valores válidos: true: A tarefa expirou. false: A tarefa não expirou.	false
CreateTime	integer	A hora de criação da tarefa. O valor é um timestamp UNIX em milissegundos.	1681363254423
AnalysisTaskFinishTime	integer	A hora de conclusão da tarefa de análise. O valor é um timestamp UNIX em milissegundos.	1712751923000
AnalysisTaskStatus	string	O status da tarefa de análise. Nota Este é um parâmetro interno do sistema. Você não precisa prestar atenção nele.	SCAN_ANALYZE_COMPLETED
Result	string	O endereço do link quando o tipo de tarefa é Export.	https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
TaskType	string	O tipo de tarefa. Valores válidos: Export: Tarefa de exportação. Query: Tarefa de consulta.	Export
Filters	array<object>	A lista de condições de filtro de consulta.
	object	A condição de filtro de consulta.
Key	string	O parâmetro de filtro. Nota Para parâmetros de filtro suportados e seus valores, consulte Descrição complementar dos parâmetros de solicitação.	keyWords
Value	string	O valor do parâmetro de filtro.	select
InnerResult	string	O endpoint interno da VPC.	https://das-sqllog-download-oss-cn-shanghai-internal.aliyuncs.com /la
Total	integer	O número total de tarefas.	40
PageNo	integer	O número da página.	1
PageSize	integer	O número de registros por página.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8",
        "InstanceId": "r-bp1nti25tc7bq5****\n",
        "Name": "SQL audit export 1",
        "Start": 1683859555482,
        "End": 1705975320000,
        "Status": "RUNNING",
        "LogCount": 99999,
        "Progress": 100,
        "ScanFileSize": 3000,
        "Expire": false,
        "CreateTime": 1681363254423,
        "AnalysisTaskFinishTime": 1712751923000,
        "AnalysisTaskStatus": "SCAN_ANALYZE_COMPLETED",
        "Result": "https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la",
        "TaskType": "Export",
        "Filters": [
          {
            "Key": "keyWords\n",
            "Value": "select\n"
          }
        ],
        "InnerResult": "https://das-sqllog-download-oss-cn-shanghai-internal.aliyuncs.com\n/la"
      }
    ],
    "Total": 40,
    "PageNo": 1,
    "PageSize": 10
  }
}

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.