使用ListDownloadJobs API列出日誌下載任務-Log Service-阿里雲 - Simple Log Service

列出指定 Project 下的日誌下載任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:ListDownloadJobs

list

*All Resource

*

無

請求文法

GET /downloadjobs HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
project	string	是	Project 名稱。	ali-test-project
offset	integer	否	查詢起始行，預設值為 0。	0
size	integer	否	單次查詢需要取得的日誌下載任務數量。	10
logstore	string	否	Logstore 名稱。	ali-test-logstore

返回參數

名稱	類型	描述	樣本值
	object	所有的日誌下載任務資訊。
total	integer	總記錄數。	10
count	integer	目前列出的日誌下載任務數量。	10
results	array<object>	陣列，返回日誌下載任務清單。
	array<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	通知資訊。	test
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": "test"
      },
      "name": "download-123",
      "createTime": "1722411060",
      "status": "STARTING、RUNNING、SUCCEEDED、ERROR"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。