Creates 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
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 Resourcesis 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:CreateSparkTemplate | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. | amv-bp11q28kvl688**** |
| ParentId | long | Yes | The ID of the directory to which the application template belongs. Note
You can call the GetSparkTemplateFolderTree operation to query the directory ID.
| 10 |
| Name | string | Yes | The name of the application template. The name can be up to 64 characters in length. | batchfile |
| Type | string | Yes | The type of the application template. Valid values:
| file |
| AppType | string | No | The application type. Valid values:
Note
You do not need to specify this parameter when Type is set to folder.
| SQL |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"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.InvalidState | The object of the operation is in an invalid state: %s | The operation object 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. |
| 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-06-28 | The Error code has changed | View Change Details |