All Products
Search
Document Center

Drive and Photo Service:File

Last Updated:Apr 11, 2025
ParameterTypeDescriptionExample
object

The information about the file.

domain_idstring

The domain ID.

bj1
drive_idstring

The drive ID.

1
file_idstring

The file ID.

5d79206586bb5dd69fb34c349282718146c55da7
namestring

The file name.

1.mov
typestring

The file type.

Valid values:

  • file
  • folder
file
content_typestring

The type of the content.

application/json
created_atstring

The time when the file was created.

2019-08-20T06:51:27.292Z
updated_atstring

The time when the file was modified.

2019-08-20T06:51:27.292Z
descriptionstring

The description of the file.

image file
trashed_atstring

The time when the file was put into the recycle bin.

2019-08-20T06:51:27.292Z
file_extensionstring

The file name extension.

txt
hiddenboolean

Specifies whether to hide the file.

false
sizelong

The file size

or folder size. The folder size is calculated based on all descendant files and folders in the folder. Note: The folder size can be returned only when you call the ListFile or GetFile operation and include the dir_size field in the fields parameter.

1024
starredboolean

Specifies whether to add the file to favorites.

false
statusstring

The status of the file. Only files and directories in the available state can be accessed. If you call the GetFile operation to obtain a file that is in the uploading state, a response indicating that the file does not exist is returned. If you call the ListFile operation to query files, files in the uploading state are not returned.

available
labelsstring

The labels of the file.

["label1:1", "label2:2"]
upload_idstring

The upload ID.

C9DCFE5A82644AC7A02DB74C30C934A6
parent_file_idstring

The parent folder ID.

3d5b846942cf94fa72324c8a4bda34e81da635a
crc64_hashstring

crc64

3574582125365864471
content_hashstring

The hash value of the content.

EA4942AA8761213890A5C386F88E6464D2C31CA3
content_hash_namestring

The name of the hash algorithm. Set the value to sha1.

sha1
download_urlstring

The download URL. The default validity period of the download URL is 15 minutes. If the URL expires, you can obtain the URL by calling the GetFile operation.

https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
thumbnailstring

The URL of the thumbnail. This parameter is deprecated and we recommend that you use thumbnail_urls.

https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
categorystring

The category. Drive and Photo Service (PDS) classifies files based on their extensions and mime-type. The supported categories include doc, image, audio, and video.

image
local_created_atstring

The time when the local file was created. The time refers to the local time when the file was uploaded. This parameter helps identify the local upload time.

2019-08-20T06:51:27.292Z
local_modified_atstring

The time when the local file was modified. The time refers to the local time when the modified file was uploaded. This parameter helps identify the local update time.

2019-08-20T06:51:27.292Z
revision_idstring

The version ID. If a file that has the same file ID with an existing one is uploaded, a new version ID is generated for the file.

5d5b846942cf94fa72324c14a4bda34e81da635d
investigation_infoobject

The review information.

statuslong

The status of the review.

Valid values:

  • 0

    :

    The review is not performed

    .

  • 1

    :

    The review is not supported

    .

  • 2

    :

    The review fails

    .

  • 3

    :

    The review is in progress

    .

  • 4

    :

    The review is complete

    .

  • 5

    :

    Penalty methods are applied

    .

4
suggestionstring

The recommended operation provided by the review.

Valid values:

  • pass

    :

    The review is passed.

    .

  • block

    :

    The review is not passed. It is recommended to limit the use of the image

    .

pass
thumbnail_urlsobject

The information about the returned thumbnail. The value corresponds to the key that is specified by thumbnail_processes.

string

The information about the returned thumbnail. The value corresponds to the key that is specified by thumbnail_processes.

"128X128": "https://url1", "800X800": "url2"
image_media_metadataImageMediaMetadata

The image metadata. This parameter takes effect only if the value-added image processing feature is enabled.

user_tagsobject

The custom tags.

string

The custom tag.

"k1":"v1", "k2","v2"
video_media_metadataVideoMediaMetadata

The audio and video information.

action_listarray

The permissions.

string
auto_delete_left_seclong

The remaining time until the file is automatically deleted from the recycle bin (if in it).