Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ CloudStorage/ Transferring a File
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Transferring a File

Function

Cloud storage file transfer and sharing

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/cloud-storages/actions/transfer-file

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

transfer_type

Yes

Integer

Operation type. Options: 0: from individual to shared; 1: from shared to individual

user_name

Yes

String

User ID of the sharer or recipient.

file_url

Yes

String

URL of the file to be transferred.

file_code

No

String

File code (used only for receiving files, which is obtained from the response body for file sharing).

file_acc_code

No

String

File extraction code (used only for receiving files, which is obtained from the response body for file sharing).

target_file_url

No

String

URL of the target file.

file_system_name

No

String

File system name.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

file_url

String

URL of the file to be transferred.

file_code

String

File code.

file_acc_code

String

File extraction code.

file_system_name

String

File system name.

folder_name

String

Folder name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

POST /v1/a4da8115c9d8464ead3a38309130523f/cloud-storages/actions/transfer-file

Example Responses

Status code: 200

Success.

null

Status Codes

Status Code

Description

200

Success.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: CloudStorage