調用DescribeSqlLogTask接口,查詢DAS企業版離線任務詳情。
接口說明
使用該接口需滿足以下前提條件:
- 使用阿里云或 DAS 的 SDK 時,建議使用最新版本。
- 在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:DescribeSqlLogTask | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 否 | 數據庫實例 ID。 | r-bp1nti25tc7bq5**** |
TaskId | string | 否 | 任務 ID。 | a4f5c4494dbd6713185d87a97aa53e8 |
PageNo | integer | 否 | 分頁查詢的頁碼,從 1 開始,默認為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢每頁最大記錄數,最大支持 100,默認為 10。 | 10 |
返回參數
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。
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true",
"Data": {
"Name": "SQL審計導出1\n",
"TaskId": "9a4f5c4494dbd6713185d87a97aa53e8\n",
"TaskType": "Query",
"CreateTime": 1681363254423,
"Status": "COMPLETED",
"Expire": true,
"Start": 1596177993000,
"End": 1608888296000,
"Filters": [
{
"Key": "keyWords\n",
"Value": "select"
}
],
"Total": 1,
"Queries": [
{
"Vip": "10.146.XX.XX",
"NodeId": "pi-bp1o58x3ib7e6****\n",
"SqlText": "SELECT @@session.transaction_read_only",
"SqlType": "SELECT",
"State": "0",
"DBName": "testdb01",
"SqlId": "a4111670e80596c5bf42cf5154438a91",
"ExecuteTime": "2023-12-07T02:15:32Z",
"OriginTime": 1701886532000,
"AccountName": "testname\n",
"HostAddress": "11.197.XX.XX\n",
"Consume": 58,
"LockTime": 0,
"UpdateRows": 0,
"ScanRows": 0,
"ReturnRows": 0,
"LogicRead": 0,
"PhysicSyncRead": 0,
"PhysicAsyncRead": 0,
"ThreadId": 0,
"TrxId": "200000\n",
"Ext": "None",
"Scnt": 10,
"Rows": 10,
"Frows": 10,
"TraceId": "14c93b7c7bf00000 ",
"UseImciEngine": "true\n",
"ParallelDegree": "10\n",
"ParallelQueueTime": "2",
"PhysicRead": 0,
"CpuTime": 100,
"Writes": 10,
"Collection": "None"
}
],
"Export": "\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\""
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-03 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-05-22 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |