All Products
Search

This Product

    AnalyticDB:SubmitSparkApp

    Document Center

    AnalyticDB:SubmitSparkApp

    Last Updated:Dec 05, 2024

    Submits a Spark application.

    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

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    adb:SubmitSparkAppcreate
    *SparkApplication
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/resourcegroup/{#ResourceGroup}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AppNamestringNo

    The name of the application. The value can be up to 64 characters in length.

    		TestApp
    AppTypestringNo

    The type of the application. Valid values:

    • SQL
    • STREAMING
    • BATCH (default)
    		SQL
    DatastringYes

    The data of the application template.

    Note For information about the application template configuration, see Spark application configuration guide.
    		conf spark.driver.resourceSpec=small; conf spark.executor.instances=1; conf spark.executor.resourceSpec=small; conf spark.app.name=TestApp;
    AgentSourcestringNo

    The type of the client. The value can be up to 64 characters in length.

    		CONSOLE
    AgentVersionstringNo

    The version of the client. The value can be up to 64 characters in length.

    		1.091
    DBClusterIdstringYes

    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-bp11q28kvl688****
    ResourceGroupNamestringYes

    The name of the job resource group.

    Note You can call the DescribeDBResourceGroup operation to query the name of a resource group within a cluster.
    		adb
    TemplateFileIdlongNo

    The ID of the application template.

    Note You can call the GetSparkTemplateFullTree operation to query the application template ID.
    		15

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF
    Dataobject

    The returned data.

    AppIdstring

    The application ID.

    		s202204132018hzprec1ac61a000****
    AppNamestring

    The name of the application.

    		TestApp
    Messagestring

    The alert message returned for the operation, such as task execution failure or insufficient resources. If no alert occurs, null is returned.

    		Insufficient resources.
    Statestring

    The execution state of the application. Valid values:

    • SUBMITTED
    • STARTING
    • RUNNING
    • FAILING
    • FAILED
    • KILLING
    • KILLED
    • SUCCEEDING
    • COMPLETED
    • FATAL
    • UNKNOWN
    		SUBMITTED

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": {
    "AppId": "s202204132018hzprec1ac61a000****",
    "AppName": "TestApp",
    "Message": "Insufficient resources.",
    "State": "SUBMITTED"
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Spark.App.ExceedQuotaLimitationThe requested resource exceeds the maximum limit: %s-
    400Spark.App.InvalidAppTypeWhenSubmitThe 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.
    400Spark.App.InvalidResourceSpecThe requested resource type is not supported:\n %s-
    400Spark.App.ParameterConflictConflicting parameters submitted:\n %s-
    400Spark.App.ResourceNegativeErrorThe requested resource MUST be positive: %s-
    400Spark.Config.InvalidAppFilePathThe main driver file MUST be a valid OSS path. Current is %s.-
    400Spark.Config.invalidConnectorsThe spark.adb.connectors configuration is invalid: %s-
    400Spark.Config.InvalidDiskConfigThe requested disk mount parameter is invalid: %s-
    400Spark.Config.InvalidHostAliasConfigThe requested host alias parameter %s is invalid. Example: 127.0.0.1 localhost local-
    400Spark.Config.InvalidLogOssPathThe OSS address for log storage is illegal: %s-
    400Spark.Config.InvalidRoleArnFormatConfigure RoleARN %s invalid format. It should match acs:ram::uid_number:role/role_name-
    400Spark.Config.InvalidTimeZoneUnable to parse time zone configuration %s : %s-
    400Spark.Config.MainAppFileNotExistsThe main driver file is missing, [file] or [sqls] must be configured.-
    400Spark.Config.OSSPathAccessErrorThe configured OSS address %s cannot be accessed.-
    400Spark.Config.OSSPathNotExistsThe OSS address %s requested does not exist or the permissions are insufficient.-
    400Spark.Config.RoleArnVerifyFailedRoleARN parameter verification failed. Error msg: %s when verify RoleArn %s-
    400Spark.Config.SecurityGroupNotFoundThe 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.
    400Spark.Config.VswitchNotFoundThe vswitch in the configuration does not exist or cannot be accessed. %s.-
    400Spark.InvalidParameterInvalid parameter value: %sIncorrect input parameter: %s.
    400Spark.InvalidStateThe object of the operation is in an invalid state: %sThe operation object is invalid.
    400Spark.RoleArn.Invalid%s is not found, or the RAM role has not been authorized.-
    400Spark.SQL.BlankErrorInput sql can not be blank string.-
    400Spark.SQL.MultipleSQLErrorElement in field [sqls] can not contain more than one sql statement: %s.-
    400Spark.SQL.NotFoundExecutableSQLErrorNo executable statements are submitted. Please check the input SQL.-
    400Spark.SQL.NotFoundExecutableSQLErrorThe execution part is not included in the current submitted SQL, please check the input SQL.-
    400Spark.SQL.ParserErrorSubmit spark app failed when parser SQL %s. Error message: %s.-
    403Spark.ForbiddenNo permissions to access the resources: %sInsufficient permissions to access the related resources. Information that you want to access: %s.
    404Spark.App.ContentNotFoundThe requested content %s of the Spark application is not found.-
    404Spark.App.NotFoundThe Spark application %s is not found.-
    404Spark.ObjectNotFoundThe object is not found. More information: %s-
    500Spark.ServerErrorThe Spark control component system encountered an error, please create a ticket to solve the problem or concat the supported engineer on duty. Error message: %sAn 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 timeSummary of changesOperation
    2024-06-11The Error code has changedView Change Details
    2023-07-27The Error code has changedView Change Details
    2023-06-28The internal configuration of the API is changed, but the call is not affectedView Change Details