GetSparkTemplateFullTree - AnalyticDB - Alibaba Cloud Documentation Center

Queries the directory structure of Spark applications.

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:GetSparkTemplateFullTree	get	DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.	amv-bp11q28kvl688****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Data	string	The directory structure of Spark applications. Fields in the response parameter: Uid: the UID of the Alibaba Cloud account. Type: the application template type. Valid values: FOLDER FILE Parent: indicates whether a child directory exists. Valid values: 0: no. -1: yes. Children: the child directory. LastModified: the time when applications are last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC. AppType: the application type. Valid values: SQL STREAMING BATCH Name: the name of the directory or application. Id: the directory ID or application ID.	{ "Uid": 10415777**, "Type": "FOLDER", "Parent": -1, "Children": [ { "LastModified": 1648544748, "Uid": 104157779, "Type": "FILE", "Parent": 0, "Id": s202204132, "AppType": "SQL", "Name": "f" }, { "LastModified": 1648544956, "Uid": 1041577795**, "Type": "FOLDER", "Parent": 0, "Id": 157, "Name": "f3333" } ], "Id": 725204, "Name": "root" }

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Data": "{     \"Uid\": 10415777****,     \"Type\": \"FOLDER\",     \"Parent\": -1,     \"Children\": [       {         \"LastModified\": 1648544748,         \"Uid\": 104157779****,         \"Type\": \"FILE\",         \"Parent\": 0,         \"Id\": s202204132****,         \"AppType\": \"SQL\",         \"Name\": \"f\"       },       {         \"LastModified\": 1648544956,         \"Uid\": 1041577795****,         \"Type\": \"FOLDER\",         \"Parent\": 0,         \"Id\": 157,         \"Name\": \"f3333\"       }     ],     \"Id\": 725204,     \"Name\": \"root\"   }"
}

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.
403	Spark.Forbidden	No permissions to access the resources: %s	Insufficient permissions to access the related resources. Information that you want to access: %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-07-27	The Error code has changed	View Change Details