GetRecycleBinAttribute - File Storage NAS - Alibaba Cloud Documentation Center

Queries the recycle bin configurations of a General-purpose NAS file system.

Operation description

Only General-purpose File Storage NAS (NAS) file systems support this operation.

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
nas:GetRecycleBinAttribute	get	FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	1ca404****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	9E15E394-38A6-457A-A62A-D9797C9A****
RecycleBinAttribute	object	The description of the recycle bin.
Size	long	The size of the files that are dumped to the recycle bin. Unit: bytes.	100
SecondarySize	long	The size of the Infrequent Access (IA) data that is dumped to the recycle bin. Unit: bytes.	100
Status	string	The status of the recycle bin. Valid values: Enable: The recycle bin is enabled. Disable: The recycle bin is disabled.	Disable
ReservedDays	long	The retention period of the files in the recycle bin. Unit: days. If the recycle bin is disabled, 0 is returned for this parameter.	0
EnableTime	string	The time at which the recycle bin was enabled.	2021-05-30T10:08:08Z
ArchiveSize	long	The size of the archived data that is dumped to the recycle bin. Unit: bytes.	1611661312

Examples

Sample success responses

JSONformat

{
  "RequestId": "9E15E394-38A6-457A-A62A-D9797C9A****",
  "RecycleBinAttribute": {
    "Size": 100,
    "SecondarySize": 100,
    "Status": "Disable",
    "ReservedDays": 0,
    "EnableTime": "2021-05-30T10:08:08Z",
    "ArchiveSize": 1611661312
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	-
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-08-14	The Error code has changed. The response structure of the API has changed	View Change Details