Creating File Metadata

Authorization

Yes

String

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

X-User-Id

Yes

String

User ID, which is used for app authentication.

X-Date

Yes

String

Date, which is used for app authentication.

Host

Yes

String

Address, which is used for app authentication.

X-Traceid

No

String

Message log trace ID. The value contains 58 bits.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

createdTime

No

String

Time when the file is created. The format is yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2023-08-18T05:43:49Z.

description

No

String

File description.

mimeType

No

String

Resource type.

fileName

Yes

String

File name, which cannot contain the following characters: '<>|:"*? /', cannot be '..', '.', '', and can contain up to 250 characters.

fileType

Yes

String

File type, which is customizable.

parentFolder

Yes

Array of strings

Parent directory ID list. If the target directory is a root directory, the value is root.

Currently, only one parent directory is supported. If multiple parent directory IDs are passed, only the first one is used.

sha256

No

String

Complete file digest calculated using SHA256.

length

Yes

Long

File size, in bytes.

If uploadMode is set to multipart, the value must be less than or equal to 200 GB.

uploadMode

Yes

String

Upload mode.

• multipart: multipart upload.

uploadType

Yes

Integer

Upload type.

• 0: common upload (not supported yet).

• 1: multipart upload.

• 2: versioning upload (not supported yet).

autoRename

Yes

Integer

Duplicate name policy.

• 2: Forcibly renames a file with an existing name by adding a timestamp to the end of the file name.

• 3: Rejects files with the same name. A file with an existing name cannot be created.

• 4: Does not create a file if files with the same name have the same SHA256 value, or, uses the forcible renaming logic.

multiParts

No

Array of MultiPartInfo objects

Part information list.

containerId

Yes

String

ID of the target space to which the file is uploaded.

preHash

No

String

Digest of the first 1 KB of the file calculated using SHA256.

proofCode

No

String

Storage signature, generated using the binary data of the file and used to prevent credential stuffing.

hidden

No

Boolean

Whether the file is hidden. (This function is available only to whitelisted users.)

partNumber

Yes

Integer

Part No.

partSize

Yes

Long

Part length. The value range is [5,242,880, 5,368,709,120]. The value range of the last part is [0, 5,368,709,120].

Minimum value: 0.

Maximum value: 5,368,709,120.

partOffset

No

Long

Total length (in bytes) to the last data block. This parameter is valid only during concurrent multipart upload. The size of all parts except the last one must be a multiple of 64 bytes.

hashCtx

No

Array of longs

Context used to iteratively calculate SHA256. This field is valid only during concurrent multipart upload. For SHA1, the value is the first to fifth 32-bit variables of the SHA1 of the previous data block. For SHA256, the value is the first to eighth 32-bit variables of the SHA256 of the previous data block.

This parameter is mandatory for all parts except the first one in concurrent multipart upload.

uploadUrl

No

String

URL for uploading a file, which is a return parameter. The PUT method is required for uploading a file.

partId

No

String

Part object ID.

fileId

String

File ID.

rapidUpload

Boolean

Whether flash upload is hit. true indicates that flash upload is hit.

containerId

String

ID of the space where the file is located.

fileName

String

Name of the uploaded file. If the file is not renamed, the value is the same as the file name in the request parameter.

uploadId

String

File upload ID.

parentFolder

Array of strings

ID of the parent directory where the uploaded file is located.

exist

Boolean

Whether the file exists. This parameter is used only when the input parameter autoRename is set to 4. If the file names and SHA256 values are the same, true is returned.

multiParts

Array of MultiPartInfo objects

Part information, which is returned during multipart upload (when uploadMode is set to multipart).

matchedPreHash

Boolean

Whether a matching prehash exists.

code

String

Response code.

msg

String

Response information.

partNumber

Integer

Part No.

partSize

Long

Part length. The value range is [5,242,880, 5,368,709,120]. The value range of the last part is [0, 5,368,709,120].

Minimum value: 0.

Maximum value: 5,368,709,120.

partOffset

Long

Total length (in bytes) to the last data block. This parameter is valid only during concurrent multipart upload. The size of all parts except the last one must be a multiple of 64 bytes.

hashCtx

Array of longs

Context used to iteratively calculate SHA256. This field is valid only during concurrent multipart upload. For SHA1, the value is the first to fifth 32-bit variables of the SHA1 of the previous data block. For SHA256, the value is the first to eighth 32-bit variables of the SHA256 of the previous data block.

This parameter is mandatory for all parts except the first one in concurrent multipart upload.

uploadUrl

String

URL for uploading a file, which is a return parameter. The PUT method is required for uploading a file.

partId

String

Part object ID.

200

Information returned after the first step of uploading a file is complete.