擷取下載任務資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
GET /downloadjobs/{downloadJobName} HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| downloadJobName |
string |
是 |
日誌下載任務名稱 |
download-123 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
是 |
Project 名稱 |
ali-test-project |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
download job info |
||
| status |
string |
下載任務狀態 |
STARTING、RUNNING、SUCCEEDED、ERROR |
| name |
string |
下載任務名稱 |
download-123 |
| description |
string |
描述 |
a download job |
| configuration |
object |
下載配置 |
|
| logstore |
string |
源 logstore |
ali-test-logstore |
| fromTime |
integer |
起點時間戳記（精確到秒） |
1722409860 |
| toTime |
integer |
結束時間戳記（精確到秒） |
1722411060 |
| query |
string |
查詢語句 |
* | select * |
| powerSql |
boolean |
是否啟用 powerSql |
false |
| allowInComplete |
boolean |
允許下載不精確資料 枚舉值：
|
true |
| sink |
object |
匯出配置 |
|
| type |
string |
固定為 AliyunOSS |
AliyunOSS |
| contentType |
string |
下載檔案格式 |
csv |
| compressionType |
string |
壓縮格式 |
none |
| roleArn |
string |
下載使用 roleArn |
acs:ram::0123456789:role/aliyunlogdefaultrole |
| bucket |
string |
Object Storage Service桶 |
ali-test-oss-bucket |
| prefix |
string |
下載日誌到使用者 bucket 時的檔案首碼 |
download/ |
| createTime |
string |
建立時間 |
1722411060 |
| displayName |
string |
顯示名稱 |
download-123456 |
| executionDetails |
object |
執行細節 |
|
| progress |
integer |
下載進度 |
100 |
| filePath |
string |
下載結果連結 |
https://xxx.csv.zst?xxx |
| fileSize |
integer |
下載檔案大小 |
123456 |
| executeTime |
integer |
下載執行時間 |
123 |
| logCount |
integer |
下載日誌條數 |
123 |
| errorMessage |
string |
下載錯誤資訊 |
timeout |
| checkSum |
string |
檔案 ETAG |
EXSFGSDASDASDG123ASD |
| notice |
string |
樣本
正常返回樣本
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": ""
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。