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

Obtém informações sobre uma tarefa de download.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

GET /downloadjobs/{downloadJobName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
downloadJobName	string	Sim	O nome da tarefa de download de logs.	download-123

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
project	string	Sim	O nome do projeto.	ali-test-project

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações sobre a tarefa de download.
status	string	O status da tarefa de download.	STARTING、RUNNING、SUCCEEDED、ERROR
name	string	O nome da tarefa de download.	download-123
description	string	A descrição da tarefa.	a download job
configuration	object	A configuração de download.
logstore	string	O Logstore de origem.	ali-test-logstore
fromTime	integer	A hora de início da tarefa de download. O valor é um timestamp UNIX em segundos.	1722409860
toTime	integer	A hora de término da tarefa de download. O valor é um timestamp UNIX em segundos.	1722411060
query	string	A instrução de pesquisa.	* \| select *
powerSql	boolean	Especifica se o PowerSQL deve ser ativado.	false
allowInComplete	boolean	Especifica se o download de dados incompletos é permitido. Valores válidos: true : Sim. false : no	true
sink	object	A configuração de exportação.
type	string	The value is fixed to AliyunOSS.	AliyunOSS
contentType	string	The file format.	csv
compressionType	string	The compression format.	none
roleArn	string	The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.	acs:ram::0123456789:role/aliyunlogdefaultrole
bucket	string	The Object Storage Service (OSS) bucket.	ali-test-oss-bucket
prefix	string	The prefix of the file that is saved to the bucket.	download/
createTime	string	A hora em que a tarefa foi criada.	1722411060
displayName	string	O nome de exibição.	download-123456
executionDetails	object	Os detalhes da execução.
progress	integer	O progresso do download.	100
filePath	string	A URL do resultado do download.	https://xxx.csv.zst?xxx
fileSize	integer	O tamanho do arquivo baixado em bytes.	123456
executeTime	integer	A duração da tarefa de download em segundos.	123
logCount	integer	O número de entradas de log baixadas.	123
errorMessage	string	A mensagem de erro se o download falhar.	timeout
checkSum	string	O ETag do arquivo.	EXSFGSDASDASDG123ASD
notice	string	Notification text.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "status": "STARTING、RUNNING、SUCCEEDED、ERROR",
  "name": "download-123",
  "description": "a download job",
  "configuration": {
    "logstore": "ali-test-logstore",
    "fromTime": 1722409860,
    "toTime": 1722411060,
    "query": "* | select *",
    "powerSql": false,
    "allowInComplete": true,
    "sink": {
      "type": "AliyunOSS",
      "contentType": "csv",
      "compressionType": "none",
      "roleArn": "acs:ram::0123456789:role/aliyunlogdefaultrole",
      "bucket": "ali-test-oss-bucket",
      "prefix": "download/"
    }
  },
  "createTime": "1722411060",
  "displayName": "download-123456",
  "executionDetails": {
    "progress": 100,
    "filePath": "https://xxx.csv.zst?xxx",
    "fileSize": 123456,
    "executeTime": 123,
    "logCount": 123,
    "errorMessage": "timeout",
    "checkSum": "EXSFGSDASDASDG123ASD",
    "notice": "test"
  }
}

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.