All Products
Search
Document Center

DataWorks:MountDirectory

Last Updated:Oct 17, 2024

Adds a directory to the left-side navigation pane of DataAnalysis.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TargetTypestringNo

The type of the directory that you want to add to the left-side navigation pane of DataAnalysis. Example: META_ALBUM, which indicates the data album.

META_ALBUM
TargetIdstringNo

The ID of the directory that you want to add to the left-side navigation pane of DataAnalysis. This parameter is used together with the TargetType parameter. For example, if you set the TargetType parameter to META_ALBUM, you must set the TargetId parameter to the ID of the related data album. You can call the ListMetaCollections operation to obtain the ID of the data album. The ID is indicated by the QualifiedName parameter.

album.339
TargetUserIdstringNo

The ID of the user in the tenant.

  • If you do not configure TargetUserId, the specified directory belongs to you.
  • If you configure TargetUserId, the specified directory belongs to the user specified by using TargetUserId.
1234567890

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
Datainteger

The number of directories that are added. Valid values:

  • 0: No directories are added. The left-side navigation pane may contain the specified directory.
  • 1: One directory is added.
1
RequestIdstring

The request ID. You can use the ID to troubleshoot issues.

C27D4FB9-C59B-5E17-BD6C-1099B9D6A381
ErrorMessagestring

The error message.

You have no permission.
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code. The value 200 indicates that the task is successful.

200

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 1,
  "RequestId": "C27D4FB9-C59B-5E17-BD6C-1099B9D6A381",
  "ErrorMessage": "You have no permission.",
  "Success": true,
  "ErrorCode": "200"
}

Error codes

HTTP status codeError codeError message
500BusinessError.Dictionary.MountDictionaryCountOverLimitThe maximum mount limit is 8, and cannot continue to mount.
500BusinessError.Dictionary.InvalidDictionaryOrNoPermissionAlbums that do not exist or do not have permission cannot be mounted.
500BusinessError.Dictionary.NoPermissionToUpdateOtherDictionaryYou have insufficient permissions, only administrators can modify other people's directories.
500BusinessError.Dictionary.InvalidUserIdThis user id is illegal.

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

Change history

Change timeSummary of changesOperation
2023-03-02The Error code has changed. The request parameters of the API has changedView Change Details