GetDirectoryOrFileProperties - Apsara File Storage NAS - Alibaba Cloud Documentation Center

Queries whether a specified directory contains files stored in the IA storage medium or whether a specified file is stored in the IA storage medium.

Operation description

Only General-purpose NAS file systems support this operation.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 file or directory.
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
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"
  },
  "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.