GetDownloadJob - Simple Log Service - Alibaba Cloud Documentation Center

Retrieves information about a download task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /downloadjobs/{downloadJobName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
downloadJobName	string	Yes	The name of the log download task.	download-123

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project

Response elements

Element	Type	Description	Example
	object	The information about the download job.
status	string	The status of the download task.	STARTING、RUNNING、SUCCEEDED、ERROR
name	string	The name of the download task.	download-123
description	string	The description of the task.	a download job
configuration	object	The download configuration.
logstore	string	The source Logstore.	ali-test-logstore
fromTime	integer	The start time of the download task. The value is a UNIX timestamp in seconds.	1722409860
toTime	integer	The end time of the download task. The value is a UNIX timestamp in seconds.	1722411060
query	string	The search statement.	* \| select *
powerSql	boolean	Specifies whether to enable PowerSQL.	false
allowInComplete	boolean	Specifies whether to allow downloading incomplete data. Valid values: true : yes false : no	true
sink	object	The export configuration.
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	The time when the task was created.	1722411060
displayName	string	The display name.	download-123456
executionDetails	object	The execution details.
progress	integer	The download progress.	100
filePath	string	The URL of the download result.	https://xxx.csv.zst?xxx
fileSize	integer	The size of the downloaded file in bytes.	123456
executeTime	integer	The duration of the download task in seconds.	123
logCount	integer	The number of downloaded log entries.	123
errorMessage	string	The error message if the download fails.	timeout
checkSum	string	The ETag of the file.	EXSFGSDASDASDG123ASD
notice	string

Examples

Success response

JSON format

{
  "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": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.