获取指定目录文件列表
功能介绍
在MRS集群中获取指定目录文件列表。
接口约束
无。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
path |
是 |
String |
参数解释: 文件目录。比如访问“/tmp/test”目录列表,此处必须是目录,整体URI为/v2/{project_id}/clusters/{cluster_id}/files?path=%2Ftmp%2Ftest。 约束限制: 不涉及 取值范围: 单层目录要遵循以下规则:
默认取值: 不涉及 |
offset |
否 |
String |
参数解释: 分页参数,表示从该偏移量开始查询文件列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
limit |
否 |
String |
参数解释: 分页参数,列表当前分页的数量限制。 约束限制: 不涉及 取值范围: ≤1000 默认取值: 100 |
sort_key |
否 |
String |
参数解释: 列表排序按该属性排序。 约束限制: 不涉及 取值范围:
默认取值: path_suffix |
order |
否 |
String |
参数解释: 列表排序方式。 约束限制: 不涉及 取值范围:
默认取值: desc |
请求参数
无。
响应参数
参数名 |
参数类型 |
说明 |
---|---|---|
total_count |
Integer |
参数解释: 文件总数,与分页无关。 取值范围: 不涉及 |
files |
Array of FileStatusV2 objects |
参数解释: 文件列表,请参见表4。 |
参数名 |
参数类型 |
说明 |
---|---|---|
path_suffix |
String |
参数解释: 文件在当前目录下的后缀,如获取“/tmp”目录,下面的“/tmp/test”文件,此处path_suffix内容为“test”。 取值范围: 不涉及 |
owner |
String |
参数解释: 文件拥有者。 取值范围: 不涉及 |
group |
String |
参数解释: 文件属组。 取值范围: 不涉及 |
permission |
String |
参数解释: 权限信息。 取值范围: 不涉及 |
replication |
Integer |
参数解释: 副本数。 取值范围: 不涉及 |
block_size |
Integer |
参数解释: 块大小。 取值范围: 不涉及 |
length |
Integer |
参数解释: 文件长度。 取值范围: 不涉及 |
type |
String |
参数解释: 文件类型。 取值范围:
|
children_num |
Integer |
参数解释: 该目录下的文件条目数。 取值范围: 不涉及 |
access_time |
Long |
参数解释: 文件访问时间。 取值范围: 不涉及 |
modification_time |
Long |
参数解释: 文件修改时间。 取值范围: 不涉及 |
请求示例
获取指定目录文件列表请求示例
GET /v2/{project_id}/clusters/{cluster_id}/files?path={directory}&offset={offset}&limit={limit}&sort_key={sort_key}&order={order}
响应示例
状态码: 200
{ "total_count": 2, "files": [ { "access_time": 0, "block_size": 0, "children_num": 0, "group": "hadoop", "length": 0, "modification_time": 1587179516623, "owner": "hdfs", "path_suffix": "app-logs", "permission": "777", "replication": 0, "type": "DIRECTORY" }, { "access_time": 1587267212761, "block_size": 134217728, "children_num": 0, "group": "hadoop", "length": 23666188, "modification_time": 1587222156003, "owner": "root", "path_suffix": "data-m-00000", "permission": "644", "replication": 3, "type": "FILE" } ] }
状态码
状态码请参见状态码。
错误码
请参见错误码。