SQL ステートメントの実行計画を取得します。
操作説明
この操作は、ApsaraDB RDS for MySQL および PolarDB for MySQL インスタンスのみをサポートしています。
Alibaba Cloud または DAS SDK を使用する場合は、最新バージョンを使用してください。
SDK で DAS サービスを呼び出す際は、リージョンを cn-shanghai に設定してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hdm:DescribeQueryExplain |
get |
*All Resource
|
なし | なし |
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンスの ID。 |
rm-2ze8g2am97624**** |
| NodeId |
string |
任意 |
ノードの ID。 説明
PolarDB for MySQL インスタンスの場合、ノード ID を指定すると、システムはそのノードで実行計画をクエリします。指定しない場合、セカンダリノードで実行計画をクエリします。高可用性 ApsaraDB RDS for MySQL インスタンスの場合、インスタンス ID を指定すると、システムはそのノードで実行計画をクエリします。指定しない場合、セカンダリノードで実行計画をクエリします。 |
pi-bp1v203xzzh0a**** |
| Sql |
string |
必須 |
実行計画を取得する SQL ステートメント。 |
select * from test where name = 'mockUser' |
| DbName |
string |
任意 |
データベース名。 |
dbtest01 |
| Schema |
string |
任意 |
スキーマ情報。これは予約済みのパラメーターです。 |
无 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ |
||
| Code |
string |
返された状態コード。値が 200 の場合は成功を示します。 |
200 |
| Message |
string |
応答メッセージ。 説明
リクエストが成功した場合、このパラメーターは Successful を返します。リクエストが失敗した場合、このパラメーターはエラーコードなどの詳細を返します。 |
Successful |
| RequestId |
string |
リクエストの ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
リクエストが成功したかどうかを示します。
|
true |
| Data |
array<object> |
実行計画のリスト。 |
|
|
object |
返されたデータ。 |
||
| Id |
string |
クエリの ID。 |
1 |
| SelectType |
string |
クエリのタイプ。 |
SIMPLE |
| Table |
string |
テーブル名。 |
test |
| Type |
string |
結合タイプ。 |
eq_ref |
| PossibleKeys |
string |
使用される可能性のあるインデックス。 |
test_idx |
| Key |
string |
実行計画で実際に使用されたインデックス。 |
PRIMARY |
| KeyLen |
string |
実際に使用されたインデックスの長さ。 |
3 |
| Ref |
string |
インデックスによって使用されるカラム。 |
test_column |
| Rows |
string |
スキャンする行数。 |
1000 |
| Extra |
string |
追加情報。 |
无 |
| QueryPlan |
string |
PostgreSQL エンジン用の予約済みフィールド。 |
无 |
| TableList |
array |
PostgreSQL エンジン用の予約済みフィールド。 |
|
|
string |
PostgreSQL エンジン用の予約済みフィールド。 |
无 |
|
| IndexList |
array |
PostgreSQL エンジン用の予約済みフィールド。 |
|
|
string |
PostgreSQL エンジン用の予約済みフィールド。 |
无 |
|
| LogicalPlanList |
array |
PolarDB X エンジン用の予約済みフィールド。 |
|
|
string |
PolarDB X エンジン用の予約済みフィールド。 |
无 |
|
| StmtText |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| StmtId |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| NodeId |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| Parent |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| PhysicalOp |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| LogicalOp |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| Argument |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| DefinedValues |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| EstimateRows |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| EstimateIO |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| EstimateCPU |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| AvgRowSize |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| TotalSubtreeCost |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| OutputList |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| Warnings |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| Parallel |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
| EstimateExecutions |
string |
SQL Server エンジン用の予約済みフィールド。 |
无 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。