Queries the directories that are recently deleted or the directories whose files are recently deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListRecentlyRecycledDirectories

The operation that you want to perform.

Set the value to ListRecentlyRecycledDirectories.
FileSystemId String Yes 1ca404****

The ID of the file system.

NextToken String No 1256****25

The token that is used to retrieve the next page of the query results. You do not need to specify this parameter for the first query.

If not all directories are returned in a query, the return value of the NextToken parameter is not empty. In this case, you can specify a valid value for the NextToken parameter to continue the query.

MaxResults Long No 100

The number of directories to return for each query.

Valid values: 10 to 1000.

Default value: 100.

Response parameters

Parameter Type Example Description
RequestId String 9E15E394-38A6-457A-A62A-D9797C9A****

The ID of the request.

NextToken String 1256****25

The token that is used to retrieve the next page of the query results.

If not all directories are returned in a query, the return value of the NextToken parameter is not empty. In this case, you can specify a valid value for the NextToken parameter to continue the query.

Entries Array of Entry

The information of the directory that is recently deleted or the directory whose files are recently deleted.

FileId String 04***08

The ID of the directory.

Path String /a/b

The absolute path of the directory.

Name String b

The name of the directory.

LastDeleteTime String 2021-05-30T10:08:08Z

The time at which the directory or the files in the directory are last deleted.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListRecentlyRecycledDirectories
&FileSystemId=1ca404****
&NextToken=1256****25
&MaxResults=100
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListRecentlyRecycledDirectoriesResponse>
    <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>
    <NextToken>1256****25</NextToken>
    <Entries>
        <FileId>04***08</FileId>
        <Path>/a/b</Path>
        <Name>b</Name>
        <LastDeleteTime>2021-05-30T10:08:08Z</LastDeleteTime>
    </Entries>
</ListRecentlyRecycledDirectoriesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9E15E394-38A6-457A-A62A-D9797C9A****",
  "NextToken" : "1256****25",
  "Entries" : [ {
    "FileId" : "04***08",
    "Path" : "/a/b",
    "Name" : "b",
    "LastDeleteTime" : "2021-05-30T10:08:08Z"
  } ]
}

Error codes

HttpCode Error code Error message Description
400 IllegalCharacters The parameter contains illegal characters. The error message returned because an invalid value is specified for a parameter.
400 MissingFileSystemId FileSystemId is mandatory for this action. The error message returned because the FileSystemId parameter is not specified.
400 InvalidParameter.KMSKeyId.KMSUnauthorized KMS is not authorized. The error message returned because you are not authorized to access Key Management Service (KMS).
400 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK needs to be enabled. The error message returned because the specified customer master key (CMK) is disabled.
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.
404 InvalidParameter.InvalidNextToken The specified NextToken is invaild. The error message returned because an invalid value is specified for the NextToken parameter.

For a list of error codes, visit the API Error Center.