使用ListDownloadJobs API列出日志下载任务-日志服务-阿里云

列出指定Project下的日志下载任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:ListDownloadJobs

list

*全部资源

*

无

请求语法

GET /downloadjobs HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
offset	integer	否	查询开始行，默认值为 0。	0
size	integer	否	单次查询需要获取的日志下载任务数量	10
logstore	string	否	Logstore 名称	ali-test-logstore

返回参数

名称	类型	描述	示例值
	object	所有的日志下载任务信息。
total	integer	总记录数。	10
count	integer	当前列出的日志下载任务数量	10
results	array<object>	数组，返回日志下载任务列表
	object	日志下载任务信息
description	string	日志下载任务描述	a download job
configuration	object	下载配置
logstore	string	源 logstore	ali-test-logstore
fromTime	integer	起点时间戳（精确到秒）	1722409260
toTime	integer	结束时间戳（精确到秒）	1722411060
query	string	查询语句	* \| select *
powerSql	boolean	是否启用 powerSql	true
allowInComplete	string	允许下载不精确结果	false
sink	object	日志下载任务配置
compressionType	string	压缩格式	none
contentType	string	下载文件格式	csv
roleArn	string	下载使用 roleArn	acs:ram::123456:role/aliyunlogimportossrole
bucket	string	对象存储桶	ali-test-oss-bucket
prefix	string	下载到用户 oss bucket 时的文件前缀	download/
type	string	固定为 AliyunOSS	AliyunOSS
displayName	string	显示名称	download-123
executionDetails	object	执行细节
progress	integer	下载进度	100
filePath	string	下载结果链接	https://sls-downloaded-xxxx.csv.gzip?Expiresxxx
fileSize	integer	下载文件大小	123456
executeTime	integer	下载执行时间	123
logCount	integer	下载日志条数	123
errorMessage	string	下载错误信息	timeout
checkSum	string	文件 ETag	ETASFGASDASQWDasd
notice	string
name	string	日志下载任务名称	download-123
createTime	string	日志下载任务创建时间	1722411060
status	string	任务状态	STARTING、RUNNING、SUCCEEDED、ERROR

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。