使用CreateSqlLogTask建立SQL日誌非同步離線任務-資料庫自治服務-阿里雲 - Database Autonomy Service

建立詳細資料非同步任務。

介面說明

前提條件：

使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。
在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。
僅開通了 DAS 企業版的資料庫執行個體支援建立離線任務。DAS 企業版各個版本支援的資料庫和地區請參見 DAS 產品系列及支援的功能。

介面限制：

最大同時執行數量為 10。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:CreateSqlLogTask

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	否	資料庫執行個體 ID。	pc-2ze8g2am97624****
NodeId	string	否	節點 ID。說明該參數僅適用於叢集版執行個體，可以選取查詢指定節點離線任務。若不傳該參數，預設返回主節點離線任務。	pi-uf6k5f6g3912i****
Type	string	否	任務類型 Export：匯出任務。說明 Export 支援的過濾參數及其取值請參考請求參數補充說明。 Query：查詢任務。	Export
Name	string	否	任務名稱。	SQL審計匯出1
Filters	array<object>	否	篩選條件列表。
	object	否	篩選條件。
Key	string	否	過濾參數的名稱。說明支援的過濾參數及其取值請參考請求參數補充說明。	KeyWords
Value	string	否	過濾參數的數值。	select
StartTime	integer	否	任務的開始時間，格式為 Unix 時間戳記，單位為毫秒。	1596177993000
EndTime	integer	否	任務結束時間，格式為 unix 時間戳記，單位為毫秒。	1608888296000
Role	string	否	PolarDB-X 2.0 資料庫執行個體節點資訊。 polarx_cn：計算節點。 polarx_dn：資料節點。	polarx_cn

Key 支援的參數和取值：

KeyWords：關鍵字，多個關鍵字間使用空格隔開。
LogicalOperator：關鍵字間的邏輯操作，取值為 and 或 or。
AccountName：使用者名稱，可以傳遞多個的，用逗號分開，上限為 5。
DbName：資料庫名稱，可以傳遞多個的，用逗號分開，上限為 5。
HostAddress：用戶端 IP 位址，可以傳遞多個的，用逗號分開，上限為 5。
MaxConsume：最大耗時，單位 us。
MinConsume：最小耗時，單位 us。
MaxScanRows：最大掃描行。
MinScanRows：最小掃描行。
SqlType：SQL 類型，取值 select、update、insert 或 delete。
State：執行結果，取值 0（成功）或 1（失敗）。
ThreadId：線程 ID。
SortKey：排序列名稱，取值 ScanRows（掃描行數）、UpdateRows（更新行數）、Consume（耗時）、ExecuteTime（執行時間）、ReturnRows（返回行數）、LockTime（鎖等待時間）、Frows（PolarDB-X 2.0 計算節點的拉取行數）、Scnt（PolarDB-X 2.0 計算節點的 DN 請求數）、CpuTime（CPU 執行時間）、PhysicalRead（物理讀）。
SortMethod：排序方式，取值 DESC（降序）、ASC（升序）。預設為 DESC。
TraceId：PolarDB-X 2.0 執行個體的跟蹤 ID。
MinRows：最小更新行數。
MaxRows：最大更新行數。
MinScnt：PolarDB-X 2.0 計算節點（CN）的 DN 最小請求數。
MaxScnt：PolarDB-X 2.0 計算節點（CN）的 DN 最大請求數。
TrxId：事務 ID。
Fail：錯誤碼。
SqlId：SQL ID。
JobId：通過非同步任務 ID 進一步查詢返回結果。
Delimiter：分隔字元，支援的| , $ # 四種。
Columns：Type = Export，任務類型為匯出任務時，傳入選擇的匯出列，匯出列用空格隔開，可選的有
- columnDBName：資料庫
- columnThreadId：線程 ID
- columnAccountName：使用者
- columnHostAddress：用戶端 IP
- columnSqlType：sql 類型
- columnState：狀態
- columnConsume：耗時 us
- columnUpdateRows：更新行數
- columnScanRows：掃描行數
- columnReturnRows：返回行數
- columnLockTime：鎖等待時間
- columnLogicRead：邏輯讀
- columnPhysicSyncRead：物理同步讀
- columnPhysicASyncRead：物理非同步讀
- columnOriginTime：執行時間（us）
- columnExecuteTime：執行時間（類似於 2024-07-30 11:00:00）

返回參數

名稱	類型	描述	樣本值
	object
Code	string	返回的狀態代碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	83D9D59B-057A-54A9-BFF9-CF2B42F05645
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true
Data	object	返回資料。
TaskId	string	任務 ID。	54f8041743ca3a9ac5cb9342d050527c
InstanceId	string	資料庫執行個體 ID。	pc-2ze8g2am97624****
Name	string	任務名稱。	Export_test
Start	integer	開始時間，格式為 Unix 時間戳記，單位為毫秒。	1596177993000
End	integer	結束時間，格式為 Unix 時間戳記，單位為毫秒。	1608888296000
Status	string	任務狀態。 INIT：待調度。 RUNNING：運行中。 FAILED：失敗。 CANCELED：已取消。 COMPLETED：完成。說明當任務處於 COMPLETED 時，可以查看任務的結果。	COMPLETED
CreateTime	integer	任務建立時間，格式為 unix 時間戳記，單位為毫秒。	1681363254423

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "83D9D59B-057A-54A9-BFF9-CF2B42F05645",
  "Success": "true",
  "Data": {
    "TaskId": "54f8041743ca3a9ac5cb9342d050527c",
    "InstanceId": "pc-2ze8g2am97624****",
    "Name": "Export_test",
    "Start": 1596177993000,
    "End": 1608888296000,
    "Status": "COMPLETED",
    "CreateTime": 1681363254423
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.	請求參數錯誤
403	NoPermission	You are not authorized to do this action.	沒有許可權執行該操作

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

變更歷史

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