API standards and multilingual preset SDKs
The OpenAPI of this product (pds/2022-03-01) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Domain management
|
API |
Title |
Description |
| UpdateDomain | UpdateDomain | Update domain information. |
| ListDomains | List Domains | List domains. |
| GetDomain | Obtain Domain | Obtain domain information. |
| CreateDomain | CreateDomain | Creates a domain. |
| SearchDomains | SearchDomains | Searches for domains |
Account management
|
API |
Title |
Description |
| CreateUser | CreateUser | Create a user. |
| UpdateUser | UpdateUser | Modifies user information. |
| SearchUser | SearchUser | Searches for users. |
Group management
|
API |
Title |
Description |
| CreateDrive | Create Space | Create a drive. |
| UpdateDrive | UpdateDrive | Modifies drive information. |
| ListMyDrives | ListMyDrives | Retrieves a list of Drives for the logged-in user. |
| SearchDrive | SearchDrive | Searches for drives. |
User management
|
API |
Title |
Description |
| ListFile | ListFile | Lists the files and folders that are immediate children of a specified folder. |
| CreateFile | CreateFile | Create a file or folder. |
| UpdateFile | UpdateFile | Updates the metadata of a file without modifying its content. |
| SearchFile | SearchFile | Searches for files. |
| GetFile | GetFile | Gets the details of a file. |
| GetUploadUrl | GetUploadUrl | Retrieves the upload address. |
| CompleteFile | CompleteFile | Completes a file upload. |
| MoveFile | MoveFile | Moves a file or folder. |
| GetDownloadUrl | GetDownloadUrl | Retrieves the download URL for a file. |
Space management
|
API |
Title |
Description |
| UpdateRevision | UpdateRevision | Updates information for a revision. You can set a revision to be kept forever or add a description. A maximum of 50 revisions per file can be kept forever. |
File management
|
API |
Title |
Description |
| ScanFile | ScanFile | Scans a file. |
| ListDelta | ListDelta | Lists deltas. |
File versioning management
|
API |
Title |
Description |
| ListReceivedFile | ListReceivedFile | Lists files shared with the current user from a personal space. |
| ListMyGroupDrive | List of Authorized Team Spaces Received | Lists the authorized group drives. |
| AssignRole | AssignRole | This operation assigns the team administrator role to a user. |
| CancelAssignRole | CancelAssignRole | Currently, this operation only revokes the team administrator role. |
Incremental processing
|
API |
Title |
Description |
| CreateShareLink | Create Share | Creates a share link. |
| UpdateShareLink | Modify a share | Updates a share link. |
| SearchShareLink | SearchShareLink | Searches for shares. |
| ListShareLink | ListShareLink | Lists shares. |
| GetShareLinkByAnonymous | GetShareLinkByAnonymous | Retrieves the metadata of a share link without authentication. |
Permission management
|
API |
Title |
Description |
| TrashFile | TrashFile | Moves a file or folder to the trash. |
| ListRecyclebin | ListRecyclebin | Lists the files and folders in the recycle bin. |
Recycle bin management
|
API |
Title |
Description |
| PunishFile | PunishFile | Penalty information file. |
Image AI management
|
API |
Title |
Description |
| Batch | Batch | Combine multiple API calls into a single request to improve efficiency. |
| ArchiveFiles | ArchiveFiles | Archives files and folders into a package for download. |
| GetAsyncTask | Obtain asynchronous task information | Retrieves information about an asynchronous task. |
Online video preview
|
API |
Title |
Description |
| AddGroupMember | AddGroupMember | Adds a member to a group. |
| AuditLogExport | AuditLogExport | Exports audit logs. |
| Authorize | Authorize | Requests OAuth 2.0 authorization. |
| CancelShareLink | CancelShareLink | Cancels a share link. |
| ClearRecyclebin | ClearRecyclebin | Permanently deletes all files and folders in the recycle bin. |
| CopyFile | CopyFile | Copies a file or directory. |
| CreateGroup | CreateGroup | Creates a group. |
| DeleteDomain | DeleteDomain | Deletes a domain. |
| DeleteDrive | DeleteDrive | Deletes a drive. |
| DeleteFile | DeleteFile | Deletes a file or folder. |
| DeleteGroup | DeleteGroup | Deletes a group. Before deleting a group, ensure it contains no other groups or users. Otherwise, the deletion fails. |
| DeleteRevision | DeleteRevision | Deletes a historical revision. You cannot delete the latest revision. |
| DeleteUser | DeleteUser | Deletes a user. |
| DeltaGetLastCursor | DeltaGetLastCursor | Retrieves the latest cursor for delta operations. |
| DownloadFile | DownloadFile | Downloads a file. |
| FileAddPermission | Grant file sharing authorization to users or groups | Grants folder-level authorization. Each drive supports a maximum of 1000 authorization records. Authorization records that exceed this limit do not take effect. |
| FileDeleteUserTags | FileDeleteUserTags | Deletes custom tags from a file. |
| FileListPermission | FileListPermission | Lists the permission records for a file. |
| FilePutUserTags | FilePutUserTags | Adds custom tags to a file. |
| FileRemovePermission | FileRemovePermission | Revokes a file sharing permission. |
| GetDefaultDrive | GetDefaultDrive | Retrieves the default drive for a specified user. |
| GetDrive | GetDrive | Returns information about a drive. |
| GetGroup | GetGroup | Retrieves information about a group. |
| GetLinkInfo | GetLinkInfo | Retrieves account information. |
| GetLinkInfoByUserId | GetLinkInfoByUserId | Obtain account information by user ID. |
| GetRevision | GetRevision | Retrieves the details of a file revision. |
| GetShareLink | GetShareLink | Retrieves information about a share link. |
| GetShareLinkToken | GetShareLinkToken | Retrieves a share token anonymously. |
| GetUser | GetUser | Retrieves user information. |
| ImportUser | ImportUser | Imports a user. |
| LinkAccount | LinkAccount | Links an account. |
| ListAssignment | ListAssignment | Lists role assignments. |
| ListDrive | ListDrive | Lists drives. |
| ListGroup | ListGroup | Lists groups. |
| ListGroupMember | ListGroupMember | Lists group members. |
| ListRevision | ListRevision | Lists the revisions of a file. |
| ListUploadedParts | ListUploadedParts | Lists the parts that have been successfully uploaded for a specific multipart upload. |
| ListUser | ListUser | Lists users. |
| RemoveGroupMember | RemoveGroupMember | Removes a member from a group. |
| RestoreFile | RestoreFile | Restores a file or folder from the recycle bin. |
| RestoreRevision | RestoreRevision | Restores a historical revision of a file, making it the latest revision. This action creates a new revision, and the original historical revision remains unchanged. You cannot restore the latest revision. |
| Token | Token | Obtains an access token as part of the OAuth 2.0 authorization flow. |
| UnLinkAccount | Unlink Account | Unlinks a specified identity from a user account. |
| UpdateGroup | UpdateGroup | Updates a specified group. |
| VideoDRMLicense | VideoDRMLicense | Acquires a DRM license for a video. |