創建明細數據異步任務。
接口說明
使用該接口需滿足以下前提條件：
- 使用阿里云或 DAS 的 SDK 時，建議使用最新版本。
- 在使用 SDK 調用 DAS 服務時，需要將地域指定為 cn-shanghai。
- 僅開通了 DAS 企業版的數據庫實例支持創建離線任務。DAS 企業版各個版本支持的數據庫和地域請參見 DAS 產品系列及支持的功能。
調試
您可以在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 |
| Name | string | 否 | 任務名稱。 | SQL審計導出1 |
| Filters | array<object> | 否 | 篩選條件列表。 | |
| Item | object | 否 | 篩選條件。 | |
| Key | string | 否 | 過濾參數的名稱。 說明
支持的過濾參數及其取值請參考請求參數補充說明。
| KeyWords |
| Value | string | 否 | 過濾參數的數值。 | select |
| StartTime | long | 否 | 任務的開始時間，格式為 Unix 時間戳，單位為毫秒。 | 1596177993000 |
| EndTime | long | 否 | 任務結束時間，格式為 unix 時間戳，單位為毫秒。 | 1608888296000 |
| Role | string | 否 | PolarDB-X 2.0 數據庫實例節點信息。
| 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 進一步查詢返回結果。
- 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）
返回參數
示例
正常返回示例
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. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。