GetDownloadJob - 获取日志下载任务_日志服务(SLS)-阿里云帮助中心

获取下载任务信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /downloadjobs/{downloadJobName} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
downloadJobName	string	是	日志下载任务名称	download-123
project	string	是	Project 名称	ali-test-project

返回参数

名称	类型	描述	示例值
	object	download job info
status	string	下载任务状态	running
name	string	下载任务名称	download-123
description	string	描述	a download job
configuration	object	下载配置
logstore	string	源 logstore	ali-test-logstore
fromTime	long	起点时间戳（精确到秒）	1722409860
toTime	long	结束时间戳（精确到秒）	1722411060
query	string	查询语句	* \| select *
powerSql	boolean	是否启用 powerSql	false
allowInComplete	boolean	允许下载不精确数据枚举值： true：true。 false：false。	true
sink	object	导出配置
type	string	固定为 AliyunOSS	AliyunOSS
contentType	string	下载文件格式	csv
compressionType	string	压缩格式	none
roleArn	string	下载使用 roleArn	acs:ram::0123456789:role/aliyunlogdefaultrole
bucket	string	对象存储桶	ali-test-oss-bucket
prefix	string	下载日志到用户 bucket 时的文件前缀	download/
createTime	string	创建时间	1722411060
displayName	string	显示名称	download-123456
executionDetails	object	执行细节
progress	long	下载进度	100
filePath	string	下载结果链接	https://xxx.csv.zst?xxx
fileSize	long	下载文件大小	123456
executeTime	long	下载执行时间	123
logCount	long	下载日志条数	123
errorMessage	string	下载错误信息	timeout
checkSum	string	文件 ETAG	EXSFGSDASDASDG123ASD

示例

正常返回示例

JSON格式

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

错误码

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