List temporary files
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
paidsw:ListTempFiles |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v2/tempfiles HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
No |
The name of the temporary file. |
filename |
| Prefix |
string |
No |
Filters the results to include only files whose names start with the specified prefix. |
somedir/ |
| Delimiter |
string |
No |
A character used to group file names. All file names that share the same string between the prefix and the first occurrence of the delimiter are grouped into a single CommonPrefixes element. |
/ |
| InstanceId |
string |
No |
The instance ID. |
dsw-730xxxxxxxxxx |
| PageNumber |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of entries per page. |
10 |
| SortBy |
string |
No |
The field to use for sorting. |
GmtModifiedTime |
| Order |
string |
No |
The sort order. |
DESC |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
A list of temporary files. |
||
| RequestId |
string |
The request ID. |
E7D55162-4489-1619-AAF5-3F97D5FCA948 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Message |
string |
The response message. |
"XXX" |
| Code |
string |
The response code. |
"200" |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| TotalCount |
integer |
The total number of temporary files. |
35 |
| TempFiles |
array<object> |
A list of temporary files on the current page. |
|
|
object |
|||
| UserId |
string |
The user ID. |
1612285282502324 |
| OwnerId |
string |
The owner ID. |
1612285282502324 |
| TaskId |
string |
The task ID. |
task-05cexxxxxxxxx |
| InstanceId |
string |
The instance ID. |
dsw-730xxxxxxxxxx |
| Type |
string |
The file type. |
type |
| GmtCreateTime |
string |
The creation time of the temporary file. |
2021-01-12T14:36:01Z |
| GmtModifiedTime |
string |
The last modification time of the temporary file. |
2021-01-12T14:36:01Z |
| GmtExpiredTime |
string |
The expiration time of the temporary file. |
2021-01-12T14:36:01Z |
| Uuid |
string |
The temporary file ID. |
tempfile-05cexxxxxxxxx |
| Name |
string |
The name of the temporary file. |
filename |
| Description |
string |
The description of the temporary file. |
desc |
| Capacity |
integer |
The storage capacity of the temporary file. |
1000 |
| Status |
string |
The status of the temporary file. |
Created |
| Prefix |
string |
The storage path prefix of the temporary file. |
/1079135428626537/209170658818096848/ |
| Bandwidth |
integer |
The upload bandwidth of the temporary file. |
10Mi |
| UploadUrl |
string |
The upload URL for the temporary file. |
http://examplebucket.yourEndpoint/exampledir/exampleobject.txt?Expires=1703123154&OSSAccessKeyId&Signature=5ekVo7r+CeeU5oYmCpnmrzrx2IM= |
| DownloadUrl |
string |
The download URL for the temporary file. |
http://examplebucket.yourEndpoint/exampledir/exampleobject.txt?Expires=1703123270&OSSAccessKeyId&Signature=Fn7xSv2kRQraU6UqRZ3+DMzQK14= |
| Quota |
object |
Details of the temporary file quota. |
|
| UsedFileNum |
integer |
The number of files currently stored. |
100 |
| TotalFileNum |
integer |
The maximum number of files that can be stored. |
1000 |
| UsedCapacity |
integer |
The amount of storage in use. |
1000 |
| TotalCapacity |
integer |
The total storage capacity. |
1000 |
Examples
Success response
JSON format
{
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
"Success": true,
"Message": "\"XXX\"",
"Code": "\"200\"",
"HttpStatusCode": 200,
"TotalCount": 35,
"TempFiles": [
{
"UserId": "1612285282502324",
"OwnerId": "1612285282502324",
"TaskId": "task-05cexxxxxxxxx",
"InstanceId": "dsw-730xxxxxxxxxx",
"Type": "type",
"GmtCreateTime": "2021-01-12T14:36:01Z",
"GmtModifiedTime": "2021-01-12T14:36:01Z",
"GmtExpiredTime": "2021-01-12T14:36:01Z",
"Uuid": "tempfile-05cexxxxxxxxx",
"Name": "filename",
"Description": "desc",
"Capacity": 1000,
"Status": "Created",
"Prefix": "/1079135428626537/209170658818096848/",
"Bandwidth": 0,
"UploadUrl": "http://examplebucket.yourEndpoint/exampledir/exampleobject.txt?Expires=1703123154&OSSAccessKeyId&Signature=5ekVo7r+CeeU5oYmCpnmrzrx2IM=",
"DownloadUrl": "http://examplebucket.yourEndpoint/exampledir/exampleobject.txt?Expires=1703123270&OSSAccessKeyId&Signature=Fn7xSv2kRQraU6UqRZ3+DMzQK14="
}
],
"Quota": {
"UsedFileNum": 100,
"TotalFileNum": 1000,
"UsedCapacity": 1000,
"TotalCapacity": 1000
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.