GetDownloadJob API Reference for Log Download Jobs - Simple Log Service - Alibaba Cloud - Simple Log Service

Retrieves information about a log 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

log:GetDownloadJob

get

*Project

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

None

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	download job info
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.	a download job
configuration	object	The download configuration.
logstore	string	The source Logstore.	ali-test-logstore
fromTime	integer	The start timestamp, in seconds.	1722409860
toTime	integer	The end timestamp, in seconds.	1722411060
query	string	The query statement.	* \| select *
powerSql	boolean	Indicates whether PowerSQL is enabled.	false
allowInComplete	boolean	Specifies whether to allow downloading incomplete data. Valid values: true : true false : false	true
sink	object	The export configuration.
type	string	Fixed value: AliyunOSS.	AliyunOSS
contentType	string	The format of the downloaded file.	csv
compressionType	string	The compression format.	none
roleArn	string	The ARN of the RAM role used for the download.	acs:ram::0123456789:role/aliyunlogdefaultrole
bucket	string	The OSS bucket.	ali-test-oss-bucket
prefix	string	The file prefix used when downloading logs to the user's OSS bucket.	download/
createTime	string	The creation time.	1722411060
displayName	string	The display name.	download-123456
executionDetails	object	The execution details.
progress	integer	The download progress.	100
filePath	string	The download result link.	https://xxx.csv.zst?xxx
fileSize	integer	The size of the downloaded file.	123456
executeTime	integer	The execution time of the download.	123
logCount	integer	The number of downloaded log entries.	123
errorMessage	string	The error message of the download.	timeout
checkSum	string	The ETag of the file.	EXSFGSDASDASDG123ASD
notice	string	The notification text.	test

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.