調用DescribeSQLPlan接口查詢目標SQL，例如查詢語句或ETL（Extract Transform Load）任務語句的計劃信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| adb:DescribeSQLPlan | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史