Promo Center

50% off for new user

Direct Mail-46% off

Learn More

GetSparkSQLEngineState

Updated at: 2024-12-05 06:02

Queries the state information about 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

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

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp11q28kvl688****
ResourceGroupNamestringYes

The name of the job resource group.

test_instance

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

xxxx-xxx-xx
Dataobject

The state information about the Spark SQL engine.

AppIdstring

The ID of the Spark application.

s202207151211hz0c****
MinExecutorstring

The minimum number of started Spark executors.

1
MaxExecutorstring

The maximum number of started Spark executors.

3
Jarsstring

The third-party JAR package.

oss://test-bucket/test.jar
SlotNumstring

The slot number of the Spark application.

2
Configstring

The configuration of the Spark application.

{"key1": "value1", "key2": "value2"}
Statestring

The execution state of the application. Valid values:

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

The timestamp when the Spark SQL application was submitted. Unit: milliseconds.

1651213645000

Examples

Sample success responses

JSONformat

{
  "RequestId": "xxxx-xxx-xx",
  "Data": {
    "AppId": "s202207151211hz0c****",
    "MinExecutor": "1",
    "MaxExecutor": "3",
    "Jars": "oss://test-bucket/test.jar",
    "SlotNum": "2",
    "Config": "{\"key1\": \"value1\", \"key2\": \"value2\"}",
    "State": "COMPLETED",
    "SubmittedTimeInMillis": "1651213645000"
  }
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
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.AnalyzeTask.AppStateNotAcceptedOnly Spark applications in the terminated state can be analyzed. The specified application %s does not meet the requirement.-
400Spark.AnalyzeTask.FailedToKillFailed 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.
400Spark.AnalyzeTask.InvalidStateWhenAnalyzingAppOnly 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.
400Spark.App.InvalidResourceSpecThe requested resource type is not supported:\n %s-
400Spark.App.ParameterConflictConflicting parameters submitted:\n %s-
400Spark.Config.invalidConnectorsThe spark.adb.connectors configuration is invalid: %s-
400Spark.Config.RoleArnVerifyFailedRoleARN parameter verification failed. Error msg: %s when verify RoleArn %s-
400Spark.Log.InvalidStateFailed to obtain the logs of the Spark job %s in the %s state.-
400Spark.SQL.NotFoundExecutableSQLErrorNo executable statements are submitted. Please check the input SQL.-
400Spark.SQL.ParserErrorFailed to parse the SQL %s. Error message: %s.-
404Spark.App.ContentNotFoundThe requested content %s of the Spark application is not found.-
404Spark.AnalyzeTask.NotFoundThe requested analysis task %s is not found.The log analysis task you requested to view does not exist. %s.
404Spark.ObjectNotFoundThe object is not found. More information: %s-
404Spark.TemplateFile.FileNotFoundThe template file %s is not found.Failed to find the specified template file.
404Spark.TemplateFile.TemplateNotFoundThe template %s is not found.-
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
Change timeSummary of changesOperation
2023-06-28The Error code has changedView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare