Queries the information of the files that are dumped to an IA storage medium from a specified directory.

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 GetDirectoryOrFileProperties

The operation that you want to perform.

Set the value to GetDirectoryOrFileProperties.

FileSystemId String Yes 31a8e4****

The ID of the file system.

Path String Yes /pathway/to/folder

Specifies the absolute path of the directory.

The path must be prefixed by a forward slash (/). It must be a path that exists in the mount target.

Response parameters

Parameter Type Example Description
Entry Object

The details about the files or directories.

Type String File

The type of the query result.

Valid values:

  • File
  • Directory
HasInfrequentAccessFile Boolean true

Indicates whether the files contain the data that is dumped to the IA storage medium.

The value of this parameter is returned only if the value of the Type parameter is File.

Valid values:

  • true: The files contain data that is dumped to the IA storage medium.
  • false: The files do not contain data that is dumped to the IA storage medium.
MTime String 2021-02-11T10:08:08Z

The date and time when the file was last modified.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The value of this parameter is returned only if the value of the Type parameter is File.

ATime String 2021-02-01T10:08:08Z

The time range for the query.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The value of this parameter is returned only if the value of the Type parameter is File.

Size Long 1024

The size of the files.

Unit: bytes.

The value of this parameter is returned only if the value of the Type parameter is File.

CTime String 2021-02-11T10:08:10Z

The time when the raw data was modified.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The value of this parameter is returned only if the value of the Type parameter is File.

StorageType String InfrequentAccess

The storage type of the files.

The value of this parameter is returned only if the value of the Type parameter is File.

Valid value:

  • standard: General-purpose NAS file system
  • InfrequentAccess: IA storage medium
Name String file.txt

The name of the files or directory.

RetrieveTime String 2021-02-11T10:08:08Z

The time when the last data retrieval job was run.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

The value of this parameter is returned only if the value of the Type parameter is File.

Inode String Inode

The file or directory inode.

RequestId String 2D69A58F-345C-4FDE-88E4-BF518948****

The ID of the request.

Samples

Sample requests

http(s)://[Endpoint]/?Action=GetDirectoryOrFileProperties
&FileSystemId=31a8e4****
&Path=/pathway/to/folder
&<Common request parameters>

Sample success responses

XML format

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

<GetDirectoryOrFilePropertiesResponse>
    <Entry>
        <Type>File</Type>
        <HasInfrequentAccessFile>true</HasInfrequentAccessFile>
        <MTime>2021-02-11T10:08:08Z</MTime>
        <ATime>2021-02-01T10:08:08Z</ATime>
        <Size>1024</Size>
        <CTime>2021-02-11T10:08:10Z</CTime>
        <StorageType>InfrequentAccess</StorageType>
        <Name>file.txt</Name>
        <RetrieveTime>2021-02-11T10:08:08Z</RetrieveTime>
        <Inode>Inode</Inode>
    </Entry>
    <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>
</GetDirectoryOrFilePropertiesResponse>

JSON format

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

{
  "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" : "Inode"
  },
  "RequestId" : "2D69A58F-345C-4FDE-88E4-BF518948****"
}

Error codes

HttpCode Error code Error message Required
404 InvalidFileSystem.NotFound The specified file system does not exist. The error message returned because the specified file system does not exist.
404 InvalidParameter.PathNotExist The specified path does not exist. The specified URL does not exist.

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