調用DescribeQueryExplain API查詢SQL執行計畫-資料庫自治服務-阿里雲

查詢SQL的執行計畫。

介面說明

當前僅支援 RDS MySQL 和 PolarDB MySQL 執行個體查詢 SQL 的執行計畫。
使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。
在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:DescribeQueryExplain

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	rm-2ze8g2am97624****
NodeId	string	否	節點 ID。說明對於 PolarDB MySQL 版執行個體，若提供節點 ID，將到指定節點查詢執行計畫，否則將在備節點查詢執行計畫。對於 RDS MySQL 高可用執行個體，若將執行個體 ID 傳入，將到指定節點查詢執行計畫，否則將在備節點查詢執行計畫。	pi-bp1v203xzzh0a****
Sql	string	是	待查詢執行計畫的 SQL。	select * from test where name = 'mockUser'
DbName	string	否	資料庫名。	dbtest01
Schema	string	否	schema 資訊，預留參數。	無

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Code	string	返回的狀態代碼，200 表示成功。	200
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true
Data	array<object>	List
	object	返回資料。
Id	string	查詢 ID。	1
SelectType	string	查詢類型。	SIMPLE
Table	string	表名。	test
Type	string	Join 類型。	eq_ref
PossibleKeys	string	可能被選擇的索引。	test_idx
Key	string	執行計畫中，實際選擇的索引。	PRIMARY
KeyLen	string	實際選擇索引的長度。	3
Ref	string	索引所用的列。	test_column
Rows	string	待掃描行數。	1000
Extra	string	附加資訊。	無
QueryPlan	string	保留欄位，用於 PG 引擎。	無
TableList	array	保留欄位，用於 PG 引擎。
	string	保留欄位，用於 PG 引擎。	無
IndexList	array	保留欄位，用於 PG 引擎。
	string	保留欄位，用於 PG 引擎。	無
LogicalPlanList	array	保留欄位，用於 PolarDB X 引擎。
	string	保留欄位，用於 PolarDB X 引擎。	無
StmtText	string	保留欄位，用於 SQLServer 引擎。	無
StmtId	string	保留欄位，用於 SQLServer 引擎。	無
NodeId	string	保留欄位，用於 SQLServer 引擎。	無
Parent	string	保留欄位，用於 SQLServer 引擎。	無
PhysicalOp	string	保留欄位，用於 SQLServer 引擎。	無
LogicalOp	string	保留欄位，用於 SQLServer 引擎。	無
Argument	string	保留欄位，用於 SQLServer 引擎。	無
DefinedValues	string	保留欄位，用於 SQLServer 引擎。	無
EstimateRows	string	保留欄位，用於 SQLServer 引擎。	無
EstimateIO	string	保留欄位，用於 SQLServer 引擎。	無
EstimateCPU	string	保留欄位，用於 SQLServer 引擎。	無
AvgRowSize	string	保留欄位，用於 SQLServer 引擎。	無
TotalSubtreeCost	string	保留欄位，用於 SQLServer 引擎。	無
OutputList	string	保留欄位，用於 SQLServer 引擎。	無
Warnings	string	保留欄位，用於 SQLServer 引擎。	無
Parallel	string	保留欄位，用於 SQLServer 引擎。	無
EstimateExecutions	string	保留欄位，用於 SQLServer 引擎。	無

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": [
    {
      "Id": "1",
      "SelectType": "SIMPLE",
      "Table": "test",
      "Type": "eq_ref",
      "PossibleKeys": "test_idx",
      "Key": "PRIMARY",
      "KeyLen": "3",
      "Ref": "test_column",
      "Rows": "1000",
      "Extra": "無",
      "QueryPlan": "無",
      "TableList": [
        "無"
      ],
      "IndexList": [
        "無"
      ],
      "LogicalPlanList": [
        "無"
      ],
      "StmtText": "無",
      "StmtId": "無",
      "NodeId": "無",
      "Parent": "無",
      "PhysicalOp": "無",
      "LogicalOp": "無",
      "Argument": "無",
      "DefinedValues": "無",
      "EstimateRows": "無",
      "EstimateIO": "無",
      "EstimateCPU": "無",
      "AvgRowSize": "無",
      "TotalSubtreeCost": "無",
      "OutputList": "無",
      "Warnings": "無",
      "Parallel": "無",
      "EstimateExecutions": "無"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.	請求參數錯誤

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

變更歷史

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