ListDownloadJobs - Simple Log Service: Central de Documentação do Alibaba Cloud

Lista os trabalhos de download de log em um projeto especificado.

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

log:ListDownloadJobs

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /downloadjobs HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
project	string	Sim	O nome do projeto.	ali-test-project
offset	integer	Não	A linha a partir da qual iniciar a consulta. O valor padrão é 0.	0
size	integer	Não	O número de trabalhos de download de log a serem retornados em uma única solicitação.	10
logstore	string	Não	O nome do Logstore.	ali-test-logstore

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações sobre todos os trabalhos de download de log.
total	integer	O número total de registros.	10
count	integer	O número de trabalhos de download de log retornados na resposta atual.	10
results	array<object>	Uma matriz que contém a lista de trabalhos de download de log.
	array<object>	As informações sobre um trabalho de download de log.
description	string	A descrição do trabalho de download de log.	a download job
configuration	object	A configuração de download.
logstore	string	The source Logstore.	ali-test-logstore
fromTime	integer	The start time of the query. This is a UNIX timestamp that is accurate to the second.	1722409260
toTime	integer	The end time of the query. This is a UNIX timestamp that is accurate to the second.	1722411060
query	string	The query statement.	* \| select *
powerSql	boolean	Specifies whether to enable PowerSQL.	true
allowInComplete	string	Specifies whether to allow the download of incomplete results.	false
sink	object	The sink configuration.
compressionType	string	The compression format.	none
contentType	string	The file format of the downloaded file.	csv
roleArn	string	The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.	acs:ram::123456:role/aliyunlogimportossrole
bucket	string	The destination OSS bucket.	ali-test-oss-bucket
prefix	string	The prefix of the object that is downloaded to the destination OSS bucket.	download/
type	string	The type of the sink. The value is fixed as AliyunOSS.	AliyunOSS
displayName	string	O nome de exibição.	download-123
executionDetails	object	Os detalhes de execução do trabalho.
progress	integer	The download progress as a percentage.	100
filePath	string	The URL of the downloaded file.	https://sls-downloaded-xxxx.csv.gzip?Expiresxxx
fileSize	integer	The size of the downloaded file in bytes.	123456
executeTime	integer	The running time of the download.	123
logCount	integer	The number of downloaded log entries.	123
errorMessage	string	The error message that is returned if the job fails.	timeout
checkSum	string	The ETag of the file.	ETASFGASDASQWDasd
notice	string	The notification message.	test
name	string	O nome do trabalho de download de log.	download-123
createTime	string	A hora em que o trabalho de download de log foi criado. Este é um timestamp UNIX em segundos.	1722411060
status	string	O status do trabalho.	STARTING、RUNNING、SUCCEEDED、ERROR

Exemplos

Resposta de sucesso

JSON formato

{
  "total": 10,
  "count": 10,
  "results": [
    {
      "description": "a download job",
      "configuration": {
        "logstore": "ali-test-logstore",
        "fromTime": 1722409260,
        "toTime": 1722411060,
        "query": "* | select *",
        "powerSql": true,
        "allowInComplete": "false",
        "sink": {
          "compressionType": "none",
          "contentType": "csv",
          "roleArn": "acs:ram::123456:role/aliyunlogimportossrole",
          "bucket": "ali-test-oss-bucket",
          "prefix": "download/",
          "type": "AliyunOSS"
        }
      },
      "displayName": "download-123",
      "executionDetails": {
        "progress": 100,
        "filePath": "https://sls-downloaded-xxxx.csv.gzip?Expiresxxx",
        "fileSize": 123456,
        "executeTime": 123,
        "logCount": 123,
        "errorMessage": "timeout",
        "checkSum": "ETASFGASDASQWDasd",
        "notice": "test"
      },
      "name": "download-123",
      "createTime": "1722411060",
      "status": "STARTING、RUNNING、SUCCEEDED、ERROR"
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.