Query the directory structure of Spark applications using GetSparkTemplateFullTree - AnalyticDB - Alibaba Cloud - AnalyticDB

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:GetSparkTemplateFullTree

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

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 elements

Element	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. The response includes the following fields: Uid: the UID of the Alibaba Cloud account. Type: the application template type. Valid values: FOLDER FILE Parent: indicates whether child directories exist. Valid values: 0: no. -1: yes. Children: the child directory. LastModified: the time when the application was last modified. The 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

Success response

JSON format

{
  "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	Incorrect input parameter:%s.
400	Spark.InvalidState	The object of the operation is in an invalid state: %s	The operation object is invalid.
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.
403	Spark.Forbidden	No permissions to access the resources: %s	Insufficient permissions to access the related resources. Information that you want to access: %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.