Queries the URL of the web UI for a Spark application.
Operation description
- General endpoint:
adb.aliyuncs.com
. - 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
.
Debugging
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:GetSparkAppWebUiAddress | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
AppId | string | Yes | The Spark application ID. Note
You can call the ListSparkApps operation to query Spark application IDs.
| s202205201533hz1209892000**** |
DBClusterId | string | No | The cluster ID. Note
You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
| amv-uf6g8w25jacm7**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
"Data": {
"AppId": "s202205201533hz1209892000****",
"ExpirationTimeInMillis": 1655801973000,
"WebUiAddress": "https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****",
"DBClusterId": "amv-clusterxxx"
}
}
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. |
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.ParameterConflict | Conflicting parameters submitted:\n %s | - |
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.Log.InvalidState | Failed to obtain the logs of the Spark job %s in the %s state. | - |
400 | Spark.SQL.ParserError | Failed to parse the SQL %s. Error message: %s. | - |
404 | Spark.App.ContentNotFound | The requested content %s of the Spark application is not found. | - |
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.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. | - |
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-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 |