Queries the recycle bin configurations of a specified 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetRecycleBinAttribute

The operation that you want to perform.

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

The ID of the file system.

Response parameters

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

The ID of the request.

RecycleBinAttribute Object

The description of the recycle bin.

Size Long 100

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

SecondarySize Long 100

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

Status String Disable

The status of the recycle bin.

Valid values:

  • Enable: The recycle bin is enabled.
  • Disable: The recycle bin is disabled.
ReservedDays Long 0

The period for which the files in the recycle bin are retained. Unit: day.

If the recycle bin is disabled, 0 is returned for this parameter.

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

The time at which the recycle bin was enabled.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetRecycleBinAttribute
&FileSystemId=1ca404****
&<Common request parameters>

Sample success responses

XML format 

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

<GetRecycleBinAttributeResponse>
    <RequestId>9E15E394-38A6-457A-A62A-D9797C9A****</RequestId>
    <RecycleBinAttribute>
        <Size>100</Size>
        <SecondarySize>100</SecondarySize>
        <Status>Disable</Status>
        <ReservedDays>0</ReservedDays>
        <EnableTime>2021-05-30T10:08:08Z</EnableTime>
    </RecycleBinAttribute>
</GetRecycleBinAttributeResponse>

JSON format 

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

{
  "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 code 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.
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.

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