DescribeSqlLogTasks - 查詢DAS企業版離線工作清單 -

查詢執行個體的審計日誌工作清單。

介面說明

使用該介面需滿足以下前提條件：

使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。
在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:DescribeSqlLogTasks

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	資料庫執行個體 ID。	r-bp1nti25tc7bq5****
NodeId	string	否	節點 ID。說明該參數僅適用於叢集版執行個體，可以選取查詢指定節點離線任務。若不傳該參數，預設返回主節點離線任務。	pi-bp1o58x3ib7e6****
Filters	array<object>	否	查詢篩選條件列表。
	object	否	查詢篩選條件。
Key	string	否	過濾參數。說明支援的過濾參數及其取值請參考請求參數補充說明。	keyWords
Value	string	否	過濾參數的值。	select
StartTime	integer	否	查詢開始時間，格式為 unix 時間戳記，單位為毫秒。	1596177993000
EndTime	integer	否	查詢結束時間，格式為 unix 時間戳記，單位為毫秒。	1608888296000
PageNo	integer	否	分頁查詢的頁碼，從 1 開始，預設為 1。	1
PageSize	integer	否	每頁最大記錄數，最大支援 100，預設值為 10。	10

Key 支援的參數和取值：

taskId：任務 ID。
keyWords：任務名。
status：狀態篩選，取值 INIT（待調度）、RUNNING（運行中）、FAILED（失敗）、CANCELED（已取消）、COMPLETED（完成）。

返回參數

名稱	類型	描述	樣本值
	object
Code	string	返回的狀態代碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true
Data	object	返回資料。
List	array<object>	返回資訊列表。
	array<object>	返回資訊列表。
TaskId	string	任務 ID。	9a4f5c4494dbd6713185d87a97aa53e8
InstanceId	string	資料庫執行個體 ID。	r-bp1nti25tc7bq5****
Name	string	任務名稱。	SQL審計匯出1
Start	integer	任務開始時間，格式為 unix 時間戳記，單位為毫秒。	1683859555482
End	integer	任務結束時間，格式為 unix 時間戳記，單位為毫秒。	1705975320000
Status	string	任務狀態。 INIT：待調度。 RUNNING：運行中。 FAILED：失敗。 CANCELED：已取消。 COMPLETED：完成。說明當任務處於 COMPLETED 時，可以查看離線任務的結果。	RUNNING
LogCount	integer	日誌總數。	99999
Progress	integer	任務進度。	100
ScanFileSize	integer	掃描的檔案數量。	3000
Expire	boolean	任務是否到期。 true：是。 false：否。	false
CreateTime	integer	任務建立時間，格式為 unix 時間戳記，單位為毫秒。	1681363254423
AnalysisTaskFinishTime	integer	分析任務完成時間，格式為 unix 時間戳記，單位為毫秒。	1712751923000
AnalysisTaskStatus	string	分析任務狀態。說明系統內部參數，使用者無需關注。	SCAN_ANALYZE_COMPLETED
Result	string	任務類型為 Export 時的連結地址。	https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la
TaskType	string	任務類型。 Export：匯出任務。 Query：查詢任務。	Export
Filters	array<object>	查詢篩選條件列表。
	object	查詢篩選條件。
Key	string	過濾參數。說明支援的過濾參數及其取值請參考請求參數補充說明。	keyWords
Value	string	過濾參數的值。	select
InnerResult	string
Total	integer	任務數量。	40
PageNo	integer	頁碼。	1
PageSize	integer	每頁數量。	10

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "List": [
      {
        "TaskId": "9a4f5c4494dbd6713185d87a97aa53e8",
        "InstanceId": "r-bp1nti25tc7bq5****\n",
        "Name": "SQL審計匯出1",
        "Start": 1683859555482,
        "End": 1705975320000,
        "Status": "RUNNING",
        "LogCount": 99999,
        "Progress": 100,
        "ScanFileSize": 3000,
        "Expire": false,
        "CreateTime": 1681363254423,
        "AnalysisTaskFinishTime": 1712751923000,
        "AnalysisTaskStatus": "SCAN_ANALYZE_COMPLETED",
        "Result": "https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la",
        "TaskType": "Export",
        "Filters": [
          {
            "Key": "keyWords\n",
            "Value": "select\n"
          }
        ],
        "InnerResult": ""
      }
    ],
    "Total": 40,
    "PageNo": 1,
    "PageSize": 10
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

變更歷史

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