GetDirectoryOrFileProperties - File Storage NAS - Alibaba Cloud Documentation Center

Queries whether a directory contains files that are stored in the Infrequent Access (IA) or Archive storage class, or whether a file is stored in the IA or Archive storage class.

Operation description

Only General-purpose 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:GetDirectoryOrFileProperties	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.	31a8e4****
Path	string	Yes	The absolute path of the directory. The path must start with a forward slash (/) and must be a path that exists in the mount target.	/pathway/to/folder

Response parameters

Parameter	Type	Description	Example
	object
Entry	object	The details about the files or directories.
Type	string	The type of the query result. Valid values: File Directory	File
HasInfrequentAccessFile	boolean	Indicates whether the directory contains files stored in the IA storage medium. This parameter is returned only if the value of the Type parameter is Directory. Valid values: true: The directory contains files stored in the IA storage medium. false: The directory does not contain files stored in the IA storage medium.	true
MTime	string	The time when the file was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. This parameter is returned only if the value of the Type parameter is File.	2021-02-11T10:08:08Z
ATime	string	The time when the file was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. This parameter is returned only if the value of the Type parameter is File.	2021-02-01T10:08:08Z
Size	long	The size of the file. Unit: bytes. This parameter is returned only if the value of the Type parameter is File.	1024
CTime	string	The time when the raw data was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. This parameter is returned only if the value of the Type parameter is File.	2021-02-11T10:08:10Z
StorageType	string	The storage type of the file. This parameter is returned only if the value of the Type parameter is File. Valid values: standard: General-purpose NAS file system 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 follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. This parameter is returned only if the value of the Type parameter is File.	2021-02-11T10:08:08Z
Inode	string	The file or directory inode.	40
HasArchiveFile	boolean	Indicates whether the directory contains files stored in the Archive storage class. This parameter is returned only if the Type parameter is set to Directory. Valid values: true: The directory contains files stored in the Archive storage class. false: The directory does not contain files stored in the Archive storage class.	false
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Sample success responses

JSONformat

{
  "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
  },
  "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.

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

Change history

Change time	Summary of changes	Operation
2024-09-05	API Description Update. The Error code has changed	View Change Details
2024-03-25	The Error code has changed. The response structure of the API has changed	View Change Details