Use GetRecycleBinAttribute to query recycle bin configurations - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

Only General-purpose NAS file systems support this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:GetRecycleBinAttribute

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	9E15E394-38A6-457A-A62A-D9797C9A****
RecycleBinAttribute	object	The recycle bin description.
Size	integer	The storage usage of files in the recycle bin. Unit: bytes.	100
SecondarySize	integer	The storage usage of Infrequent Access (IA) data in the recycle bin. Unit: bytes.	100
Status	string	The recycle bin status. Valid values: Enable: The recycle bin is enabled. Disable: The recycle bin is disabled.	Disable
ReservedDays	integer	The retention period of files in the recycle bin. Unit: days. If the recycle bin is disabled, this parameter returns 0.	0
EnableTime	string	The time when the recycle bin was enabled. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2021-05-30T10:08:08Z
ArchiveSize	integer	The storage usage of archived data in the recycle bin. Unit: bytes.	1611661312

Examples

Success response

JSON format

{
  "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.	The FileSystemId parameter is not specified.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.