ListSparkApps - AnalyticDB - Alibaba Cloud Documentation Center

Queries the Spark applications that run on an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
- The required resource types are displayed in bold characters.
- 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:ListSparkApps	list	DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	amv-bp11q28kvl688****
ResourceGroupName	string	No	The name of the job resource group.	test_instance
PageNumber	long	Yes	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	long	No	The number of entries to return on each page. Default value: 10. Valid values: 10 50 100	30

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
PageNumber	long	The page number of the returned page.	1
PageSize	long	The number of entries returned per page.	10
TotalCount	long	The total number of entries returned.	1
RequestId	string	The ID of the request.	D65A809F-34CE-4550-9BC1-0ED21ETG380
Data	object	The data returned.
AppInfoList	array	Details of the applications. Fields in the response parameter: Data: the data of the Spark application template. EstimateExecutionCpuTimeInSeconds: the amount of time it takes to consume CPU resources for running the Spark application. Unit: milliseconds. LogRootPath: the storage path of log files. LastAttemptId: the most recent attempt ID. WebUiAddress: the web UI URL. SubmittedTimeInMillis: the time when the Spark application was submitted. The time is displayed in the UNIX timestamp format. Unit: milliseconds. StartedTimeInMillis: the time when the Spark application was created. The time is displayed in the UNIX timestamp format. Unit: milliseconds. LastUpdatedTimeInMillis: the time when the Spark application was last updated. The time is displayed in the UNIX timestamp format. Unit: milliseconds. TerminatedTimeInMillis: the time when the Spark application task was terminated. The time is displayed in the UNIX timestamp format. Unit: milliseconds. DBClusterId: the ID of the cluster on which the Spark application runs. ResourceGroupName: the name of the job resource group. DurationInMillis: the amount of time it takes to run the Spark application. Unit: milliseconds.
	SparkAppInfo	Details of the applications. Fields in the response parameter: Data: the data of the Spark application template. EstimateExecutionCpuTimeInSeconds: the amount of time it takes to consume CPU resources for running the Spark application. Unit: milliseconds. LogRootPath: the storage path of log files. LastAttemptId: the most recent attempt ID. WebUiAddress: the web UI URL. SubmittedTimeInMillis: the time when the Spark application was submitted. The time is displayed in the UNIX timestamp format. Unit: milliseconds. StartedTimeInMillis: the time when the Spark application was created. The time is displayed in the UNIX timestamp format. Unit: milliseconds. LastUpdatedTimeInMillis: the time when the Spark application was last updated. The time is displayed in the UNIX timestamp format. Unit: milliseconds. TerminatedTimeInMillis: the time when the Spark application task was terminated. The time is displayed in the UNIX timestamp format. Unit: milliseconds. DBClusterId: the ID of the cluster on which the Spark application runs. ResourceGroupName: the name of the job resource group. DurationInMillis: the amount of time it takes to run the Spark application. Unit: milliseconds.	{ "AppId": "test-app-id", "State": "Running", "Detail": { "LastAttemptId": "0001", "WebUiAddress": "http://spark-ui:4040", "SubmittedTimeInMillis": 1644805200260, "DBClusterId": "db", "EstimateExecutionCpuTimeInSeconds": 1644812400, "AppConf": "{}", "StartedTimeInMillis": 1644806400260, "LastUpdatedTimeInMillis": 1644808800260, "ResourceGroupName": "rg" }, "AppName": "test app name" }
PageNumber	long	The page number of the returned page.	1
PageSize	long	The number of entries returned per page.	10
TotalCount	long	The total number of entries returned.	1

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "Data": {
    "AppInfoList": [
      {
        "AppId": "s202207151211hz0c****",
        "AppName": "SparkTest",
        "Priority": "NORMAL",
        "State": "SUBMITTED",
        "Message": "WARN: Disk is full.",
        "Detail": {
          "Data": "{     \"name\": \"SparkPi\",     \"file\": \"local:///tmp/spark-examples.jar\",     \"className\": \"org.apache.spark.examples.SparkPi\",     \"args\": [         \"1000000\"     ],     \"conf\": {         \"spark.driver.resourceSpec\": \"small\",         \"spark.executor.instances\": 1,         \"spark.executor.resourceSpec\": \"small\"     } }",
          "EstimateExecutionCpuTimeInSeconds": 100,
          "LogRootPath": "oss://<bucket-name>/logs/driver",
          "LastAttemptId": "s202204291426hzpre60****-0003",
          "WebUiAddress": "https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****",
          "SubmittedTimeInMillis": 1651213645000,
          "StartedTimeInMillis": 1651213645010,
          "LastUpdatedTimeInMillis": 1651213645200,
          "TerminatedTimeInMillis": 1651213645300,
          "DBClusterId": "amv-bp11q28kvl688****",
          "ResourceGroupName": "spark-rg",
          "DurationInMillis": 100
        },
        "DBClusterId": "amv-23xxxx"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Spark.InvalidParameter	Invalid parameter value: %s	The specified parameter is invalid.
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	The operation object is invalid.
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.ObjectNotFound	The object is not found. More information: %s	-
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.

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

Change history

Change time	Summary of changes	Operation
2023-06-28	The Error code has changed	View Change Details