全部產品
Search
文件中心

Database Autonomy Service:DescribeSqlInsightStatistic

更新時間:Sep 09, 2026

呼叫DescribeSqlInsightStatistic介面,按SQL範本、存取來源或資料庫使用者等維度,聚合統計指定執行個體在給定時間窗內的SQL洞察資料。

介面說明

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

  • 使用阿里雲或 DAS 的 SDK 時,建議使用最新版本。

  • 在使用 SDK 呼叫 DAS 服務時,需要將地域指定為 cn-shanghai。

  • 目標執行個體必須已開啟 SQL 洞察功能,未開啟時介面回傳錯誤。

呼叫說明:

  • 本介面為非同步介面。首次呼叫回傳 ResultId 與 State,需要攜帶完全相同的請求參數輪詢,直至 State 為 SUCCESS 時才能取得 Data 中的統計結果。

  • StartTime 與 EndTime 均為毫秒級時間戳記。StartTime 距目前時間不得超過 30 天,且 StartTime 與 EndTime 的跨度不得超過 7 天。

  • 因資料匯聚存在延遲,EndTime 會被自動裁剪到目前時間前推若干分鐘,最近幾分鐘的資料可能查詢不到。

  • StartTime 會被自動收斂到不早於該執行個體 SQL 洞察功能的開啟時間。

回傳結果說明:

  • Data.Data.List 為按聚合維度歸併後的統計結果,每個元素對應一類 SQL 範本或一個聚合鍵,而不是單次執行的明細紀錄。

  • Scnt、AvgScnt、Rows、AvgRows、Frows、AvgFrows 為 PolarDB-X 運算節點專屬指標,僅在 Role 為 polarx_cn 時回傳。

  • Writes、AvgWrites、MaxWrites、MinWrites、PhysicalRead、AvgPhysicalRead、MaxPhysicalRead、MinPhysicalRead、CpuTime、AvgCpuTime、MaxCpuTime、MinCpuTime 為 SQL Server 執行個體專屬指標。

  • Trend 僅在請求參數 DoFillTrend 為 true 且執行個體已開啟趨勢填充能力時回傳,時間片間隔由查詢跨度自動決定。

  • SqlNew、Params、FirstTime、Extra 等 SQL 範例維度欄位不由本介面回傳,本介面提供的是範本維度的聚合統計。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

ConsoleContext

string

否

備用參數。

null

InstanceId

string

是

資料庫執行個體 ID。

說明

支援已開啟 SQL 洞察的 RDS MySQL、PolarDB MySQL、PolarDB-X、RDS PostgreSQL、PolarDB PostgreSQL、RDS SQL Server、Lindorm 執行個體;MongoDB 與 Redis 執行個體不支援本介面,呼叫會返回不支援該操作的錯誤。

rm-bp1q6f9z5xxxxxxxx

NodeId

string

否

執行個體的節點 ID,用於把統計範圍收斂到指定節點。只支援傳入單個節點 ID,不支援英文逗號分隔傳入多個。

說明

僅在由多個節點組成的執行個體(例如 PolarDB-X、Lindorm)下需要傳入,單節點執行個體可忽略。

pi-bp1xxxxxxxxxxxx

Type

string

否

統計的聚合維度或過濾維度,取值不區分大小寫。不傳時預設按 SQL 範本維度聚合。取值:

  • FullRequestOrigin:按存取來源位址維度聚合。

  • FullRequestUser:按資料庫使用者維度聚合。

  • SQL:按 SQL 範本過濾,需同時傳入 TemplateId 作為 SQL 範本 ID。

  • OriginHost:按存取來源過濾,需同時傳入 TemplateId 作為來源位址。

  • User:按資料庫使用者過濾,需同時傳入 TemplateId 作為使用者名稱。

說明

傳入上述之外的取值返回 InvalidParams 錯誤。

SQL

TemplateId

string

否

統計物件的標識,含義隨 Type 變化。取值:

  • Type 為 SQL 時:傳 SQL 範本 ID,即返回結果中的 SqlId。

  • Type 為 OriginHost 時:傳存取來源位址。

  • Type 為 User 時:傳資料庫使用者名稱。

說明

Type 為空、FullRequestOrigin 或 FullRequestUser 時本參數不生效。

說明

Type 為 SQL 時支援英文逗號分隔傳入多個範本 ID,且此時 Keyword 不再生效。

9f8e7d6c5b4a3210

Keyword

string

否

按 SQL 範本內容進行模糊檢索的關鍵字,多個關鍵字以空白分隔。系統先根據關鍵字比對出對應的 SQL 範本(最多 1000 個),再基於這些範本聚合統計;若無比對範本則返回空清單。

說明

當 Type 為 SQL 且已傳入 TemplateId 時本參數不生效。

t_order

StartTime

integer

是

查詢起始時間,Unix 時間戳記,單位毫秒。系統按分鐘向下取整。

說明

距今不得超過 30 天;若早於該執行個體 SQL 洞察的開啟時間,會被自動收斂到開啟時間。

1718000000000

EndTime

integer

是

查詢結束時間,Unix 時間戳記,單位毫秒。系統按分鐘向上取整。

說明

與 StartTime 的跨度不得超過 7 天。若 EndTime 早於該執行個體 SQL 洞察的開啟時間,會返回查詢時間早於可用時間的錯誤。

說明

由於資料匯聚存在延遲,實際生效值會被裁剪到當前時間前推若干分鐘,因此最近幾分鐘的資料可能查詢不到。

1718600000000

OrderBy

string

否

排序欄位。不傳或傳入不支援的取值時按 rt(總耗時)排序。取值:

  • 耗時類:rt、avgRt、maxRt、minRt、rtRate。

  • 執行次數類:count、countRate、timestamp。

  • 掃描行數類:rowsExamined、avgRowsExamined。

  • 返回行數類:rowsReturned、totalRowsReturned、avgRowsReturned、maxRowsReturned、minRowsReturned、maxRowReturned、minRowReturned。

  • 邏輯讀取類:logicalRead、totalLogicalRead、avgLogicalRead、maxLogicalRead、minLogicalRead。

  • 實體讀取類:physicalRead、totalPhysicalRead、avgPhysicalRead、maxPhysicalRead、minPhysicalRead。

  • 邏輯寫入類(僅 SQL Server 執行個體有效):writes、totalWrites、avgWrites、maxWrites、minWrites。

  • CPU 耗時類(僅 SQL Server 執行個體有效):totalCpuTime、avgCpuTime、maxCpuTime、minCpuTime。

  • PolarDB-X 運算節點類(僅 Role 為polarx_cn時有效):scnt、avgScnt、rows、avgRows、frows、avgFrows。

  • 影響行數類(僅 Lindorm 執行個體有效):totalAffectRows、avgAffectRows。

說明

timestamp 表示按資料時間戳記排序,該時間戳記為毫秒級 Unix 時間戳記。

說明

僅首字母大小寫不敏感,其餘字元需與上述取值完全一致,例如 AvgRt 有效而 avgrt 無效。

rt

Asc

boolean

否

排序方向,預設為 false(降序)。取值:

  • true:升序。

  • false:降序。

false

PageNo

integer

否

分頁頁碼,從 1 開始。不傳時按 1 處理。

1

PageSize

integer

否

每頁返回的統計項目數。不傳時按 10 處理,最大不超過 2000。

說明

超過 2000 會返回參數錯誤 InvalidParams,而不是被裁剪。

說明

按存取來源或資料庫使用者維度聚合(Type 為 FullRequestOrigin 或 FullRequestUser)時,部分匯聚儲存鏈路下超過 100 會被重置為 10。

20

DoFillTrend

boolean

否

是否為每條統計結果填充時間序列趨勢資料,即返回結果中的 Trend 欄位,預設為 true。取值:

  • true:填充趨勢資料。

  • false:不填充趨勢資料。

說明

開啟後會針對每條結果額外查詢各時間片的資料,查詢開銷明顯增加;若執行個體未開啟趨勢填充能力,本參數不生效。

true

SqlType

string

否

按 SQL 類型過濾。取值:

  • select

  • insert

  • update

  • delete

說明

取值為小寫。部分執行個體的匯聚儲存鏈路下支援英文逗號分隔傳入多個取值,其餘鏈路只支援傳入單個取值。

select

DbName

string

否

按資料庫名稱過濾。

說明

部分執行個體的匯聚儲存鏈路下支援英文逗號分隔傳入多個,其餘鏈路只支援傳入單個資料庫名稱。

db_test

Role

string

否

執行個體節點角色,取值不區分大小寫。不傳時由 InstanceId 自動解析。取值:

  • polarx_cn:PolarDB-X 運算節點。

  • polarx_dn:PolarDB-X 儲存節點。

說明

該取值會影響返回欄位的填充範圍,例如 Scnt、Rows、Frows 僅在polarx_cn下返回。

polarx_cn

JobId

string

否

SQL 洞察資料查詢冪等 ID,普通查詢無需傳入。

9a4f5c4494dbd6713185d87a97aa53e8

Filters

array<object>

否

結構化過濾條件清單,以 Key/Value 鍵值對形式傳入,POP 線格式為Filters.N.Key與Filters.N.Value,最多 100 組。Key 不區分大小寫,Value 為空的項目會被忽略。本介面生效的 Key 取值:

  • keyWord:關鍵字,按空白字元拆分為多個詞,與 Keyword 參數合併生效。

  • hostAddress:存取來源位址,英文逗號分隔多個,與 Type 為 OriginHost 時的 TemplateId 合併生效。

  • accountName:資料庫使用者名稱,英文逗號分隔多個。

  • dbName:資料庫名稱,英文逗號分隔多個,與 DbName 參數合併生效。

  • sqlType:SQL 類型,英文逗號分隔多個,與 SqlType 參數合併生效。

  • sqlId:SQL 範本 ID,英文逗號分隔多個,與 Type 為 SQL 時的 TemplateId 合併生效。

  • insRole:主備角色,取值 master 或 slave,該取值區分大小寫。

說明

傳入上述之外的 Key 會被忽略。

說明

本參數僅在部分執行個體的匯聚儲存鏈路下生效,其餘鏈路會整體忽略該參數。

object

否

Key

string

否

過濾條件的鍵,不區分大小寫。可用取值見 Filters 參數說明。

sqlType

Value

string

否

過濾條件的值,為 null 或空字串時該條過濾條件被忽略。多個值以英文逗號分隔,具體上限取決於對應的鍵。

select

返回參數

名稱

類型

描述

樣本值

object

Code

string

回應狀態碼。

200

Data

object

非同步查詢結果信封。首次呼叫返回 ResultId 與 State,需攜帶完全相同的請求參數輪詢,直到 State 為 SUCCESS 後從 List 中取得統計明細。

Data

object

SQL 洞察統計查詢結果。

說明

僅當 State 為 SUCCESS 時返回。

Extra

any

擴充資訊。

說明

本介面不返回該欄位。

{}

List

array<object>

SQL 洞察統計結果清單,每個元素為一個聚合維度下的統計項目。

array<object>

AffectRows

integer

單條 SQL 的影響行數。SELECT 表示掃描行數,DML 表示影響行數。

說明

僅 Lindorm 執行個體返回。

30

AggKey

string

本次統計的聚合維度取值,隨請求參數 Type 變化。取值:

  • 按 SQL 範本聚合時:SQL 範本 ID,與 SqlId 一致。

  • Type 為 FullRequestOrigin 時:存取來源位址。

  • Type 為 FullRequestUser 時:資料庫使用者名稱。

651b56fe9418d48edb8fdf0980ec****

AvgAffectRows

number

平均影響行數。

說明

僅 Lindorm 執行個體返回,其他引擎為 null。

30.2

AvgCpuTime

number

SQL 執行消耗的平均 CPU 耗時,單位微秒。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

12.5

AvgFrows

number

PolarDB-X 計算節點從資料節點拉取的平均行數。

說明

為 PolarDB-X 計算節點專屬指標,其他引擎為 null 或 0。

10

AvgLockWaitTime

number

單次執行的平均鎖定等待耗時,單位毫秒。

說明

僅在 Version 為 1 時有資料。

0.00009589874265269765

AvgLogicalRead

number

單次執行的平均邏輯讀取次數。

說明

僅在 Version 為 1 時有資料。

654.4470327860251

AvgPhysicalAsyncRead

number

單次執行的平均實體非同步讀取次數。

說明

僅在 Version 為 1 時有資料。

0

AvgPhysicalRead

number

平均實體讀取次數。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

654.4

AvgPhysicalSyncRead

number

單次執行的平均實體同步讀取次數。

說明

僅在 Version 為 1 時有資料。

0

AvgRows

number

PolarDB-X 計算節點的平均更新行數與返回行數。

說明

為 PolarDB-X 計算節點專屬指標,其他引擎為 null 或 0。

10

AvgRowsExamined

number

單次執行的平均掃描行數。

53421.0

AvgRowsReturned

number

單次執行的平均返回行數。

14

AvgRowsUpdated

number

單次執行的平均更新行數。

30.2

AvgRt

number

單次執行的平均耗時,單位毫秒。

2.499

AvgScanRows

number

平均掃描行數。

說明

本介面不返回該欄位,平均掃描行數請使用 AvgRowsExamined。

53421.0

AvgScnt

number

PolarDB-X 計算節點下發到資料節點的平均請求數。

說明

為 PolarDB-X 計算節點專屬指標,其他引擎為 null 或 0。

10

AvgWrites

number

平均邏輯寫入次數。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

10

Count

integer

該 SQL 範本在統計區間內的執行總次數。

127

CountRate

number

該條統計的執行次數占執行個體全部 SQL 執行次數的比例,取值範圍為 0 到 1。

0.0586

CpuTime

integer

SQL 執行消耗的 CPU 耗時合計,單位微秒。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

100

Database

string

該 SQL 執行所在的資料庫名稱。

dbtest01

ErrorCode

string

SQL 執行返回的錯誤碼。

說明

錯誤碼屬於單條 SQL 明細資訊,本介面返回的是範本維度的聚合統計,不返回該欄位;發生錯誤情況請使用 ErrorCount。

1146

ErrorCount

integer

該 SQL 範本在統計區間內執行發生錯誤的次數。

1

FirstTime

integer

SQL 範本首次出現的時間。

說明

本介面不返回該欄位。

1659308149000

Frows

integer

PolarDB-X 計算節點從資料節點拉取的行數合計。

說明

為 PolarDB-X 計算節點專屬指標,其他引擎為 null 或 0。

10

Hash

string

SQL 範本雜湊值,隨 SQL 範本一併返回。

說明

該值由 PolarDB-X 計算節點核心輸出,非 PolarDB-X 計算節點執行個體為空。

2e8147b5ca2dfc640dfd5e43d96a****

Ip

string

統計資料所屬執行個體的連線位址。

說明

是否返回取決於執行個體的匯聚儲存鏈路,部分鏈路下為 null。

rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com

LockWaitTime

number

鎖定等待耗時合計,單位毫秒。

說明

僅在 Version 為 1 時有資料。

1089.4177720290281

LogicalRead

number

邏輯讀取次數合計。

說明

僅在 Version 為 1 時有資料。

165848

MaxCpuTime

integer

單次執行中 CPU 耗時的最大值,單位微秒。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

30

MaxLogicalRead

integer

單次執行中邏輯讀取次數的最大值。

說明

僅在 Version 為 1 時有資料。

3186

MaxPhysicalRead

integer

單次執行中實體讀取次數的最大值。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

3186

MaxRowsExamined

integer

單次執行中掃描行數的最大值。

說明

本介面不返回該欄位,掃描行數請使用 RowsExamined 與 AvgRowsExamined。

318613

MaxRowsReturned

integer

單次執行中返回行數的最大值。

20

MaxRt

number

單次執行的最大耗時,單位毫秒。

12.499

MaxWrites

integer

單次執行中邏輯寫入次數的最大值。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

12

MinCpuTime

integer

單次執行中 CPU 耗時的最小值,單位微秒。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

5

MinLogicalRead

integer

單次執行中邏輯讀取次數的最小值。

說明

僅在 Version 為 1 時有資料。

12

MinPhysicalRead

integer

單次執行中實體讀取次數的最小值。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

12

MinRowsReturned

integer

單次執行中返回行數的最小值。

1

MinRt

number

單次執行的最小耗時,單位毫秒。

0.409789

MinWrites

integer

單次執行中邏輯寫入次數的最小值。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

8

OriginAlias

string

為存取來源位址設定的顯示別名。

說明

僅在按存取來源聚合(Type 為 FullRequestOrigin)時返回,其他情境為 null。

order-1

OriginHost

string

發起該 SQL 的用戶端來源位址。

說明

當 Type 為 FullRequestOrigin 時,該欄位即為這條統計的聚合維度。

172.26.XX.XXX

Params

string

SQL 範例的參數內容。

說明

本介面返回的是範本維度的聚合統計,不返回該欄位。

[1, "das"]

PhysicalAsyncRead

number

實體非同步讀取次數合計。

說明

僅在 Version 為 1 時有資料。

0

PhysicalRead

integer

實體讀取次數合計。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

165848

PhysicalSyncRead

number

實體同步讀取次數合計。

說明

僅在 Version 為 1 時有資料。

0

Port

integer

統計資料所屬執行個體的連線連接埠。

說明

是否返回取決於執行個體的匯聚儲存鏈路,部分鏈路下為 null。

3306

Psql

string

參數化後的 SQL 範本文字,即把 SQL 中的常數替換為佔位符後的語句。

select * from t_order where id = ?

Rows

integer

PolarDB-X 運算節點的更新行數與返回行數合計。

說明

為 PolarDB-X 運算節點專屬指標,其他引擎為 null 或 0。

10

RowsExamined

integer

該 SQL 範本在統計區間內的掃描行數合計。

2048576

RowsReturned

integer

該 SQL 範本在統計區間內的返回行數合計。

14

Rt

number

該 SQL 範本在統計區間內的總耗時,單位毫秒。

說明

PolarDB-X 運算節點(Role 為 polarx_cn)在核心版本早於 5.4.13 時,該值由微秒換算為毫秒。

0.409789

RtGreaterThanOneSecondCount

integer

執行耗時超過 1 秒的次數。

說明

是否返回取決於執行個體的匯聚儲存鏈路,部分鏈路下為 null。

20

RtRate

number

該條統計的總耗時佔執行個體全部 SQL 總耗時的比例,取值範圍為 0 到 1。

0.1384

SampleType

string

樣本資料的類型標識。

說明

本介面返回的是聚合統計,不返回該欄位。

sql

ScanRows

integer

單條 SQL 的掃描行數。

說明

本介面返回的是範本維度的聚合統計,不返回該欄位,請使用聚合指標 RowsExamined 與 AvgRowsExamined。

29

Scnt

integer

PolarDB-X 運算節點下發到資料節點的請求總數。

說明

為 PolarDB-X 運算節點專屬指標,其他引擎為 null 或 0。

10

Sql

string

原始 SQL 文字。

說明

統計結果返回的是 SQL 範本(Psql),不返回該欄位。

select * from t_order where id = 1

SqlId

string

SQL 範本 ID,唯一標識一類參數化後的 SQL 語句。同一範本下的多次執行會被聚合為一條統計,可用該 ID 在多維度查詢間關聯同一類 SQL。

651b56fe9418d48edb8fdf0980ec****

SqlNew

string

對參數值做統一處理後的 SQL 文字,用於樣本資料場景。

說明

本介面不返回該欄位。

select * from t_order where id = ?

SqlTextFeature

string

SQL 文字特徵值,用於 SQL 分析場景。

說明

本介面不返回該欄位。

select_from_t_order

SqlType

string

SQL 類型。取值:

  • select

  • insert

  • update

  • delete

  • other

select

SumRowsUpdated

number

該 SQL 範本在統計區間內的更新行數合計。

3810

Tables

array

該 SQL 涉及的資料表名稱清單。

string

該 SQL 涉及的資料表名稱。

t_order

ThreadId

string

執行該 SQL 的資料庫執行緒 ID。

說明

執行緒 ID 屬於單條 SQL 明細資訊,本介面返回的是範本維度的聚合統計,不返回該欄位。

57472578

TimeRate

number

耗時佔比。

說明

本介面透過 RtRate 返回耗時佔比,不返回該欄位。

0.1384

Timestamp

integer

資料時間戳記,Unix 時間戳記,單位毫秒。

說明

統計結果按 SQL 範本維度彙總,不返回該欄位。

1718600000000

TotalAffectRows

integer

影響行數合計。

說明

僅 Lindorm 執行個體返回,其他引擎為 null。

3810

TotalRt

integer

SQL 執行總耗時。

說明

本介面不返回該欄位,總耗時請使用 Rt。

310

TotalScanRows

integer

掃描行數合計。

說明

本介面不返回該欄位,掃描行數合計請使用 RowsExamined。

2048576

Trend

array<object>

該 SQL 範本在查詢時間窗內按時間片劃分的執行次數趨勢序列。

說明

僅當請求參數 DoFillTrend 為 true 且執行個體已開啟趨勢填充能力時返回;時間片間隔由查詢跨度自動決定,無資料的時間片可能補零。

object

Timestamp

integer

趨勢點的時間戳記,Unix 時間戳記,單位毫秒。

1718000000000

Value

any

該時間片內的 SQL 執行次數。

12

UpdateRows

integer

單條 SQL 的更新行數。

說明

本介面返回的是範本維度的聚合統計,不返回該欄位,請使用聚合指標 SumRowsUpdated 與 AvgRowsUpdated。

30

User

string

執行該 SQL 的資料庫使用者名稱。

說明

當 Type 為 FullRequestUser 時,該欄位即為這條統計的聚合維度。

testUser

Version

integer

SQL 洞察資料採集鏈路版本。執行個體採集到邏輯讀或鎖等待資料時返回 1,否則返回 0。取值:

  • 0:V0 基礎採集鏈路。

  • 1:V1 採集鏈路,在 V0 基礎上額外採集 LockWaitTime、LogicalRead、PhysicalSyncRead、PhysicalAsyncRead 四類指標。

說明

返回 0 時上述擴充指標無資料。

1

VpcId

string

統計資料所屬執行個體的專有網路 VPC ID。

說明

是否返回取決於執行個體的匯聚儲存鏈路,部分鏈路下為 null。

vpc-2zentqj1sk4qmolci****

Writes

integer

邏輯寫入次數合計。

說明

為 SQL Server 執行個體專屬指標,其他引擎為 null。

10

PageNo

integer

目前頁碼,與請求參數 PageNo 對應。

1

PageSize

integer

每頁返回的筆數,與請求參數 PageSize 對應。

10

Total

integer

滿足查詢條件的統計項目總數,可用於分頁計算。

10

ErrorCode

integer

非同步查詢失敗的錯誤碼。

說明

僅在查詢失敗時返回。

-10200020

IsFinish

boolean

非同步查詢是否已結束。取值:

  • true:State 為 SUCCESS 或 FAIL。

  • false:State 為 RUNNING。

Message

string

非同步查詢失敗的錯誤描述。

說明

僅在查詢失敗時返回。

startTime must be in 30 days and the interval must be within 7 day

RequestKey

string

請求參數的雜湊標識。

說明

本介面不返回該欄位,請使用 ResultId 標識非同步查詢。

507044db6c4eadfa2dab9b084e80****

ResultId

string

非同步查詢結果 ID,形如 async_ 前綴加一串雜湊值,由本次請求的全部業務參數計算得出。

說明

相同參數重複呼叫會命中同一份查詢結果,因此輪詢時必須攜帶與首次呼叫完全相同的請求參數;任一參數變化都會產生不同的 ResultId 並觸發一次全新的查詢。

async__507044db6c4eadfa2dab9b084e80****

State

string

非同步查詢的目前狀態。取值:

  • RUNNING:執行中,需繼續輪詢。

  • SUCCESS:執行成功,此時 Data 才有值。

  • FAIL:執行失敗。

說明

查詢失敗時介面會直接返回錯誤碼與錯誤資訊,而非 State 為 FAIL 的正常回應體。

SUCCESS

Timestamp

integer

提交本次非同步查詢的時間,Unix 時間戳記,單位毫秒。

說明

查詢失敗時該值為失敗發生的時間。

1718600000000

Message

string

回應資訊。請求失敗時返回錯誤描述。

Successful

RequestId

string

本次請求的唯一標識,可用於問題排查。

B6D17591-B48B-4D31-9CD6-9B9796B2****

Success

string

本次請求是否成功。取值:

  • true:成功。

  • false:失敗,此時結合 Code 與 Message 判斷原因。

true

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Data": {
    "Data": {
      "Extra": "{}",
      "List": [
        {
          "AffectRows": 30,
          "AggKey": "651b56fe9418d48edb8fdf0980ec****",
          "AvgAffectRows": 30.2,
          "AvgCpuTime": 12.5,
          "AvgFrows": 10,
          "AvgLockWaitTime": 0.00009589874265269765,
          "AvgLogicalRead": 654.4470327860251,
          "AvgPhysicalAsyncRead": 0,
          "AvgPhysicalRead": 654.4,
          "AvgPhysicalSyncRead": 0,
          "AvgRows": 10,
          "AvgRowsExamined": 53421,
          "AvgRowsReturned": 14,
          "AvgRowsUpdated": 30.2,
          "AvgRt": 2.499,
          "AvgScanRows": 53421,
          "AvgScnt": 10,
          "AvgWrites": 10,
          "Count": 127,
          "CountRate": 0.0586,
          "CpuTime": 100,
          "Database": "dbtest01",
          "ErrorCode": "1146",
          "ErrorCount": 1,
          "FirstTime": 1659308149000,
          "Frows": 10,
          "Hash": "2e8147b5ca2dfc640dfd5e43d96a****",
          "Ip": "rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com",
          "LockWaitTime": 1089.4177720290281,
          "LogicalRead": 165848,
          "MaxCpuTime": 30,
          "MaxLogicalRead": 3186,
          "MaxPhysicalRead": 3186,
          "MaxRowsExamined": 318613,
          "MaxRowsReturned": 20,
          "MaxRt": 12.499,
          "MaxWrites": 12,
          "MinCpuTime": 5,
          "MinLogicalRead": 12,
          "MinPhysicalRead": 12,
          "MinRowsReturned": 1,
          "MinRt": 0.409789,
          "MinWrites": 8,
          "OriginAlias": "order-1",
          "OriginHost": "172.26.XX.XXX",
          "Params": "[1, \"das\"]",
          "PhysicalAsyncRead": 0,
          "PhysicalRead": 165848,
          "PhysicalSyncRead": 0,
          "Port": 3306,
          "Psql": "select * from t_order where id = ?",
          "Rows": 10,
          "RowsExamined": 2048576,
          "RowsReturned": 14,
          "Rt": 0.409789,
          "RtGreaterThanOneSecondCount": 20,
          "RtRate": 0.1384,
          "SampleType": "sql",
          "ScanRows": 29,
          "Scnt": 10,
          "Sql": "select * from t_order where id = 1",
          "SqlId": "651b56fe9418d48edb8fdf0980ec****",
          "SqlNew": "select * from t_order where id = ?",
          "SqlTextFeature": "select_from_t_order",
          "SqlType": "select",
          "SumRowsUpdated": 3810,
          "Tables": [
            "t_order"
          ],
          "ThreadId": "57472578",
          "TimeRate": 0.1384,
          "Timestamp": 1718600000000,
          "TotalAffectRows": 3810,
          "TotalRt": 310,
          "TotalScanRows": 2048576,
          "Trend": [
            {
              "Timestamp": 1718000000000,
              "Value": "12"
            }
          ],
          "UpdateRows": 30,
          "User": "testUser",
          "Version": 1,
          "VpcId": "vpc-2zentqj1sk4qmolci****",
          "Writes": 10
        }
      ],
      "PageNo": 1,
      "PageSize": 10,
      "Total": 10
    },
    "ErrorCode": -10200020,
    "IsFinish": false,
    "Message": "startTime must be in 30 days and the interval must be within 7 day",
    "RequestKey": "507044db6c4eadfa2dab9b084e80****",
    "ResultId": "async__507044db6c4eadfa2dab9b084e80****",
    "State": "SUCCESS",
    "Timestamp": 1718600000000
  },
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

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