調用DescribeSlowLogRecords API查詢慢日誌記錄-資料庫自治服務-阿里雲 - Database Autonomy Service

本介面用於查詢資料庫執行個體的慢日誌紀錄，支援按多種條件過濾和排序。

介面說明

InstanceId 為執行個體 ID，必填參數。
StartTime 和 EndTime 為查詢的時間範圍，必填參數。
可以透過設定 PageNumber 和 PageSize 來分頁取得結果。
支援透過 OrderBy 參數對結果進行排序，具體可排序欄位請參考文件。
使用 Filters 參數可以進一步細化查詢條件，如按主機位址、SQL ID 等過濾。
重要某些資料庫類型（如 pg 和 polarPG）不支援特定的排序方式，請根據實際情況選擇合適的參數。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:DescribeSlowLogRecords

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	rm-8vbk4xz99su8****
NodeId	string	否	節點 ID。	pi-d9j9fe7wq7t9i****
StartTime	integer	是	起始時間。	1596177993000
EndTime	integer	是	結束時間。	1634972640000
PageNumber	integer	否	頁碼，從 1 開始。	1
PageSize	integer	否	每頁筆數。	10
Filters	array<object>	否	篩選條件清單。
	object	否	篩選條件清單。
Key	string	否	過濾參數。說明詳情請參見補充說明。	None
Value	string	否	過濾參數取值。	None
OrderBy	string	否	全引擎通用 QueryTimeSeconds：查詢耗時（秒）。 Timestamp：時間戳記。 SQL 系（MySQL / PolarDB MySQL / PostgreSQL / PolarDB PostgreSQL / PolarDB Oracle / PolarDB-X DN） LockTimeSeconds：鎖定時間（秒）。 RowsExamined：檢查列。 RowsSent：返回列。 MongoDB KeysExamined：掃描索引數。 DocExamined：掃描文件數。 ReturnNum：返回列。 SQLServer CPUTimeSeconds：CPU 時間。 IOWrites：IO 寫入次數。 LastRowsCountAffected：最後受影響列數。 LogicalIOReads：邏輯 IO 讀取。 PhysicalIOReads：實體 IO 讀取。 RowsCountAffected：受影響列數。 PolarDB-X CN RowsSent：返回/更新列數。 Frows：拉取列數。 Scnt：實體 SQL 數。	QueryTimeSeconds
Asc	boolean	否	是否遞增排序，預設為 true。 true：是。 false：否。	true

Key 支援的參數和取值：

RDS MySQL、PolarDB MySQL、RDS PostgreSQL、PolarDB PostgreSQL 版
- hostAddress：來源，多個使用逗號分隔。
- sqlId：SqlID，多個使用逗號分隔。
- user：使用者，多個使用逗號分隔。
- dbName：資料庫名稱，多個使用逗號分隔。
- tags：標籤，多個使用逗號分隔。
MongoDB
- hostInsId：角色 ID，多個使用逗號分隔。
- insRole：執行個體角色，多個使用逗號分隔。
- opType：操作類型，多個使用逗號分隔。
- namespace：命名空間，多個使用逗號分隔。
- nodeType：元件類型，多個使用逗號分隔。
- queryId：查詢 ID，多個使用逗號分隔。
雲端資料庫 Tair（相容 redis）
- hostAddress：來源。
- user：使用者。
- dbName：資料庫。
- nodeType：節點類型。
RDS SQL Server
- hostAddress：來源，多個使用逗號分隔。
- sqlId：SqlID，多個使用逗號分隔。
- user：使用者，多個使用逗號分隔。
- dbName：資料庫，多個使用逗號分隔。
- tags：標籤，多個使用逗號分隔。
PolarDB-X
- traceId：執行個體的追蹤 ID。
- role：節點角色，取值 CN 或 DN（運算節點/儲存節點），必傳。
- hostAddress：來源，多個使用逗號分隔。
- sqlId：SqlID，多個使用逗號分隔。
- user：user，多個使用逗號分隔。
- dbName：資料庫，多個使用逗號分隔。
- tags：標籤，多個使用逗號分隔。

說明

SQL 引擎支援根據 sqlId 查詢資料，且 sqlId 支援逗號分隔傳入多個，最多 20 個。
MongoDB 支援根據 queryId 查詢資料，且 queryId 支援逗號分隔傳入多個，最多 20 個。

返回參數

名稱	類型	描述	樣本值
	object
Code	string	返回的狀態碼。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	A1C79EE2-D04D-571B-8C60-961FAF8E****
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true
Data	object	DBLogRecords
DbInstanceName	string	執行個體 ID。	rm-bp157g54vy772****
NodeId	string	節點 ID。	node123
ItemsNumbers	integer	當前頁查詢日誌列表內的 Item 數量。	10
StartTime	string	起始時間。	1672531200000
EndTime	string	結束時間。	1672617600000
DbInstanceId	integer	執行個體數字 ID。	100
TotalRecords	integer	總記錄數。	100
PageNumbers	integer	分頁查詢的頁碼，從 1 開始，預設為 1。	1
MaxRecordsPerPage	integer	分頁查詢每頁最大記錄數。取值範圍：5～100。	20
Logs	array<object>	返回資料。
	array<object>	返回資料。
SqlId	string	SQL 範本 ID。	sqlId
Scheme	string	資料 Schema。	HTTPS
SubInstanceId	string	子執行個體 ID。	r-8vb219d10038****
DbInstanceName	string	執行個體 ID。	rm-2zebg30mk056g****
InsName	string	執行個體名稱。	test
AccountName	string	使用者。	user1
HostAddress	string	來源。	192.168.1.1
QueryStartTime	string	查詢開始的時間。格式：yyyy-MM-dd hh:mm:ss（UTC 時間）。	2024-04-01 11:00:00
SQLText	string	SQL 文字。	SELECT * FROM my_table WHERE ROWNUM <= 10
Psql	string	SQL 範本。	SELECT * FROM my_table WHERE ROWNUM <= 10
DBName	string	資料庫名稱。	test
QueryTime	integer	查詢耗時。	121
ReturnItemNumbers	string	返回項目編號。	test
DocsExamined	string	MongoDB 該操作執行時掃描的文件數。	100
KeysExamined	string	MongoDB 索引掃描行數。	valueA
TableName	string	資料表名稱。	tableNameExample
LockTime	number	鎖等待時間。	100
RowsExamined	integer	掃描行數。	100
RowsSent	integer	返回行數。	10
ThreadId	string	執行緒 ID。	57472578
Timestamp	integer	時間戳記。	1747118812
SqlTag	object	標籤。
SqlId	string	sqlid。	8ad7069f236bcdaaa9b3ae4b6299****
Tags	string	逗號分隔的多個 tag。	DAS_IMPORTANT,DAS_IN_PLAN
Comments	string	備註資訊。	test
LockTimeSeconds	number	鎖等待時間，單位為秒。	100
QueryTimeSeconds	number	查詢耗時，單位秒。	100
SqlType	string	選擇 SQL 的類型。 SELECT UPDATE DELETE	SELECT
CPUTime	number	CPU 查詢時間。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	50
IOWrites	integer	I/O 寫入次數。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	1
LastRowsCountAffected	integer	最後一條語句的影響行數。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	10
LogicalIOReads	integer	邏輯讀取次數。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	1
PhysicalIOReads	integer	物理讀取次數。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	1
RowsCountAffected	integer	影響的行數。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	10
Command	string	慢查詢語句。說明僅雲端資料庫 Tair（相容 Redis）執行個體支援。	GET async_c4d163675f44fe83f6214cf9ba5exxxx
Namespace	string	命名空間。說明僅雲端資料庫 MongoDB 版執行個體支援。	app.event
QueryId	string	Query ID。說明僅雲端資料庫 MongoDB 版執行個體支援。	d236d0c4ae8485f6ffe5fdbe5e1bdxxx
ReturnNum	string	返回行數。說明僅雲端資料庫 MongoDB 版執行個體支援。	20
ApplicationName	string	應用程式名稱。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	MyApp
CPUTimeSeconds	number	CPU 查詢時間，單位秒。說明僅雲端資料庫 RDS SQL Server 版執行個體支援。	100
Rows	integer	PolarDB-X 2.0 資料庫執行個體運算節點總更新或返回的行數。說明僅雲端資料庫 PolarDB-X 2.0 版執行個體支援。	20
Frows	integer	PolarDB-X 2.0 運算節點（CN）的拉取行數。說明僅雲端資料庫 PolarDB-X 2.0 版執行個體支援。	10
Scnt	integer	PolarDB-X 2.0 運算節點（CN）的 DN 請求數。說明僅雲端資料庫 PolarDB-X 2.0 版執行個體支援。	10
TraceId	string	PolarDB-X 2.0 的追蹤 ID，即 SQL 在資料節點的執行 ID。說明僅雲端資料庫 PolarDB-X 2.0 版執行個體支援。	074ce334-5247-40b9-b0c1-158aea5d****
TemplateId	string	PolarDB-X 2.0 範本 ID。說明僅雲端資料庫 PolarDB-X 2.0 版執行個體支援。	6a63b6ac4572abfaef7d1163f684****
NodeId	string	節點 ID。	r-uf6cfc5e1xxx-proxy-11
Cmd	string	Redis Proxy 層執行的命令。	GET
Rt	integer	Redis Proxy 層面的總回應時間（微秒）。	2055
RequestSize	integer	Redis Proxy 請求封包大小（位元組）。	58
ResponseSize	integer	Redis Proxy 回應封包大小（位元組）。	1535916
ClientIp	string	到 Redis Proxy 的用戶端 IP。	172.16.15.204
DbId	string	Redis Proxy DbId	r-uf6cfc5e1bcb1xxx-db-5
OriginTime	string	Redis Proxy 執行時間。	2026-09-18 10:54:55.311
OpType	string	操作類型。說明僅雲端資料庫 MongoDB 版執行個體支援。	getMore
Fail	string	SQL 執行是否成功；0 = 成功，非 0 = 失敗。說明僅雲端資料庫 Lindorm 執行個體支援。	1
Params	string	綁定參數查詢場景中傳入 SQL 的參數值，多個參數以 ,` 分隔。說明僅雲端資料庫 Lindorm 執行個體支援。
Reason	string	慢日誌執行錯誤時的資訊。說明僅雲端資料庫 Lindorm 執行個體支援。	create-by-mse-can-not-delete
ReqId	string	慢日誌記錄的唯一識別碼。說明僅雲端資料庫 Lindorm 執行個體支援。	hotspot-request-001
ExtText	string	擴充欄位，包含 SQL 執行的額外資訊。說明僅 PolarDB MySQL 執行個體支援。

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "A1C79EE2-D04D-571B-8C60-961FAF8E****",
  "Success": "true",
  "Data": {
    "DbInstanceName": "rm-bp157g54vy772****",
    "NodeId": "node123",
    "ItemsNumbers": 10,
    "StartTime": "1672531200000",
    "EndTime": "1672617600000",
    "DbInstanceId": 100,
    "TotalRecords": 100,
    "PageNumbers": 1,
    "MaxRecordsPerPage": 20,
    "Logs": [
      {
        "SqlId": "sqlId",
        "Scheme": "HTTPS",
        "SubInstanceId": "r-8vb219d10038****",
        "DbInstanceName": "rm-2zebg30mk056g****",
        "InsName": "test",
        "AccountName": "user1",
        "HostAddress": "192.168.1.1",
        "QueryStartTime": "2024-04-01 11:00:00",
        "SQLText": "SELECT * FROM my_table WHERE ROWNUM <= 10",
        "Psql": "SELECT * FROM my_table WHERE ROWNUM <= 10\n",
        "DBName": "test",
        "QueryTime": 121,
        "ReturnItemNumbers": "test",
        "DocsExamined": "100",
        "KeysExamined": "valueA",
        "TableName": "tableNameExample",
        "LockTime": 100,
        "RowsExamined": 100,
        "RowsSent": 10,
        "ThreadId": "57472578",
        "Timestamp": 1747118812,
        "SqlTag": {
          "SqlId": "8ad7069f236bcdaaa9b3ae4b6299****",
          "Tags": "DAS_IMPORTANT,DAS_IN_PLAN",
          "Comments": "test"
        },
        "LockTimeSeconds": 100,
        "QueryTimeSeconds": 100,
        "SqlType": "SELECT",
        "CPUTime": 50,
        "IOWrites": 1,
        "LastRowsCountAffected": 10,
        "LogicalIOReads": 1,
        "PhysicalIOReads": 1,
        "RowsCountAffected": 10,
        "Command": "SELECT",
        "Namespace": "pro-test",
        "QueryId": "sq-1pzcdMwRb",
        "ReturnNum": "20",
        "ApplicationName": "MyApp",
        "CPUTimeSeconds": 100,
        "Rows": 20,
        "Frows": 10,
        "Scnt": 10,
        "TraceId": "074ce334-5247-40b9-b0c1-158aea5d****",
        "TemplateId": "6a63b6ac4572abfaef7d1163f684****",
        "NodeId": "r-uf6cfc5e1xxx-proxy-11",
        "Cmd": "GET",
        "Rt": 2055,
        "RequestSize": 58,
        "ResponseSize": 1535916,
        "ClientIp": "172.16.15.204",
        "DbId": "r-uf6cfc5e1bcb1xxx-db-5",
        "OriginTime": "2026-09-18 10:54:55.311",
        "OpType": "getMore",
        "Fail": "1",
        "Params": "",
        "Reason": "create-by-mse-can-not-delete",
        "ReqId": "hotspot-request-001",
        "ExtText": ""
      }
    ]
  }
}

錯誤碼

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

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

變更歷史

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