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

Obtém os detalhes de 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

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

get

*Project

acs:log:{#regionId}:{#accountId}:project/{#project}/downloadjob/{#downloadJobName}

Nenhuma

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 log.	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	Informações da 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.	a download job
configuration	object	A configuração de download.
logstore	string	O Logstore de origem.	ali-test-logstore
fromTime	integer	O timestamp de início, com precisão de segundos.	1722409860
toTime	integer	O timestamp de fim, com precisão de segundos.	1722411060
query	string	A instrução de consulta.	* \| select *
powerSql	boolean	Indica se o PowerSQL está ativado.	false
allowInComplete	boolean	Especifica se dados incompletos podem ser baixados. Valores válidos: true : true. false : false.	true
sink	object	A configuração de exportação.
type	string	Fixado como AliyunOSS.	AliyunOSS
contentType	string	O formato do arquivo baixado.	csv
compressionType	string	O formato de compactação.	none
roleArn	string	O ARN da função usada para download.	acs:ram::0123456789:role/aliyunlogdefaultrole
bucket	string	O bucket do OSS.	ali-test-oss-bucket
prefix	string	O prefixo de arquivo usado ao baixar logs para o bucket do usuário.	download/
createTime	string	A hora de criação.	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.	123456
executeTime	integer	O tempo de execução do download.	123
logCount	integer	O número de logs baixados.	123
errorMessage	string	A mensagem de erro do download.	timeout
checkSum	string	O ETag do arquivo.	EXSFGSDASDASDG123ASD
notice	string	O texto da notificação.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "status": "STARTING、RUNNING、SUCCEEDED、ERROR",
  "name": "download-123",
  "description": "uma tarefa de download",
  "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": "teste"
  }
}

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.