獲取Spark App指標數據。
接口說明
- 地域的公網接入地址：
adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。 - 地域的 VPC 接入地址：
adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。
說明
如果華北 1（青島）、華南 1（深圳）、華南 3（廣州）、中國香港發起請求時，遇到 409 錯誤，請聯系技術支持。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| adb:GetSparkAppMetrics | get | *SparkApplication acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 應用 ID。 | s202204221525hzca7d8140000003 |
| DBClusterId | string | 否 | 企業版、基礎版或湖倉版集群 ID。 說明
您可以調用 DescribeDBClusters 接口查詢目標地域中所有集群的集群 ID。
| amv-bp1ggnu61d77**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Data": {
"AppId": "s202302051515shfa865f8000****",
"AttemptId": "s202301061000hz57d797b0000201-****",
"Finished": true,
"EventLogPath": "oss://path/to/eventLog",
"ScanMetrics": {
"OutputRowsCount": 1000,
"TotalReadFileSizeInByte": 10000
}
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Spark.InvalidState | The object of the operation is in an invalid state: %s | 操作對象處于非合法狀態。 |
| 400 | Spark.InvalidParameter | Invalid parameter value: %s | 輸入參數不正確: %s。 |
| 400 | Spark.AnalyzeTask.AppStateNotAccepted | Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement. | 只允許分析處于終止狀態的 Spark app。指定 app 不滿足條件。 |
| 400 | Spark.AnalyzeTask.FailedToKill | Failed to terminate the Spark log analysis task %s, because the task status has changed. Obtain the latest status and try again. | 殺死Spark日志分析任務的請求執行失敗，因為對應任務狀態已經發生了變化。請獲取分析任務最新狀態后執行。 |
| 400 | Spark.AnalyzeTask.InvalidStateWhenAnalyzingApp | Only logs of Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement. | 僅允許針對處于終止狀態的Spark作業執行日志分析程序。當前作業不滿足條件。 |
| 400 | Spark.App.InvalidResourceSpec | The requested resource type is not supported:\n %s | - |
| 400 | Spark.App.KillOperationFailed | Failed to kill the application %s, please retry in a few seconds. | 殺死 Spark 應用失敗，請稍后重試。 |
| 400 | Spark.App.ParameterConflict | Conflicting parameters submitted:\n %s | - |
| 400 | Spark.CancelNotebookStatementFailed | Failed to cancel the execution of notebook statements. | - |
| 400 | Spark.CloseNotebookKernelFailed | Failed to disable the notebook kernel. | - |
| 400 | Spark.Config.invalidConnectors | The spark.adb.connectors configuration is invalid: %s | spark.adb.connectors配置不正確。 |
| 400 | Spark.Config.RoleArnVerifyFailed | RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s | RoleARN參數校驗失敗。 |
| 400 | Spark.ExecuteNotebookStatementFailed | Failed to execute notebook statements. | - |
| 400 | Spark.GetNotebookKernelFailed | Failed to start the notebook kernel. Try again later. | - |
| 400 | Spark.GetNotebookKernelStateFailed | Failed to obtain the status of the notebook kernel. | Notebook Kernel 狀態查詢失敗 |
| 400 | Spark.GetNotebookStatementLogFailed | Failed to obtain notebook statement logs. | - |
| 400 | Spark.GetNotebookStatementResultFailed | Failed to obtain notebook statement execution results. | - |
| 400 | Spark.GetNotebookStatementUiFailed | Failed to obtain notebook statement UI. | - |
| 400 | Spark.Log.IllegalPath | Invalid job log URI: %s. | 配置的Spark日志路徑不合法：%s。 |
| 400 | Spark.Log.InvalidState | Failed to obtain the logs of the Spark job %s in the %s state. | 無法獲取指定Spark作業的日志。 |
| 400 | Spark.NotebookKernelBusy | Too many jobs in the notebook kernel. Try again later. | - |
| 400 | Spark.NotebookKernelExpired | The notebook kernel has expired. Restart the kernel. | - |
| 400 | Spark.NotebookKernelInvalidStatus | The status of the notebook kernel is invalid. | - |
| 400 | Spark.NotebookKernelNotStartup | The notebook kernel has not been started | Notebook Kernel未啟動，請先啟動 |
| 400 | Spark.NotebookKernelStarting | The notebook kernel is starting. Try again later. | - |
| 400 | Spark.NotebookNamingDuplicate | The name of the notebook is duplicated, please change the name | Notebook命名重復，請重新命名。 |
| 400 | Spark.NotebookNotFound | The notebook is not found | Notebook不存在，請聯系管理員 |
| 400 | Spark.NotebookParagraphMissingProgramCode | The notebook paragraph program code is missing | Notebook段落缺少執行代碼 |
| 400 | Spark.NotebookParagraphNotFound | The notebook paragraph is not found | Notebook段落不存在，請聯系管理員 |
| 400 | Spark.NotebookParagraphNotRunning | The notebook paragraph has not been running | Notebook段落未運行，請先執行語句 |
| 400 | Spark.Oss.InternalError | An OSS internal error occurred: %s | OSS內部錯誤，請求失敗。 |
| 400 | Spark.RoleArn.Invalid | %s is not found, or the RAM role has not been authorized. | RoleArn不存在或子賬號未授權。 |
| 400 | Spark.SQL.NotFoundExecutableSQLError | No executable statements are submitted. Please check the input SQL. | Spark作業的SQL信息中不包含可執行語句。 |
| 400 | Spark.SQL.ParserError | Failed to parse the SQL %s. Error message: %s. | Spark作業信息中的SQL無法解析。 |
| 400 | Spark.TemplateFile.BadFileType | The requested template %s is not a file. | 請求的模板文件ID不是文件類型的。 |
| 403 | Spark.Forbidden | No permissions to access the resources: %s | 權限不足，拒絕訪問相關資源。您當前申請訪問的信息是：%s。 |
| 404 | Spark.AnalyzeTask.NotFound | The requested analysis task %s is not found. | 請求查看的日志分析任務 %s 不存在。 |
| 404 | Spark.App.ContentNotFound | The requested content %s of the Spark application is not found. | 找不到指定Spark作業的提交內容。 |
| 404 | Spark.Log.PodLogNotFound | Can't find logs of the pod by podName[%s] in the namespace[%s]. | 無法通過podName找到對應pod的日志 [%s]。 |
| 404 | Spark.ObjectNotFound | The object is not found. More information: %s | 操作對象不存在。關聯信息：%s。 |
| 404 | Spark.TemplateFile.FileNotFound | The template file %s is not found. | 未能找到輸入的模板文件。 |
| 404 | Spark.TemplateFile.TemplateNotFound | The template %s is not found. | 模板文件未找到。 |
| 406 | Spark.App.KillNotAcceptable | Can't kill the application %s in %s state. | 不能刪除處于不可刪除狀態下的 Spark 應用。 |
| 500 | Spark.ServerError | The Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %s | Spark管控組件系統遇到錯誤，請提交工單，或聯系值班工程師。 |
| 500 | Spark.Resources.LoadFileFromClasspathFailed | Can't load the content from file: %s | 加載資源文件失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-11-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-06-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |