All Products
Search
Document Center

Apsara File Storage NAS:GetRecycleBinAttribute

Last Updated:Mar 14, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

1ca404****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

9E15E394-38A6-457A-A62A-D9797C9A****
RecycleBinAttributeobject

The description of the recycle bin.

Sizelong

The size of the files that are dumped to the recycle bin. Unit: bytes.

100
SecondarySizelong

The size of the cold data that is dumped to the recycle bin. Unit: bytes.

100
Statusstring

The status of the recycle bin.

Valid values:

  • Enable: The recycle bin is enabled.
  • Disable: The recycle bin is disabled.
Disable
ReservedDayslong

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
EnableTimestring

The time at which the recycle bin was enabled.

2021-05-30T10:08:08Z

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"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingFileSystemIdFileSystemId is mandatory for this action.-
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.

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