全部产品
Search
文档中心

日志服务:GetDownloadJob - 获取日志下载任务

更新时间:Nov 28, 2024

获取下载任务信息。

调试

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

授权信息

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

请求语法

GET /downloadjobs/{downloadJobName} HTTP/1.1

请求参数

名称类型必填描述示例值
downloadJobNamestring

日志下载任务名称

download-123
projectstring

Project 名称

ali-test-project

返回参数

名称类型描述示例值
object

download job info

statusstring

下载任务状态

STARTING、RUNNING、SUCCEEDED、ERROR
namestring

下载任务名称

download-123
descriptionstring

描述

a download job
configurationobject

下载配置

logstorestring

源 logstore

ali-test-logstore
fromTimelong

起点时间戳(精确到秒)

1722409860
toTimelong

结束时间戳(精确到秒)

1722411060
querystring

查询语句

* | select *
powerSqlboolean

是否启用 powerSql

false
allowInCompleteboolean

允许下载不精确数据

枚举值:
  • truetrue
  • falsefalse
true
sinkobject

导出配置

typestring

固定为 AliyunOSS

AliyunOSS
contentTypestring

下载文件格式

csv
compressionTypestring

压缩格式

none
roleArnstring

下载使用 roleArn

acs:ram::0123456789:role/aliyunlogdefaultrole
bucketstring

对象存储桶

ali-test-oss-bucket
prefixstring

下载日志到用户 bucket 时的文件前缀

download/
createTimestring

创建时间

1722411060
displayNamestring

显示名称

download-123456
executionDetailsobject

执行细节

progresslong

下载进度

100
filePathstring

下载结果链接

https://xxx.csv.zst?xxx
fileSizelong

下载文件大小

123456
executeTimelong

下载执行时间

123
logCountlong

下载日志条数

123
errorMessagestring

下载错误信息

timeout
checkSumstring

文件 ETAG

EXSFGSDASDASDG123ASD

示例

正常返回示例

JSON格式

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

错误码

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