UpdateSparkTemplateFile - AnalyticDB - Alibaba Cloud Documentation Center

Updates a Spark application template.

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:UpdateSparkTemplateFile	update	SparkTemplate acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}/template/{#TemplateId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	amv-pz5vp4585l466****
Id	long	Yes	The application template ID. Note You can call the GetSparkTemplateFullTree operation to query the application template ID.	718056
Content	string	No	The template data to be updated. Note If you do not specify this parameter, the application template is not updated. For information about how to configure a Spark application template, see Configure a Spark application.	set spark.driver.resourceSpec=medium;set spark.executor.instances=2;set spark.executor.resourceSpec=medium;set spark.app.name=Spark SQL Test;
ResourceGroupName	string	No	The name of the job resource group.	adb

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C3A9594F-1D40-4472-A96C-8FB8AA20D38C
Data	object	The update result.
Succeeded	boolean	Indicates whether the application template is updated. True False	True

Examples

Sample success responses

JSONformat

{
  "RequestId": "C3A9594F-1D40-4472-A96C-8FB8AA20D38C",
  "Data": {
    "Succeeded": true
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Spark.InvalidParameter	Invalid parameter value: %s	The specified parameter is invalid.
400	Spark.TemplateFile.BadFileType	The requested template %s is not a file.	The specified template file ID is not of the file type.
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	The operation object is invalid.
400	Spark.Log.IllegalPath	Invalid job log URI: %s.	The Spark log path is invalid.
400	Spark.Log.InvalidState	Failed to obtain the logs of the Spark job %s in the %s state.	-
400	Spark.Oss.InternalError	An OSS internal error occurred: %s	-
400	Spark.RoleArn.Invalid	%s is not found, or the RAM role has not been authorized.	-
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	-
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.	-
404	Spark.Log.PodLogNotFound	Can't find logs of the pod by podName[%s] in the namespace[%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