# Alibaba Cloud Drive and Photo Service API

> Alibaba Cloud Drive and Photo Service API on Apizie: 112 endpoints (Adds a member to a group, Adds files to a specified story, Archives files and folders into a package for download, Assigns the team administrator role to a user, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-pds/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-pds`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/pds
- Page: https://zieapi.vercel.app/api/cloud/aliyun-pds
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-pds/openapi.json

Alibaba Cloud OpenAPI for Drive and Photo Service (pds, version 2022-03-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a member to a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/add-group-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The ID of the group to add a member to |
| member_id | string | yes | The user ID of the member to add |
| member_type | string | yes | The type of member to add. For this operation, the only valid value is `user`. To add a group as a member of another group, you must… |

### Adds files to a specified story
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/add-story-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| files | array | no | The list of files |
| story_id | string | yes | The story ID |

### Archives files and folders into a package for download
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/archive-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | no | The ID of the drive that contains the files. You must specify either this parameter or `share_id` |
| file_ids | array | yes | The list of files to be archived |
| name | string | yes | The name of the generated archive file. The name must be UTF-8 encoded |
| share_id | string | no | The share ID. This parameter is required when archiving files from a share |

### Assigns the team administrator role to a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/assign-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| identity | object | yes | The unique identity identifier. Currently, only users can be assigned the team administrator role |
| manage_resource_id | string | yes | The ID of the managed resource. Currently, only group IDs are supported |
| manage_resource_type | string | yes | The type of the managed resource. Valid values: RT_Group (team) |
| role_id | string | yes | The ID of the role to assign to the user. Valid values: SystemGroupAdmin (team administrator) |

### Exports audit logs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/audit-log-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| file_name | string | no | The name of the exported file. The name can be up to 1,024 characters in length. The default value is `log.csv` |
| language | string | no | The language of the exported file. Default: zh_CN (Chinese). Valid values: `zh_CN`: Chinese `en_US`: English |
| order_by | string | no | The sort field. You can sort by the operation time (`acted_at`). If this parameter is not specified, the results are sorted by operation… |
| query | string | no | Query audit logs by using a combination of the following fields: `drive_id` (string): The drive ID. `actor_id` (string): The actor ID.… |

### Requests OAuth 2.0 authorization
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pds/authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| client_id | string | yes | The client ID assigned when you create an app |
| redirect_uri | string | yes | The redirect URI specified when you created the app. This URI must be URL-encoded |
| scope | string | no | The requested permissions. If omitted, the request defaults to all permissions (JSON-encoded) |
| response_type | string | yes | The response type. This parameter must be set to code |
| state | string | no | A value to maintain state between the request and callback. This value is returned to your redirect URI. We recommend using this parameter… |
| login_type | string | yes | The authentication method. Valid values: default (The default PDS login page that integrates all authentication methods) ding (Log in on a… |
| hide_consent | string | no | Specifies whether to hide the consent page. Default value: false |

### Combine multiple API calls into a single request to improve efficiency
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| requests | array | yes | A collection of subrequests. A batch request can contain 1 to 100 subrequests |
| resource | string | yes | The resource type of the subrequests. Supported resource types include: `file`: A file. `drive`: A drive. `user`: A user. `group`: A… |

### Revokes the team administrator role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/cancel-assign-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| identity | object | yes | The unique identity identifier. Currently, only user roles can be revoked |
| manage_resource_id | string | yes | The ID of the resource managed by the revoked role. Currently, only group IDs are supported |
| manage_resource_type | string | yes | The type of the resource managed by the revoked role. Currently, only RT_Group (team) is supported |
| role_id | string | yes | The ID of the role to revoke from the user. Currently, only SystemGroupAdmin (team administrator) is supported |

### Cancels a share link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/cancel-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| share_id | string | yes | The ID of the share link |

### Permanently deletes all files and folders in the recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/clear-recyclebin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |

### Completes a file upload
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/complete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| crc64_hash | string | no | The CRC64 checksum of the file content |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| upload_id | string | yes | The upload ID |

### Copies a file or directory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/copy-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| auto_rename | string | no | Specifies whether to automatically rename the file if a file with the same name already exists in the destination folder. Default: false |
| drive_id | string | no | The drive ID |
| file_id | string | yes | The file ID or folder ID |
| share_id | string | no | The share ID. If you access a file through a share, include the `x-share-token` header for authentication and specify this parameter. In… |
| to_drive_id | string | no | The ID of the destination drive. By default, this parameter is set to the value of `drive_id` |
| to_parent_file_id | string | yes | The ID of the destination parent folder. To copy a file or folder to the root directory, set this parameter to `root` |

### Creates a customized story. Unlike a recommended story, you specify the files in a customized story
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-customized-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| custom_labels | object | no | The custom labels. You can specify a maximum of 20 labels |
| drive_id | string | yes | The ID of the drive |
| story_cover | object | yes | The file to use as the story cover. This file must be in the story file list |
| story_files | array | yes | The list of files to include in the story |
| story_name | string | yes | The story name. The name must not exceed 1,024 bytes |
| story_sub_type | string | yes | The story subtype. This value is user-defined |
| story_type | string | yes | The story type. This value is user-defined |

### Creates a domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The description of the domain |
| domain_name | string | yes | The name of the domain |
| init_drive_enable | string | no | Specifies whether to enable a default drive for users. If set to `true`, a drive is automatically provisioned for each user upon their… |
| init_drive_size | integer | no | This parameter is required if `init_drive_enable` is set to `true`. The size of the default drive for new users, in bytes. The default… |
| parent_domain_id | string | no | The ID of the parent domain. Set this parameter to create a child domain. This parameter is optional. For information about implementing… |
| size_quota | integer | no | The total storage quota for the domain, in bytes. This value represents the combined storage limit for all drives within the domain. A… |
| store_redundancy_type | string | no | The storage redundancy type. Valid values: `LRS`: Locally Redundant Storage `ZRS`: Zone-Redundant Storage |
| user_count_quota | integer | no | The user count quota for the domain. This specifies the maximum number of users that can be created. A value of `0` indicates no limit |

### Create a drive
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| default | string | no | Specifies whether the drive is the default drive. The default value is `false` |
| description | string | no | The description. The description can be up to 1024 characters long |
| drive_name | string | yes | The name of the drive. The name can be up to 128 characters long |
| drive_type | string | no | The drive type. Currently, only `normal` is supported |
| owner | string | yes | The ID of the owner |
| owner_type | string | yes | The owner type. Valid values: user group |
| status | string | no | The status. Valid values: enabled: The drive is available. disabled: The drive is unavailable. The default value is `enabled` |
| total_size | integer | no | The total size of the drive in bytes. By default, the size is unlimited |

### Creates a file or folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| check_name_mode | string | no | The mode for handling files with duplicate names. Valid values: ignore: allows files with duplicate names. auto_rename: automatically… |
| content_hash | string | no | The hash value of the file content. The value is calculated based on the algorithm specified by content_hash_name |
| content_hash_name | string | no | The hash algorithm name for the file content. Currently, only sha1 is supported |
| content_type | string | no | The file content type. Default value: application/oct-stream. For common content_type values, refer to OSS How do I set Content-Type… |
| description | string | no | The file description. The description can be up to 1024 characters. Default value: empty |
| drive_id | string | no | The drive ID. This parameter is required unless the upload is performed through a share link |
| file_id | string | no | The file ID. This parameter is required for overwrite operations |
| hidden | string | no | Specifies whether the file is hidden. Default value: not hidden |
| local_created_at | string | no | The local creation time of the file. Default value: empty. Format: yyyy-MM-ddTHH:mm:ssZ, in UTC+0 time zone |
| local_modified_at | string | no | The local modification time of the file. Default value: empty. Format: yyyy-MM-ddTHH:mm:ssZ, in UTC+0 time zone |
| name | string | yes | The file name. The name can be up to 1024 bytes in UTF-8 encoding and cannot contain forward slashes (/) |
| parallel_upload | string | no | Specifies whether to enable the parallel part upload feature |
| parent_file_id | string | yes | The parent folder ID. Set this parameter to root to upload to the root directory |
| part_info_list | array | no | The list of part information. A maximum of 10000 parts are supported. If this parameter is not specified, one part is returned by default |
| pre_hash | string | no | The SHA1 value of the first 1 KB of the file. Specify this parameter when using the pre-rapid-upload feature. If no match is found on the… |
| share_id | string | no | The share ID. This parameter is required when uploading through a share link |
| size | integer | no | The file size, in bytes |
| type | string | yes | The file type. Valid values: file: file. folder: folder |
| upload_type | string | no | The upload type. Valid values: multipart and form. Default value: multipart |
| user_tags | array | no | The custom user tags. A maximum of 1000 tags are supported |

### Creates a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The description of the group. The maximum length is 1,024 characters |
| group_name | string | yes | The group name. The name must be 1 to 128 characters in length |
| is_root | string | no | Specifies whether to create a root group. A root group cannot be added to any other group and is typically used as the top-level entity in… |
| parent_group_id | string | no | The ID of the parent group. If specified, the new group is added to this parent group on creation |

### Creates a mapping between an entity and a benefit package. This operation lets you assign a benefit package…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-identity-to-benefit-pkg-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| amount | integer | no | The quantity of the benefit package. This parameter applies only to resource-type benefit packages. It is optional and defaults to 1 |
| benefit_pkg_id | string | yes | The unique identifier for the benefit package |
| expire_time | integer | no | The expiration time of the benefit package. This is a Unix timestamp representing the number of milliseconds that have elapsed since… |
| identity_id | string | yes | The unique identifier for the entity. To manage benefits for a user, provide the user ID |
| identity_type | string | yes | The type of the entity. To manage benefits for a user, set this parameter to `user` |

### Creates a share link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| creatable | string | no | Set to `true` to allow users to create files in shared folders. Setting this to `true` also requires specifying `creatable_file_id_list` |
| creatable_file_id_list | array | no | A list of folder IDs where users can upload files |
| description | string | no | A description for the share link, 0 to 1,024 characters in length |
| disable_download | string | no | Set to `true` to prevent users from downloading the shared files |
| disable_preview | string | no | Set to `true` to prevent users from previewing the shared files |
| disable_save | string | no | Set to `true` to prevent users from saving the shared files to their own drive |
| download_limit | integer | no | The maximum number of times users can download the shared files. The value must be 0 or greater. A value of 0 means there is no limit |
| drive_id | string | yes | The ID of the drive |
| expiration | string | no | The expiration time for the share link, specified in RFC 3339 format (for example, "2020-06-28T11:33:00.000+08:00"). To create a share… |
| file_id_list | array | no | A list of 1 to 100 file IDs to share. This parameter is required when `share_all_files` is `false` and is ignored when it is `true` |
| office_editable | string | no | Set to `true` to allow online editing of the shared documents |
| preview_limit | integer | no | The maximum number of times users can preview the shared files. The value must be 0 or greater. A value of 0 means there is no limit |
| require_login | string | no | If `true`, users must log in to access the share link |
| save_limit | integer | no | The maximum number of times users can save the shared files. The value must be 0 or greater. A value of 0 means there is no limit |
| share_all_files | string | no | Set to `true` to share all files in the drive |
| share_name | string | no | The share name. The length must be between 0 and 128 characters. If not specified, the system uses the name of the file corresponding to… |
| share_pwd | string | no | The password for the share link. It must be between 0 and 64 printable ASCII characters. If this parameter is not set or is an empty… |
| user_id | string | no | The user ID. This parameter is required when authenticating the request with an AccessKey (AK) |

### Creates a task that clusters similar images in a specified drive
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-similar-image-cluster-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |

### Creates a suggested story. PDS filters images and videos in a drive based on the story type and time range…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| address | object | no | The address information |
| custom_labels | object | no | Custom tags for the story. You can specify a maximum of 20 |
| drive_id | string | yes | The drive ID |
| max_image_count | integer | no | The maximum number of files to include. Must be ≤ 100 and ≥ min_image_count. Default: 30 |
| min_image_count | integer | no | The minimum number of files to include. Must be > 0 and ≤ max_image_count. Default: 1 |
| story_end_time | string | no | The end time for files to be included in the story. The value must be in RFC 3339 format |
| story_id | string | no | A user-specified ID for the story |
| story_name | string | no | The name for the story, up to 1,024 bytes in length |
| story_start_time | string | no | The start time for files to be included in the story. The value must be in RFC 3339 format |
| story_sub_type | string | no | The story subtype, which depends on the story_type. For more information, see the list of subtypes below |
| story_type | string | yes | The story type |

### Creates a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| avatar | string | no | The URL of the avatar. If the URL is in HTTP format, it must be prefixed with http:// or https://, and the parameter length is up to 4 KB.… |
| description | string | no | The description of the user. The description can be up to 1,024 characters in length |
| email | string | no | The email address of the user |
| group_info_list | array | no | The group information |
| nick_name | string | no | The nickname of the user. The nickname can be up to 128 characters in length |
| phone | string | no | The phone number of the user |
| role | string | no | The role of the user. Default value: user. Valid values: superadmin: Super administrator. admin: Administrator. user: Regular user. If the… |
| status | string | no | The status of the user. Default value: enabled. Valid values: enabled: Normal. disabled: Logon disabled |
| user_data | object | no | The custom data of the user. The data can be up to 1,024 characters in length |
| user_id | string | yes | The user ID. The ID can be up to 64 characters in length and cannot contain the number sign (#) |
| user_name | string | no | The username. The username can be up to 128 characters in length |

### Retrieves the content security details of a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/csi-get-file-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| file_id | string | yes | The ID of the file |
| url_expire_sec | integer | no | The validity period of the download URL in seconds, with a valid range of 10 to 14,400. By default, a download URL is not returned. Set… |

### Deletes a specified domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| domain_id | string | no | domain id |

### Deletes a drive
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |

### Deletes a file or folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file or folder ID |

### Deletes a group. Before deleting a group, ensure it contains no other groups or users. Otherwise, the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The ID of the group to delete |

### Deletes a historical revision. You cannot delete the latest revision
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | Drive ID |
| file_id | string | yes | File ID |
| revision_id | string | yes | Revision ID |

### Deletes a specified story
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| story_id | string | yes | The ID of the story |

### Deletes a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| user_id | string | yes | The ID of the user to delete |

### Retrieves the latest cursor for delta operations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/delta-get-last-cursor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| sync_root_id | string | no | The ID of the root directory for the sync folder |

### Downloads a file
`GET https://zieapi.vercel.app/v1/cloud:aliyun-pds/download-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| share_id | string | no | The ID of the share. If you access a file by using a share link, you must authenticate with the `x-share-token` header and specify this… |
| drive_id | string | no | The ID of the drive |
| file_id | string | yes | The ID of the file |
| image_thumbnail_process | string | no | The image processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail |
| video_thumbnail_process | string | no | The video processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail |
| office_thumbnail_process | string | no | The document processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail |

### Grants folder-level authorization. Each drive supports a maximum of 1000 authorization records.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/file-add-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| file_id | string | yes | The ID of the folder. To authorize an entire team drive, set this parameter to root. Setting this parameter to root is not supported for… |
| member_list | array | yes | The list of members to be authorized |

### Deletes custom tags from a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/file-delete-user-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | Space ID |
| file_id | string | yes | File ID |
| key_list | array | yes | List of tags to delete. The array must not be empty and can contain up to 1,000 items |

### Lists the permission records for a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/file-list-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |

### Adds custom tags to a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/file-put-user-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| user_tags | array | yes | The array of tags to add. The array must contain 1 to 1,000 tags and must not contain duplicate tag keys |

### Revokes a file sharing permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/file-remove-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| member_list | array | yes | The members whose permissions you want to remove |

### Retrieves the details of an asynchronous task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-async-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| async_task_id | string | yes | The ID of the asynchronous task |

### Retrieves the default drive for a specified user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-default-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| user_id | string | no | The user ID. This parameter is required when you use an AK but optional when you use an access token. If omitted, the ID of the user… |

### Obtain domain information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| domain_id | string | yes | The ID of the domain |
| fields | string | no | The domain property fields to obtain, separated by commas. An empty value indicates that no enumeration fields are obtained |
| get_quota_used | string | no | Specifies whether to return the used quota of the domain. Default value: false. If the quota of the domain is greater than 0 and you set… |

### Retrieves the domain quota
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-domain-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |

### Retrieves the download URL of a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | no | The drive ID |
| expire_sec | integer | no | The expiration time of the download URL, in seconds. Maximum value: 115200. Default value: 900 |
| file_id | string | yes | The file ID |
| file_name | string | no | The file name. The maximum length is 1,024 characters |
| response_content_type | string | no | Specifies the Content-Type of the download response. Enter a MIME type |
| share_id | string | no | The share ID. If you operate on a file through a share, include the `x-share-token` header for authentication and pass this field. In this… |

### Returns information about a drive
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |

### Gets the details of a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | no | The drive ID |
| fields | string | no | Specifies which fields to return: If you set this parameter to `*`, this operation returns all file fields, except for those that must be… |
| file_id | string | yes | The file ID |
| share_id | string | no | The share ID. To access a file in a share, provide this parameter and authenticate with the `x-share-token` header, in which case… |
| thumbnail_processes | object | no | Specifies the thumbnail configuration. Request up to five thumbnails in a single call by defining custom keys for the map. The response… |
| url_expire_sec | integer | no | The expiration time in seconds. The value must be an integer from 10 to 14,400, inclusive |

### Retrieves information about a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The ID of the group to retrieve |

### Retrieves the mapping between an identity and a benefit package. Use this operation to query the benefit…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-identity-to-benefit-pkg-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| benefit_pkg_id | string | yes | The unique ID of the benefit package |
| identity_id | string | yes | The unique ID of the identity. To manage user benefits, set this parameter to the user ID |
| identity_type | string | yes | The type of the identity. Set the value to `user` to manage user benefits |

### Retrieves account information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-link-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| extra | string | no | Additional information for the unique identifier. For example, if the account type is `mobile`, this is the country calling code |
| identity | string | yes | The account's unique identifier, such as a mobile number |
| type | string | yes | The account type. Valid values: `mobile`: A mobile number. `email`: An email address. `ding`: A DingTalk account. `ram`: An Alibaba Cloud… |

### Obtain account information by user ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-link-info-by-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| user_id | string | yes | User ID to query |

### Retrieves the details of a file revision
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| fields | string | no | Specifies the fields to return. By default, this parameter is empty. If you set this parameter to an asterisk (*), all fields are… |
| file_id | string | yes | The file ID |
| revision_id | string | yes | The revision ID |
| url_expire_sec | integer | no | The URL expiration time in seconds. The value must be between 10 and 86400. The default value is 900 seconds (15 minutes) |

### Retrieves information about a share link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| share_id | string | yes | The share ID |

### Retrieves the metadata of a share link without authentication
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-share-link-by-anonymous` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| share_id | string | yes | The ID of the share |

### Retrieves a share token anonymously
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-share-link-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| expire_sec | integer | no | The requested validity period for the share token, in seconds. Valid values range from 1 to 7,200. If this parameter is omitted or set to… |
| share_id | string | yes | The share ID |
| share_pwd | string | no | The share password |

### Retrieves the details of a story, including its cover and file list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| cover_image_thumbnail_process | string | no | The processing parameters for the cover image thumbnail |
| cover_video_thumbnail_process | string | no | The processing parameters for the cover video thumbnail |
| drive_id | string | yes | The ID of the drive |
| image_thumbnail_process | string | no | The processing parameters for the thumbnails of images in the story |
| image_url_process | string | no | The processing parameters for the URLs of images in the story |
| story_id | string | yes | The ID of the story |
| url_expire_sec | integer | no | The expiration time of the thumbnail URL in seconds. The value must be an integer from 10 to 86,400. Default value: 900 |
| video_thumbnail_process | string | no | The processing parameters for the thumbnails of videos in the story |

### Gets the status of an asynchronous task for a value-added service. This API currently supports tasks created…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| task_id | string | yes | The ID of the task |

### Retrieves the upload URL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-upload-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| part_info_list | array | yes | The part information list |
| share_id | string | no | The share ID |
| upload_id | string | yes | The upload ID |

### Retrieves user information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| user_id | string | no | The user id. Required when authenticating with an AccessKey. If you use an access token, omit this parameter to retrieve your own user… |

### Retrieves video playback information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-video-preview-play-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| category | string | yes | The category. You must enable the corresponding transcoding feature. Valid values: live_transcoding: live transcoding and streaming… |
| drive_id | string | no | The drive ID |
| file_id | string | yes | The file ID |
| get_master_url | string | no | Specifies whether to obtain the URL of the master m3u8 file. This parameter is valid only when category is set to quick_video |
| get_subtitle_info | string | no | The get_subtitle_info |
| get_without_url | string | no | Specifies whether to exclude the playback URL. If you set this parameter to true, only transcoding metadata is obtained, TS transcoding is… |
| re_transcode | string | no | Specifies whether to initiate re-transcoding. If you set this parameter to true, re-transcoding is initiated for the file, and a 202… |
| share_id | string | no | The share ID. If you manage files through a share, include the `x-share-token` header for authentication and pass this field. In this… |
| template_id | string | no | The definition template ID. If you leave this parameter empty, all available definition templates are retrieved |
| url_expire_sec | integer | no | The URL timeout period. Unit: seconds. Default value: 15 minutes. Maximum value: 4 hours |

### Retrieves the video playback metadata
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/get-video-preview-play-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| category | string | yes | You must enable the corresponding transcoding feature. Valid values are: `live_transcoding` (live transcoding) `quick_video` (quick video… |
| drive_id | string | no | The ID of the drive |
| file_id | string | yes | The ID of the file |
| share_id | string | no | The ID of the share. To access a file from a share, specify this parameter and include the `x-share-token` header for authentication. In… |

### Update user group name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/group-update-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The group_id |
| name | string | no | The name |

### Imports a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/import-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| authentication_display_name | string | no | The display name of the authentication method |
| authentication_type | string | yes | The authentication type. Valid values are: `mobile`: a mobile number. `email`: an email address. `ding`: a DingTalk account. `ram`: an… |
| auto_create_drive | string | no | Specifies whether to automatically create a drive for the user |
| drive_total_size | integer | no | The total size of the drive. The value must be an integer that is greater than or equal to `-1`. A value of `-1` indicates an unlimited size |
| extra | string | no | Extra information. If `authentication_type` is `mobile`, this parameter specifies the country code. The default is `86` |
| identity | string | yes | The unique identifier for the user |
| nick_name | string | yes | The nickname of the user |
| parent_group_id | string | no | The ID of the group to add the user to |

### Submits a file for investigation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/investigate-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_file_ids | array | yes | A list of drive and file ID pairs. You can specify up to five pairs |

### Links an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/link-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| extra | string | no | Additional information for the unique identifier. For example, if the account uses a mobile phone number, this field contains the region… |
| identity | string | yes | Unique identifier for the account, such as a mobile phone number |
| type | string | yes | Account type. mobile: mobile phone number email: email address ding: DingTalk ram: Alibaba Cloud RAM sub-account wechat: WeCom ldap: LDAP… |
| user_id | string | yes | User ID to attach |

### Lists address groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-address-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| image_thumbnail_process | string | no | The image thumbnail processing style |
| limit | integer | no | The maximum number of address groups to return. The default is 100. The value cannot exceed 100 |
| marker | string | no | The pagination token that specifies the starting point of the query. The response returns results that are sorted alphabetically and… |
| video_thumbnail_process | string | no | The video thumbnail processing style |

### Lists role assignments
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of resources to return. Value range: [1, 100] |
| manage_resource_id | string | yes | The ID of the managed resource, such as a group ID |
| manage_resource_type | string | yes | The type of the managed resource. Supported values include: RT_Group (group) RT_KnowledgeBase (knowledge base) RT_KnowledgeCategory… |
| marker | string | no | The pagination marker. The response lists items in alphabetical order, starting after the specified marker. If you omit this parameter,… |

### Lists incremental information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-delta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| cursor | string | no | The cursor |
| drive_id | string | yes | The space ID |
| limit | integer | no | The maximum number of resources to return. Valid values: 0 to 100. Default value: 100. The number of returned results can be less than the… |
| sync_root_id | string | no | The file ID of the root node of the sync folder |

### List domains
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. Default value: 50 |
| marker | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| parent_domain_id | string | no | The ID of the parent domain |
| service_code | string | no | Service code. Default is pds. edm (Enterprise Edition) pds (Developer Edition) |

### Lists drives
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of drives to return. Valid values: 1 to 100. Default: 100 |
| marker | string | no | The pagination marker. If specified, the query starts from the drive that follows the marker in alphabetical order. If omitted, the query… |
| owner | string | no | The ID of the owner. If omitted, drives of all owners are returned |
| owner_type | string | no | The owner type. Valid values: user: An individual user. group: A user group. If omitted, drives of all owner types are returned |

### Lists face groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-facegroups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. Default value: 100 |
| marker | string | no | The pagination token. The results are returned in alphabetical order, starting from the item that follows the specified token. If you omit… |
| remarks | string | no | Filters query results by exactly matching the remarks. The maximum length is 128 characters |
| return_total_count | string | no | Specifies whether to return the total count of face groups found |

### Lists the files and folders that are immediate children of a specified folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| category | string | no | The file category. Valid values: app: installation package zip: compressed package image doc: document video audio others By default,… |
| drive_id | string | no | The drive ID |
| fields | string | no | The field that is used to return additional information about a child subject. Valid values: * url: returns the URL of the thumbnail of a… |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. The number of returned entries must be less than or equal to the value of… |
| marker | string | no | The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned.… |
| order_by | string | no | The sorting field. Valid values: created_at: sorts the entries by creation time. updated_at: sorts the entries by update time. size: sorts… |
| order_direction | string | no | The sorting direction. Valid values: ASC: ascending order DESC: descending order Default value: ASC |
| parent_file_id | string | yes | The ID of the parent folder. If the parent folder is a root directory, set this parameter to root |
| share_id | string | no | The share ID. If you want to share a file, carry the `x-share-token` header for authentication in the request and specify share_id. In… |
| status | string | no | The state of the files to return. Valid values: available: returns only normal files. uploading: returns only files that are being… |
| thumbnail_processes | object | no | The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the… |
| type | string | no | The file type. Valid values: file: returns only files. folder: returns only folders. By default, files of all types are returned |

### Lists groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of resources to return. The default value is 100, and the maximum value is 100 |
| marker | string | no | The pagination token that specifies the starting point for the query. Results are returned in alphabetical order, starting from the item… |

### Lists group members
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-group-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The ID of the group |
| limit | integer | no | The maximum number of results to return. The value must be an integer from 1 to 100. The API may return fewer results than the specified… |
| marker | string | no | The pagination marker. The API returns results starting from the first entry that follows the marker in alphabetical order. If you do not… |
| member_type | string | no | The member type to list. If you do not specify this parameter, the API returns both users and groups. user group Note: A group can be a… |

### Lists the mappings between identities and benefit packages. Use this API to retrieve the benefit packages…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-identity-to-benefit-pkg-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| identity_id | string | yes | The unique identifier of the identity. When managing benefits for a user, specify the ID of the user |
| identity_type | string | yes | The type of the identity. To manage benefits for a user, set this parameter to `user` |
| include_expired | string | no | Specifies whether to return expired benefit packages. The default value is `false` |

### Retrieves a list of Drives for the logged-in user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-my-drives` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. Default: 100 |
| marker | string | no | The pagination token used to retrieve the next page of results. This parameter is not required for the first request. For subsequent… |

### Lists authorized team workspaces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-my-group-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_name | string | no | Filters the team workspaces by name using fuzzy match |
| limit | integer | no | Specifies the maximum number of resources to return. Default value: 100. Maximum value: 100 |
| marker | string | no | Specifies the pagination marker. If specified, the response starts from the last returned position. If not specified, the response starts… |

### Lists files shared with the current user from a personal space
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-received-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of items to return. The value cannot exceed 100. If you do not specify this parameter, the default is 100 |
| marker | string | no | The pagination marker from a previous response. The query continues from the position indicated by this marker. If you do not specify this… |

### Lists the files and folders in the recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-recyclebin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| fields | string | no | The fields to return in the response. Set to `*` to return all fields of a file. If this parameter is not specified, a partial set of… |
| limit | integer | no | The maximum number of items to return. Valid values: 1 to 200. Default: 50. The number of items returned may be less than the specified… |
| marker | string | no | The pagination marker. The API returns items starting from the one that alphabetically follows the marker. If you omit this parameter, the… |
| thumbnail_processes | object | no | Thumbnail settings. You can retrieve up to five thumbnails in a single request. The keys in this map are user-defined, and the response… |

### Lists the revisions of a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| fields | string | no | Specifies the fields to return. By default, this parameter is empty. If you set this parameter to `*`, all fields are returned, including… |
| file_id | string | yes | The ID of the file |
| limit | integer | no | The maximum number of revisions to return. The value must be an integer from 1 to 100. The default value is 50. The actual number of… |
| marker | string | no | A pagination marker. The response includes only revisions that occur alphabetically after the specified value. If you do not specify this… |

### Lists shares
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| creator | string | no | The user ID of the creator |
| include_cancelled | string | no | Specifies whether to include canceled shares in the response |
| limit | integer | no | The maximum number of shares to return. The value must be in the range of [0, 100]. The number of results returned can be less than the… |
| marker | string | no | A token for paginating results. To retrieve the next page, provide the `next_marker` value from the previous response. Omit this parameter… |
| order_by | string | no | The field to sort results by. By default, results are sorted by creation time in descending order. Valid values: `share_name`: share name… |
| order_direction | string | no | The sort order. If the sort field is `created_at` or `updated_at`, the default order is descending. For other sort fields, the default is… |

### Lists tag groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| image_thumbnail_process | string | no | Specifies the processing style for image thumbnails |
| video_thumbnail_process | string | no | Specifies the processing style for video thumbnails |

### Lists the parts that have been successfully uploaded for a specific multipart upload
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-uploaded-parts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | no | The drive ID. Required for all scenarios except uploads from a share |
| file_id | string | yes | The file ID |
| limit | integer | no | The maximum number of parts to return. The value cannot exceed 100. The default is 100 |
| part_number_marker | integer | no | The marker that specifies the position after which to start listing parts. Obtain this value from the `next_part_number_marker` field in a… |
| share_id | string | no | The share ID. Required when uploading from a share |
| upload_id | string | yes | The upload ID |

### Lists users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/list-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of users to return. Value range: 1 to 100. Default value: 100. |
| marker | string | no | The pagination token that specifies the starting position of the results. The results are returned in alphabetical order. If you omit this… |

### Moves a file or a folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/move-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| check_name_mode | string | no | The processing mode for files with the same name. Valid values: ignore: Allows files with the same name. auto_rename: Automatically… |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| to_parent_file_id | string | yes | The ID of the destination parent folder. Set this parameter to root to move the file or folder to the root directory |

### Penalty information file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/punish-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| action_code | string | yes | The penalty action. Valid values:`pds_file_meta_frozen`: Freezes the file.`pds_file_meta_share_forbidden`: Disables sharing for the… |
| drive_id | string | yes | The ID of the drive that contains the file |
| file_id | string | yes | The ID of the file |
| punish_reason | string | no | The reason for the penalty |

### Removes a file from a face group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/remove-face-group-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| face_group_id | string | yes | The face group ID |
| file_id | string | yes | The ID of the file to remove |

### Removes a member from a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/remove-group-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| group_id | string | yes | The ID of the group to remove the member from |
| member_id | string | yes | The member ID. If `member_type` is `user`, this is the `userID` |
| member_type | string | yes | The member type. This operation only removes users. To remove a member that is a group, delete the group instead. user Note: A group can… |

### Removes one or more files from a specified story
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/remove-story-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| files | array | no | The files to remove from the story |
| story_id | string | yes | The story ID |

### Restores a file or folder from the recycle bin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/restore-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file or folder ID |

### Restores a historical revision of a file, making it the latest revision. This action creates a new revision,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/restore-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| file_id | string | yes | The ID of the file |
| revision_id | string | yes | The ID of the revision |

### Scans a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/scan-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | Drive ID |
| fields | string | no | File properties to include in the scan response. Use '*' to get all properties. If not specified, the following properties are returned by… |
| limit | integer | no | Limit the number of resources returned in this response. Valid values: [1, 100]. The actual number of results may be less than the… |
| marker | string | no | Return results starting from the first item after the marker, sorted alphabetically. If not set, return results from the beginning.… |

### Searches for address groups based on a list of locations or a geographic area
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-address-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| address_level | string | no | The address level for the query |
| address_names | array | no | A list of address names |
| br_geo_point | string | no | The bottom-right point of the rectangle (latitude, longitude) |
| drive_id | string | yes | The drive ID |
| image_thumbnail_process | string | no | The processing style for image thumbnails |
| tl_geo_point | string | no | The top-left point of the rectangle (latitude, longitude) |
| video_thumbnail_process | string | no | The processing style for video thumbnails |

### Searches for domains
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. Default value: 100. The number of returned results must be less than or… |
| marker | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| name | string | no | The name of the domain. Fuzzy search is supported |
| order_by | string | no | The sorting rule. Set the value to created_at, which specifies that the results are sorted based on the time when the domain was created |

### Searches for drives
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_name | string | no | The drive name |
| limit | integer | no | The maximum number of drives to return. The value must be from 1 to 100. Default: 100 |
| marker | string | no | The pagination token. The server returns results alphabetically, starting from the entry after the marker. If this parameter is omitted,… |
| owner | string | no | The ID of the owner |
| owner_type | string | no | The owner type. Valid values: `user`: An individual user. `group`: A group of users. |

### Searches for files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | no | The drive ID |
| fields | string | no | The field that is used to return additional information about files. Valid values: * dir_size: returns the statistics on each subfolder in… |
| limit | integer | no | The maximum number of entries to return. Valid values: 1 to 100. The number of returned entries must be less than or equal to the value of… |
| marker | string | no | The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned.… |
| order_by | string | no | The field by which to sort the returned entries. Default value: created_at. Valid values: * created_at: sorts the entries by creation… |
| query | string | yes | The search conditions. Fuzzy searches based on the file name or directory name are supported. The value of this parameter can be up to… |
| recursive | string | no | Specifies whether to perform recursive search on a folder that is specified by setting parent_file_id in the query parameter |
| return_total_count | string | no | Specifies whether to return the total number of retrieved files |
| thumbnail_processes | object | no | The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the… |

### Searches for shares
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| creators | array | no | The IDs of the creators. 1) If this parameter is not specified, the search scope depends on the user's role: - A drive administrator or… |
| limit | integer | no | The maximum number of shares to return. Valid values: 1-100. Default: 100. The number of shares returned may be less than the specified… |
| marker | string | no | Use the `next_marker` value from a previous response to retrieve the next page of results. If this parameter is not specified, the first… |
| order_by | string | no | The sort field. By default, results are sorted by creation time in descending order. Valid values: `share_name`: The share name.… |
| order_direction | string | no | The sort order. If the sort field is `created_at` or `updated_at`, the default order is descending. For other sort fields, the default… |
| query | string | no | The query conditions. 1) Supported fields: 1.1 `created_at`: The creation time. 1.2 `updated_at`: The update time. 1.3… |
| return_total_count | string | no | Specifies whether to return the total count of matched shares |

### Retrieves similar image clusters in a specified drive
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-similar-image-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| image_thumbnail_process | string | no | The image thumbnail processing style |
| limit | integer | no | The maximum number of results to return. Valid values: 1 to 100. Default value: 50. The number of results returned may be less than the… |
| marker | string | no | The pagination marker. To retrieve the next page of results, set this parameter to the `next_marker` value from the previous response. If… |
| order | string | no | The sort order |

### Retrieves stories from a specified drive that match the specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-stories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| cover_image_thumbnail_process | string | no | The parameters for processing the thumbnail of the cover image |
| cover_video_thumbnail_process | string | no | The parameters for processing the thumbnail of the cover video |
| create_time_range | object | no | The time range when the story was created |
| custom_labels | string | no | Custom labels. You can query multiple fields separated by commas (,) |
| drive_id | string | yes | The drive ID |
| face_group_ids | array | no | The list of face groups. This parameter is used to query people stories |
| limit | integer | no | The maximum number of resources to return. Valid values: 1 to 100. Default value: 100. The number of returned resources can be less than… |
| marker | string | no | The pagination marker. If this parameter is empty, the query starts from the beginning |
| order | string | no | The sort order |
| sort | string | no | The sort field |
| story_end_time_range | object | no | The time range of the end time of the photos or videos in a story |
| story_id | string | no | The story ID |
| story_name | string | no | The name of the story. The name can be up to 1,024 bytes in length |
| story_start_time_range | object | no | The time range of the start time of the photos or videos in a story |
| story_type | string | no | The type of the story. You can specify this parameter when you create a story |
| url_expire_sec | integer | no | The validity period of the thumbnail URL. Unit: seconds. Valid values: 10 to 86400 |
| with_empty_stories | string | no | Specifies whether to return empty stories. Default value: false |

### Searches for users
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/search-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| email | string | no | The user's email address |
| limit | integer | no | The maximum number of users to return per page. Valid values: 1 to 100. Default value: 100 |
| marker | string | no | The pagination marker. Results are returned in alphabetical order, starting from the entry that follows the marker. If this parameter is… |
| nick_name | string | no | The user's nickname. The maximum length is 128 characters |
| nick_name_for_fuzzy | string | no | A keyword for a fuzzy search of nicknames. The maximum length is 128 characters |
| phone | string | no | The user's phone number |
| role | string | no | The role of the user. Valid values: `superadmin`: super administrator `admin`: administrator `user`: regular user |
| status | string | no | The status of the user. `disabled`: The user is disabled. `enabled`: The user is enabled |
| user_name | string | no | The user's name. The maximum length is 128 characters |

### Obtains an access token as part of the OAuth 2.0 authorization flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| grant_type | string | yes | The grant type. Valid values: `authorization_code`: Exchanges an authorization code, returned after successful authentication, for an… |
| code | string | no | The authorization code returned in the redirect URI after successful authentication. This parameter is required when `grant_type` is… |
| redirect_uri | string | no | The redirect URI used in the authorization request. This parameter is required when `grant_type` is `authorization_code` |
| client_id | string | yes | The ID of the app you create in the Alibaba Cloud PDS console |
| client_secret | string | no | The secret of the app you create in the Alibaba Cloud PDS console. This parameter is required for WebServer applications |
| refresh_token | string | no | The token used to refresh an access token. This parameter is required when `grant_type` is `refresh_token` |
| assertion | string | no | A JWT-signed string that contains user information and authorization parameters to be granted. For the structure, see JWTPayload. This… |

### Moves a file or folder to the trash
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/trash-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file or folder ID |

### Dissociates a user from an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/un-link-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| extra | string | no | The additional information for the unique identifier of the account. For example, if the account is a mobile phone number, this field… |
| identity | string | yes | The unique identifier of the account, such as a mobile phone number |
| type | string | yes | The account type. Valid values: mobile: mobile phone number email: email address ding: DingTalk ram: RAM user wechat: WeCom ldap: LDAP… |
| user_id | string | yes | The user ID |

### Update domain information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The description of the domain |
| domain_id | string | yes | The domain ID |
| domain_name | string | no | The name of the domain |
| init_drive_enable | string | no | Specifies whether to enable the default drive feature. A value of true specifies that all users are assigned a drive by default on the… |
| init_drive_size | integer | no | The size of the default drive. Unit: bytes. You must specify init_drive_size if you set init_drive_enable to true. Default value: 0. A… |
| published_app_access_strategy | object | no | The access policy of the application |
| size_quota | integer | no | The total storage quota for all drives in the domain. A value of 0 specifies that the quota is unlimited |
| user_count_quota | integer | no | The maximum number of users that can be created in the domain |

### Modifies drive information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-drive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The description of the drive. The description can be up to 1,024 characters long |
| drive_id | string | yes | The drive ID |
| drive_name | string | no | The drive name. The name can be up to 128 characters long |
| owner | string | no | The owner of the drive. Note: To change the owner of a personal drive, you must use an access key (AK) |
| status | string | no | The status of the drive. Valid values: enabled: The drive is available for use. disabled: The drive cannot be used. |
| total_size | integer | no | The total size of the drive, in bytes. Set this value to -1 to have no limit |

### Updates the information for a specified face group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-facegroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The ID of the drive |
| group_cover_face_id | string | no | The ID of the group cover face. You can obtain this ID from the ImageMediaMetadata field in the response from the file/get, file/list, or… |
| group_id | string | yes | The ID of the face group. You can obtain this ID in the response from the list face groups operation |
| group_name | string | no | The name of the face group. The name can be up to 128 characters long |
| remarks | string | no | Remarks about the face group. The remarks can be up to 128 characters long |

### Updates the metadata of a file without modifying its content
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| check_name_mode | string | no | The naming policy to apply when a file with the same name already exists. Valid values: `ignore`: Allow the duplicate file name.… |
| description | string | no | The description of the file. Maximum length: 1,024 characters |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| hidden | string | no | Specifies whether the file is hidden |
| labels | array | no | The labels of the file. A maximum of 100 labels are allowed |
| local_modified_at | string | no | The modification time of the file on the local device. Specify a UTC timestamp in ISO 8601 format: `YYYY-MM-DDTHH:mm:ssZ` |
| name | string | no | The name of the file. The value must be UTF-8 encoded and no longer than 1,024 bytes |
| starred | string | no | Specifies whether the file is starred |

### Updates a specified group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The new description of the group |
| group_id | string | yes | The ID of the group to update |
| group_name | string | no | The new name of the group |

### Updates the association between an identity and a benefit package. Use this operation to assign a benefit…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-identity-to-benefit-pkg-mapping` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| amount | integer | no | The quantity of the benefit package. This parameter applies to resource-type benefit packages. It is optional and defaults to 1 |
| benefit_pkg_id | string | yes | The unique ID of the benefit package |
| expire_time | integer | no | The expiration time of the benefit package, in milliseconds since the Unix epoch (00:00:00 GMT on January 1, 1970). If omitted, the… |
| identity_id | string | yes | The unique ID of the identity. When managing user benefits, set this parameter to the user ID |
| identity_type | string | yes | The type of the identity. To manage user benefits, set this parameter to `user` |

### Updates information for a revision. You can set a revision to be kept forever or add a description. A…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-revision` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drive_id | string | yes | The drive ID |
| file_id | string | yes | The file ID |
| keep_forever | string | no | Specifies whether to keep the revision forever. If you omit this parameter, the current value remains unchanged |
| revision_description | string | no | The revision description, with a maximum length of 1,024 characters. If you omit this parameter, the current value remains unchanged |
| revision_id | string | yes | The revision ID |

### Updates a share link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-share-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| description | string | no | The description of the share link, which can be up to 1,024 characters long |
| disable_download | string | no | Whether to prevent users from downloading files from the share |
| disable_preview | string | no | Whether to disable previews for the share |
| disable_save | string | no | Whether to prevent users from saving files from the share |
| download_count | integer | no | The download count. The value must be greater than or equal to 0 |
| download_limit | integer | no | The maximum number of times the shared content can be downloaded. The value must be greater than or equal to 0. A value of 0 indicates no… |
| expiration | string | no | The expiration time. The value must be in RFC 3339 format, for example, `2020-06-28T11:33:00.000+08:00`. An empty string ("") indicates… |
| office_editable | string | no | Whether to allow online editing of the shared documents |
| preview_count | integer | no | The preview count. The value must be greater than or equal to 0 |
| preview_limit | integer | no | The maximum number of times the shared content can be previewed. The value must be greater than or equal to 0. A value of 0 indicates no… |
| report_count | integer | no | The report count. The value must be greater than or equal to 0 |
| save_count | integer | no | The save count. The value must be greater than or equal to 0 |
| save_limit | integer | no | The maximum number of times the shared content can be saved. The value must be greater than or equal to 0. A value of 0 indicates no limit |
| share_id | string | yes | The share ID |
| share_name | string | no | The share name. If not specified, the name of the first file is used by default. The name must be 0 to 128 characters long |
| share_pwd | string | no | The share password. The password must be 0 to 64 characters long. An empty string ("") indicates no password is required |
| status | string | no | The status of the share link. Valid values: `disabled`: The share is canceled. `enabled`: The share is active |
| video_preview_count | integer | no | The video preview count. The value must be greater than or equal to 0 |

### Updates a specified story, including its name, tags, and cover
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-story` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| cover | object | no | The story cover |
| custom_labels | object | no | The custom labels. You can specify up to 20 labels |
| drive_id | string | yes | The drive ID |
| story_id | string | yes | The story ID |
| story_name | string | no | The name of the story. The maximum length is 1,024 bytes |

### Modifies user information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| avatar | string | no | The URL of the avatar. HTTP URLs must start with `http://` or `https://` and be 4 KB or smaller. Data URLs must start with `data://`, be… |
| description | string | no | The description. The maximum length is 1,024 characters |
| email | string | no | The email address |
| group_info_list | array | no | The group list |
| nick_name | string | no | The nickname. The maximum length is 128 characters |
| phone | string | no | The mobile number |
| role | string | no | The role. Valid values: `superadmin`: super administrator `admin`: administrator `user`: regular user |
| status | string | no | The user status. Valid values: `disabled` `enabled` |
| user_data | object | no | The custom user data. The maximum length is 1,024 characters |
| user_id | string | yes | The user ID. The maximum length is 64 characters. The value cannot contain the `#` character |

### Acquires a DRM license for a video
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/video-drmlicense` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |
| drmType | string | yes | The DRM type |
| licenseRequest | string | no | The license request payload |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.admin.aliyunpds.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-pds/add-group-member" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Drive and Photo Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-pds/add-group-member with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Drive and Photo Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Drive and Photo Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Drive and Photo Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-pds.

### What is the status of the Alibaba Cloud Drive and Photo Service API?
Needs your own provider key (bring your own key)