GetFolder - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a folder.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	No	The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either this parameter or ProjectIdentifier must be specified to determine which DataWorks workspace this API call operates on.	1000011
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.	dw_project
FolderId	string	No	The folder ID. Either this parameter or FolderPath must be specified. You can call the ListFolders operation to obtain the folder ID.	273****
FolderPath	string	No	The folder path. Either this parameter or FolderId must be specified. You can call the ListFolders operation to obtain the folder path.	Business_process/my_first_business_process/MaxCompute/ods_layer

Response parameters

Parameter	Type	Description	Example
	object	The response.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. Used for troubleshooting when errors occur.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call was successful. true false	true
Data	object	Details about the folder.
FolderPath	string	The path of the folder.	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	The ID of the folder.	2735****

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
    "FolderId": "2735****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

For a list of error codes, visit the Service error codes.