调用DescribeSQLPlan接口查询目标SQL,例如查询语句或ETL(Extract Transform Load)任务语句的计划信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:DescribeSQLPlan | get | *DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情,包括集群 ID。
| am-**************** |
ProcessId | string | 是 | 任务 ID。 说明
您可以调用 DescribeProcessList 接口查看目标 SQL 的任务 ID。
| 202105271604431720161662490345******* |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "22D6DEF0-CBC7-4388-A41C-D5FD62******",
"StageList": [
{
"State": "FINISHED",
"CPUTimeAvg": 5984,
"CPUTimeMax": 5984,
"OperatorCost": 5984,
"ScanTimeMax": 0,
"InputSizeMax": 173,
"StageId": 1,
"ScanSizeMax": 0,
"CPUTimeMin": 47,
"ScanTimeMin": 0,
"ScanSizeMin": 0,
"InputSizeMin": 173,
"PeakMemory": 74208,
"ScanTimeAvg": 0,
"ScanSizeAvg": 0,
"InputSizeAvg": 173
}
],
"OriginInfo": "{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"session\\\":{\\\"queryId\\\":\\\"20210527_160443_10581_hdhzr\\\",\\\"hasSharedStage\\\":false,\\\"parentId\\\":0}}",
"Detail": {
"SQL": "INSERT OVERWRITE INTO hdfs_import_external\\nSELECT *\\nFROM adb_hdfs_import_source",
"OutputSize": 9,
"State": "FINISHED",
"OutputRows": 1,
"User": "test_acc",
"StartTime": "1622102683243",
"TotalStage": 4,
"QueuedTime": 0,
"TotalTime": 2340,
"TotalTask": 4,
"Database": "adb_demo",
"PeakMemory": 441802,
"ClientIP": "172.16.***.***",
"PlanningTime": 86,
"CPUTime": 6100
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史