GetSparkAppMetrics - AnalyticDB - Alibaba Cloud Documentation Center

Queries the metrics of a Spark application.

Operation description

Before you call this operation, you must call the PreloadSparkAppMetrics operation to preload the metrics of a Spark application.
Regional public endpoint: adb.<region-id>.aliyuncs.com. Example: adb.cn-hangzhou.aliyuncs.com.
Regional Virtual Private Cloud (VPC) endpoint: adb-vpc.<region-id>.aliyuncs.com. Example: adb-vpc.cn-hangzhou.aliyuncs.com.

Note If HTTP status code 409 is returned when you call this operation in the China (Qingdao), China (Shenzhen), China (Guangzhou), or China (Hong Kong) region, contact technical support.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:GetSparkAppMetrics	get	*SparkApplication `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}/sparkapp/{#SparkAppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the Spark application.	s202204221525hzca7d8140000003
DBClusterId	string	No	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	amv-bp1ggnu61d77****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	object	The returned data.
AppId	string	The ID of the Spark application.	s202302051515shfa865f80003691
AttemptId	string	The attempt ID of the Spark application.	s202301061000hz57d797b0000201-0001
Finished	boolean	Indicates whether parsing is complete. Valid values: true false	True
EventLogPath	string	The path of the event log.	oss://path/to/eventLog
ScanMetrics	object	The metrics.
OutputRowsCount	long	The number of scanned rows.	1000
TotalReadFileSizeInByte	long	The number of scanned bytes.	10000

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": {
    "AppId": "s202302051515shfa865f80003691",
    "AttemptId": "s202301061000hz57d797b0000201-0001",
    "Finished": true,
    "EventLogPath": "oss://path/to/eventLog",
    "ScanMetrics": {
      "OutputRowsCount": 1000,
      "TotalReadFileSizeInByte": 10000
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	The operation object is invalid.
400	Spark.InvalidParameter	Invalid parameter value: %s	Incorrect input parameter:%s.
400	Spark.AnalyzeTask.AppStateNotAccepted	Only Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.	-
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.	Failed to terminate the Spark log analysis task because the state of the task has changed. Obtain the latest state of the task and try again.
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.	You can perform log analysis only on Spark jobs that are in the terminated state.
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.	-
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	-
400	Spark.Config.RoleArnVerifyFailed	RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s	-
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.	Failed to query the notebook kernel state.
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.	The Spark log path is invalid.
400	Spark.Log.InvalidState	Failed to obtain the logs of the Spark job %s in the %s state.	-
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	-
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	The notebook name is duplicate. Rename the notebook.
400	Spark.NotebookNotFound	The notebook is not found	The notebook does not exist. Contact the administrator.
400	Spark.NotebookParagraphMissingProgramCode	The notebook paragraph program code is missing	Execution code is missing from the notebook paragraph.
400	Spark.NotebookParagraphNotFound	The notebook paragraph is not found	The notebook paragraph does not exist. Contact the administrator.
400	Spark.NotebookParagraphNotRunning	The notebook paragraph has not been running	The notebook paragraph is not running. Execute the statement first.
400	Spark.Oss.InternalError	An OSS internal error occurred: %s	-
400	Spark.RoleArn.Invalid	%s is not found, or the RAM role has not been authorized.	-
400	Spark.SQL.NotFoundExecutableSQLError	No executable statements are submitted. Please check the input SQL.	-
400	Spark.SQL.ParserError	Failed to parse the SQL %s. Error message: %s.	-
400	Spark.TemplateFile.BadFileType	The requested template %s is not a file.	The specified template file ID is not of the file type.
403	Spark.Forbidden	No permissions to access the resources: %s	Insufficient permissions to access the related resources. Information that you want to access: %s.
404	Spark.AnalyzeTask.NotFound	The requested analysis task %s is not found.	The log analysis task you requested to view does not exist. %s.
404	Spark.App.ContentNotFound	The requested content %s of the Spark application is not found.	-
404	Spark.Log.PodLogNotFound	Can't find logs of the pod by podName[%s] in the namespace[%s].	Unable to find log [%s] for corresponding pod via podName.
404	Spark.ObjectNotFound	The object is not found. More information: %s	-
404	Spark.TemplateFile.FileNotFound	The template file %s is not found.	Failed to find the specified template file.
404	Spark.TemplateFile.TemplateNotFound	The template %s is not found.	-
406	Spark.App.KillNotAcceptable	Can't kill the application %s in %s state.	-
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	An error occurred on the Spark control component system. Submit a ticket or contact technical support.
500	Spark.Resources.LoadFileFromClasspathFailed	Can't load the content from file: %s	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-24	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-06-28	The Error code has changed	View Change Details