Query file or directory properties and storage class using GetDirectoryOrFileProperties - File Storage NAS - Alibaba Cloud - File Storage NAS

Checks if a specified directory contains infrequent access or archive storage files, or if a specified file is an infrequent access or archive storage file.

Operation description

This operation is available only for general-purpose NAS file systems.

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:GetDirectoryOrFileProperties

get

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	31a8e4****
Path	string	Yes	The absolute path of the directory or file. The path must start with a forward slash (/) and must be an existing path in the mount target.	/pathway/to/folder

Response elements

Element	Type	Description	Example
	object
Entry	object	The properties of the directory or file.
Type	string	The type of the returned entry. Valid values: File: The entry is a file. Directory: The entry is a directory.	File
HasInfrequentAccessFile	boolean	Indicates whether the directory contains an Infrequent Access (IA) file. This parameter is returned only if Type is set to Directory. Valid values: true: The directory contains at least one IA file. false: The directory does not contain IA files.	true
MTime	string	The time when the file was last modified. The time is displayed in the ISO 8601 standard format and is returned in UTC. Format: YYYY-MM-DDThh:mm:ssZ. This parameter is returned only if Type is set to File.	2021-02-11T10:08:08Z
ATime	string	The time when the file was last accessed. The time is displayed in the ISO 8601 standard format and is returned in UTC. Format: YYYY-MM-DDThh:mm:ssZ. This parameter is returned only if Type is set to File.	2021-02-01T10:08:08Z
Size	integer	The size of the file. Unit: bytes. This parameter is returned only if Type is set to File.	1024
CTime	string	The time when the metadata of the file was last modified. The time is displayed in the ISO 8601 standard format and is returned in UTC. Format: YYYY-MM-DDThh:mm:ssZ. This parameter is returned only if Type is set to File.	2021-02-11T10:08:10Z
StorageType	string	The storage type of the file. This parameter is returned only if Type is set to File. Valid values: Standard: General-purpose NAS file systems InfrequentAccess: IA storage medium	InfrequentAccess
Name	string	The name of the file or directory.	file.txt
RetrieveTime	string	The time when the last data retrieval task was run. The time is displayed in the ISO 8601 standard format and is returned in UTC. Format: YYYY-MM-DDThh:mm:ssZ. This parameter is returned only if Type is set to File.	2021-02-11T10:08:08Z
Inode	string	The inode of the file or directory.	40
HasArchiveFile	boolean	Indicates whether the directory contains an archive file. This parameter is returned only if Type is set to Directory. Valid values: true: The directory contains at least one archive file. false: The directory does not contain archive files.	false
OfflineDuration	integer
OfflineUnchangedDuration	integer
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Success response

JSON format

{
  "Entry": {
    "Type": "File",
    "HasInfrequentAccessFile": true,
    "MTime": "2021-02-11T10:08:08Z",
    "ATime": "2021-02-01T10:08:08Z",
    "Size": 1024,
    "CTime": "2021-02-11T10:08:10Z",
    "StorageType": "InfrequentAccess",
    "Name": "file.txt",
    "RetrieveTime": "2021-02-11T10:08:08Z",
    "Inode": "40",
    "HasArchiveFile": false,
    "OfflineDuration": 0,
    "OfflineUnchangedDuration": 0
  },
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidParameter.PathNotExist	The specified path does not exist.	The specified path does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.