调用ListDirectoriesAndFiles接口列出通用型NAS指定目录下的低频存储文件和包含低频存储文件的子目录。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListDirectoriesAndFiles | 接口名称。 固定取值:ListDirectoriesAndFiles |
FileSystemId | String | 是 | 31a8e4**** | 文件系统ID。 |
Path | String | 是 | /pathway/to/folder | 指定目录的绝对路径。 必须以正斜线(/)开头,并且是挂载点中真实存在的路径。 |
NextToken | String | 否 | TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0= | 当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。 |
StorageType | String | 是 | InfrequentAccess | 文件存储类型。 取值(默认值):InfrequentAccess(低频介质存储) |
DirectoryOnly | Boolean | 否 | false | 是否只查询目录。 取值:
|
MaxResults | Long | 否 | 100 | 每次查询结果中包含的目录或文件的个数。 取值范围:10~128 默认值:100 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NextToken | String | TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0= | 当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。 |
RequestId | String | 2D69A58F-345C-4FDE-88E4-BF518948**** | 请求ID。 |
Entries | Array of Entry | 目录或文件信息集合。 |
|
Type | String | File | 返回结果的类型。 包括:
|
HasInfrequentAccessFile | Boolean | true | 是否包含低频存储文件。 仅当Type为Directory时,返回该值且有意义。 包括:
|
Ctime | String | 2021-02-11T10:08:10Z | 原数据修改时间。 执行ISO8601标准表示,返回格式: 仅当Type为File时,返回该值且有意义。 |
Mtime | String | 2021-02-11T10:08:08Z | 文件修改时间。 执行ISO8601标准表示,返回格式: 仅当Type为File时,返回该值且有意义。 |
Size | Long | 1024 | 文件的大小。 单位:Byte(字节) 仅当Type为File时,返回该值且有意义。 |
StorageType | String | InfrequentAccess | 返回文件的数据存储类型。 仅当Type为File时,返回该值且有意义。 包括:
|
Atime | String | 2021-02-01T10:08:08Z | 查询时间。 执行ISO8601标准表示,返回格式: 仅当Type为File时,返回该值且有意义。 |
Name | String | file.txt | 文件名或目录名。 |
RetrieveTime | String | 2021-02-11T10:08:08Z | 距现在最近一次数据取回任务执行的时间。 执行ISO8601标准表示,返回格式: 仅当Type为File时,返回该值且有意义。 |
Inode | String | 66 | 文件或目录inode。 |
FileId | String | 66 | 目录或文件的FileId。 |
Owner | String | 37862c**** | 便携账号ID。 仅当ProtocolType=SMB且开启访问控制时,该返回值具有意义。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListDirectoriesAndFiles
&FileSystemId=31a8e4****
&Path=/pathway/to/folder
&NextToken=TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
&StorageType=InfrequentAccess
&DirectoryOnly=false
&MaxResults=100
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListDirectoriesAndFilesResponse>
<NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>
<RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>
<Entries>
<Type>File</Type>
<HasInfrequentAccessFile>true</HasInfrequentAccessFile>
<Ctime>2021-02-11T10:08:10Z</Ctime>
<Mtime>2021-02-11T10:08:08Z</Mtime>
<Size>1024</Size>
<StorageType>InfrequentAccess</StorageType>
<Atime>2021-02-01T10:08:08Z</Atime>
<Name>file.txt</Name>
<RetrieveTime>2021-02-11T10:08:08Z</RetrieveTime>
<Inode>66</Inode>
<FileId>66</FileId>
<Owner>37862c****</Owner>
</Entries>
</ListDirectoriesAndFilesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"NextToken" : "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
"RequestId" : "2D69A58F-345C-4FDE-88E4-BF518948****",
"Entries" : [ {
"Type" : "File",
"HasInfrequentAccessFile" : true,
"Ctime" : "2021-02-11T10:08:10Z",
"Mtime" : "2021-02-11T10:08:08Z",
"Size" : 1024,
"StorageType" : "InfrequentAccess",
"Atime" : "2021-02-01T10:08:08Z",
"Name" : "file.txt",
"RetrieveTime" : "2021-02-11T10:08:08Z",
"Inode" : "66",
"FileId" : "66",
"Owner" : "37862c****"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.InvalidNextToken | The specified NextToken is invalid. | 指定的NextToken参数非法。 |
404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的文件系统不存在。 |
404 | InvalidParameter.PathNotExist | The specified path does not exist. | 指定的路径不存在。 |
访问错误中心查看更多错误码。