UploadFile - - Alibaba Cloud Documentation Center

Uploads the file that contains resources to be purged or prefetched.

Operation description

Note

The file can be up to 10 MB in size.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:UploadFile	create	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID. You can call the ListSites operation to obtain the ID.	123456789****
Url	string	Yes	The OSS URL of the file that contains resources to be purged or prefetched.	https://xxxxx.oss-cn-shenzhen.aliyuncs.com/test_oss_file?Expires=1708659191&OSSAccessKeyId=********&Signature=********
Type	string	Yes	The type of the purge or prefetch task. Valid values: file (default): purges the cache by file. preload: prefetches the file. directory: purges the cache by directory. ignoreParams: purges the cache by URL with specified parameters ignored.	file
UploadTaskName	string	Yes	The name of the upload task.	purge_task_2024_11_11

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
UploadId	long	The ID of the file upload task. You can use this ID for task submission or query subsequently.	159253299357****

Examples

Sample success responses

JSONformat

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "UploadId": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTime	The query time cannot exceed the last 3 days.	The query time cannot exceed the last 3 days.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Specify the ObjectType parameter.
400	InvalidParameters	The specified parameters are invalid.	Parameter is illegal.
400	ExceedFileUpload	The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.	The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.

For a list of error codes, visit the Service error codes.