StartSparkSQLEngine - AnalyticDB - Alibaba Cloud Documentation Center

Starts the Spark SQL engine.

Operation description

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

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:StartSparkEngine	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	amv-abcd****
ResourceGroupName	string	Yes	The name of the resource group.	spark-rg-name
MinExecutor	long	No	The minimum number of executors that are required to execute SQL statements. Valid values: 0 to 2000. A value of 0 indicates that no executors are permanent if no SQL statements are executed. If this value exceeds the total number of executors that are supported by the resource group, the Spark SQL engine fails to be started. The value must be less than the value of MaxExecutor.	1
MaxExecutor	long	No	The maximum number of executors that are required to execute SQL statements. Valid values: 1 to 2000. If this value exceeds the total number of executes that are supported by the resource group, the Spark SQL engine fails to be started.	10
Jars	string	No	The Object Storage Service (OSS) paths of third-party JAR packages that are required to start the Spark SQL engine. Separate multiple OSS paths with commas (,).	oss://testBuckname/test.jar,oss://testBuckname/test2.jar
SlotNum	long	No	The maximum number of slots that are required to maintain Spark sessions for executing SQL statements. Valid values: 1 to 500.	100
Config	string	No	The configuration that is required to start the Spark SQL engine. Specify this value in the JSON format. For more information, see Conf configuration parameters.	{ "spark.shuffle.timeout": ":0s" }

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D65A809F-34CE-4550-9BC1-0ED21ETG380
Data	object	The returned data.
AppId	string	The ID of the Spark job.	s202301xxxx
State	string	The state of the Spark SQL engine. Valid values: SUBMITTED STARTING RUNNING FAILED	SUBMITTED
AppName	string	The name of the Spark application.	SQLEngine1

Examples

Sample success responses

JSONformat

{
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "Data": {
    "AppId": "s202301xxxx",
    "State": "SUBMITTED",
    "AppName": "SQLEngine1"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Spark.InvalidParameter	Invalid parameter value: %s	The specified parameter is invalid.
400	Spark.App.ExceedQuotaLimitation	The requested resource exceeds the maximum limit: %s	-
400	Spark.App.InvalidAppTypeWhenSubmit	The specified AppType is INVALID or NULL. Please refer to the documentation to correct the parameters for %s.	The AppType type is illegal, please refer to using the document to specify the AppType suitable for your business.
400	Spark.App.InvalidResourceSpec	The requested resource type is not supported:\n %s	-
400	Spark.App.ParameterConflict	Conflicting parameters submitted:\n %s	-
400	Spark.App.ResourceNegativeError	The requested resource MUST be positive: %s	-
400	Spark.Config.InvalidAppFilePath	The main driver file MUST be a valid OSS path. Current is %s.	-
400	Spark.Config.invalidConnectors	The spark.adb.connectors configuration is invalid: %s	-
400	Spark.Config.InvalidDiskConfig	The requested disk mount parameter is invalid: %s	-
400	Spark.Config.InvalidHostAliasConfig	The requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local	-
400	Spark.Config.InvalidLogOssPath	The OSS address for log storage is illegal: %s	-
400	Spark.Config.InvalidRoleArnFormat	Configure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name	-
400	Spark.Config.InvalidTimeZone	Unable to parse time zone configuration %s : %s	-
400	Spark.Config.MainAppFileNotExists	The main driver file is missing, [file] or [sqls] must be configured.	-
400	Spark.Config.OSSPathAccessError	The configured OSS address %s cannot be accessed.	-
400	Spark.Config.OSSPathNotExists	The OSS address %s requested does not exist or the permissions are insufficient.	-
400	Spark.Config.RoleArnVerifyFailed	RoleARN parameter verification failed. Error msg: %s when verify RoleArn %s	-
400	Spark.Config.SecurityGroupNotFound	The security group in the configuration does not exist or cannot be accessed. %s.	The configured resource group does not exist or cannot be accessed due to insufficient permissions. %s.
400	Spark.Config.VswitchNotFound	The vswitch in the configuration does not exist or cannot be accessed. %s.	-
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	The operation object is invalid.
400	Spark.Log.InvalidState	Failed to obtain the logs of the Spark job %s in the %s state.	-
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.App.ContentNotFound	The requested content %s of the Spark application is not found.	-
404	Spark.App.NotFound	The Spark application %s is not found.	-
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-07-27	The Error code has changed	View Change Details
2023-06-28	The Error code has changed	View Change Details