Pre-Transferring a File

Function

Pre-transfers a file. An available file path is returned before the recipient receives the file.

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/pre-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
user_name	Yes	String	User ID of the sharer or recipient.
file_name	Yes	String	Name of the file to be transferred, excluding the full path.
file_code	Yes	String	File code.
file_acc_code	Yes	String	File extraction code.
file_system_name	No	String	File system name.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
target_file_url	String	URL of the file to be transferred.
file_system_name	String	File system name.
folder_name	String	User-defined 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/pre-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

Previous topic: Transferring a File

Next topic: Switching the Cluster to Which a Folder Belongs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot