ListDownloadJobs - Simple Log Service - Alibaba Cloud Documentation Center

Lists the log download jobs in a specified project.

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

list

*All Resource

*

None

Request syntax

GET /downloadjobs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
offset	integer	No	The line from which to start the query. Default value: 0.	0
size	integer	No	The number of log download jobs to return for the request.	10
logstore	string	No	The name of the Logstore.	ali-test-logstore

Response elements

Element	Type	Description	Example
	object	The information about all log download jobs.
total	integer	The total number of jobs found.	10
count	integer	The number of jobs returned in this response.	10
results	array<object>	The log download jobs.
	array<object>	The details of a log download job.
description	string	The description of the log download job.	a download job
configuration	object	The download configuration.
logstore	string	The source Logstore.	ali-test-logstore
fromTime	integer	The start of the time range to query. This is a UNIX timestamp in seconds.	1722409260
toTime	integer	The end of the time range to query. This is a UNIX timestamp in seconds.	1722411060
query	string	The query statement.	* \| select *
powerSql	boolean	Indicates whether PowerSQL is enabled.	true
allowInComplete	string	Indicates whether to allow the download of incomplete query results.	false
sink	object	The sink configuration.
compressionType	string	The compression format.	none
contentType	string	The 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	The display name of the job.	download-123
executionDetails	object	The execution details of the job.
progress	integer	The download progress. Unit: %.	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 in seconds.	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
name	string	The name of the log download job.	download-123
createTime	string	The time when the log download job was created. This is a UNIX timestamp in seconds.	1722411060
status	string	The status of the job. Valid values: STARTING, RUNNING, SUCCEEDED, and ERROR.	STARTING、RUNNING、SUCCEEDED、ERROR

Examples

Success response

JSON format

{
  "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": ""
      },
      "name": "download-123",
      "createTime": "1722411060",
      "status": "STARTING、RUNNING、SUCCEEDED、ERROR"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.