获取查询Explain
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBInstanceId |
string |
是 |
数据库实例 ID。 |
selectdb-cn-7213cjv**** |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| QueryId |
string |
否 |
查询 ID。 |
40e8a568-d2a2-4f7e-a3f8-cec554ce5143 |
| Mode |
string |
否 |
Explain 模式。 |
BASIC |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PlainResponse |
||
| RequestId |
string |
请求 ID。 |
F8900A96-67F7-5274-A41B-7722E1ECF8C9 |
| Sql |
string |
待查询执行计划的 SQL。审计日志中过长的 SQL 可能被截断。 |
SELECT * FROM example_db.example_tbl |
| ExplainResult |
string |
Explain 结果。 |
+-----------------------------------------------------------------------+ | Explain String| +-----------------------------------------------------------------------+ | PLAN FRAGMENT 0 | |OUTPUT EXPRS: | | name[#1] | | age[#2] | | PARTITION: UNPARTITIONED | | | | VRESULT SINK | | | | 1:VEXCHANGE | | offset: 0 | | | | PLAN FRAGMENT 1 | | | | PARTITION: HASH_PARTITIONED: id[#0] | | | | STREAM DATA SINK | | EXCHANGE ID: 01| | UNPARTITIONED | | | | 0:VOlapScanNode | | TABLE: example_db.example_tbl(example_tbl) | | PREAGGREGATION: ON | | PREDICATES: (age[#2] > 18) | | cardinality=1, avgRowSize=20.0, numNodes=1 | | tablet list: 10023, 10025, 10027 | +-----------------------------------------------------------------------+ |
示例
正常返回示例
JSON格式
{
"RequestId": "F8900A96-67F7-5274-A41B-7722E1ECF8C9",
"Sql": "SELECT * FROM example_db.example_tbl",
"ExplainResult": "+-----------------------------------------------------------------------+\n| Explain String|\n+-----------------------------------------------------------------------+\n| PLAN FRAGMENT 0 |\n|OUTPUT EXPRS: |\n| name[#1] |\n| age[#2] |\n| PARTITION: UNPARTITIONED |\n| |\n| VRESULT SINK |\n| |\n| 1:VEXCHANGE |\n| offset: 0 |\n| |\n| PLAN FRAGMENT 1 |\n| |\n| PARTITION: HASH_PARTITIONED: id[#0] |\n| |\n| STREAM DATA SINK |\n| EXCHANGE ID: 01|\n| UNPARTITIONED |\n| |\n| 0:VOlapScanNode |\n| TABLE: example_db.example_tbl(example_tbl) |\n| PREAGGREGATION: ON |\n| PREDICATES: (age[#2] > 18) |\n| cardinality=1, avgRowSize=20.0, numNodes=1 |\n| tablet list: 10023, 10025, 10027 |\n+-----------------------------------------------------------------------+"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | 文档转换失败，文件大小超过系统限额。 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | 子账号权限不足，请先获取授权。 |
| 400 | InvalidDBName | The specified database name is not allowed. | 数据库名称不符合要求，请确认数据名称是否正确。 |
| 400 | CreateOrderFailed | Failed to create order. | 创建订单失败。 |
| 400 | InvalidDBInstanceId.Malformed | The specified parameter "DBInstanceId" is not valid. | 参数"DBInstanceId"不合法。 |
| 400 | InvalidParameters.Format | Specified parameters is not valid. | 传入参数不是有效的参数 |
| 400 | InvalidParameter | Specified parameter is not valid. | 指定的参数无效。 |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | 当集群未运行时，无法执行请求的操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | 操作失败，实例引擎和类型不支持该操作。 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | 指定的实例状态不支持此操作。 |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | 当前阿里云账号余额不足100，请充值。 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | 操作失败，数据库与权限的数量不一致。 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | 资源不足，请您稍后再试。 |
| 403 | IncorrectEngineVersion | Current engine version does not support operations. | 当前版本不支持此操作。 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 当前内核小版本不支持此操作。 |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | 操作失败，当前实例已锁定。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | 没有找到指定的实例，请检查实例的正确性。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | 当前选择的配置或规格不存在或已停售，请重新选择。 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | 操作失败，输入的地域及可用区不存在。 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | 询价失败，请联系客服同学。 |
| 404 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in our records. | SelectDB实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。