查询目录树
功能介绍
通过此接口查询作业或脚本目录树中的内容。
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号,获取方法请参见项目ID和账号ID。 |
请求参数
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
directory_id |
否 |
String |
目录编号。 |
|
category |
否 |
String |
查询的目录节点类型。 |
|
name |
否 |
String |
目标元素名称。 |
|
offset |
否 |
Int |
查询偏移量。 |
|
limit |
否 |
Int |
每页显示的条目数量。 |
响应参数
|
参数名 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
parent_directory_id |
是 |
String |
父目录Id |
|
directory_name |
是 |
String |
目录名称 |
|
category_type |
是 |
String |
目录类型 |
|
directory_id |
是 |
String |
目录Id |
|
paging |
是 |
Boolean |
是否分页 |
|
offset |
是 |
Int |
查询偏移量 |
|
limit |
是 |
Int |
每页显示的条目数量 |
|
count |
是 |
Int |
返回总条数 |
|
elements |
否 |
List<TreeNodeElement> |
当前层元素,参考表4。 |
|
sub_directories |
否 |
List<DirectoryTreeResp> |
当前文件夹的子文件夹及元素,参考表3。 |
请求示例
GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/directory/tree
响应示例
- 成功响应
{ "category_type": "job", "count": 3, "directory_id": "0", "elements": [ { "element_id": "54", "is_single_node_job": false, "name": "job_5817", "owner": "ei_dlf_l00341563", "parent_directory_id": "0", "process_type": "BATCH", "type": "job" } ], "limit": 1000, "offset": 0, "paging": false, "parent_directory_id": "-1", "sub_directories": [ { "category_type": "job", "count": 2, "directory_id": "221ff22c-5387-4f79-b89c-797c641e7998", "directory_name": "HiveDirectory", "elements": [ { "element_id": "55", "is_single_node_job": false, "name": "Dummy", "owner": "ei_dlf_l00341563", "parent_directory_id": "221ff22c-5387-4f79-b89c-797c641e7998", "process_type": "BATCH", "type": "job" } ], "limit": 1000, "offset": 0, "paging": false, "parent_directory_id": "0", "sub_directories": [ { "category_type": "job", "count": 1, "directory_id": "5db4c660-3f17-43b0-9479-93ece92dcce7", "directory_name": "SubDirectory1", "elements": [ { "element_id": "41", "is_single_node_job": false, "name": "normalHive", "parent_directory_id": "5db4c660-3f17-43b0-9479-93ece92dcce7", "process_type": "BATCH", "type": "job" } ], "limit": 1000, "offset": 0, "paging": false, "parent_directory_id": "221ff22c-5387-4f79-b89c-797c641e7998" } ] } ] } - 失败响应
{ "error_code":"DLF.3051", "error_msg":"The request parameter is invalid. " }