列举协作空间资料目录
接口说明
有效成员可列举查询根自身及全部后代目录,包含可见引用目录并标记 readOnly,不分页、不返回资源。首次查询沿用已有服务初始化内部根。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /openapi/listGroupDirectories HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 ID,公共参数;缺省时使用调用方默认租户 |
10000 |
| groupId |
string |
是 |
协作空间 ID |
group_example |
| directoryId |
string |
否 |
当前空间可见目录 ID;省略或 root 查询空间根,首次沿用现有服务初始化内部根目录 |
dir_example |
| sortField |
string |
否 |
排序字段:name、gmt_create、gmt_modified |
gmt_create |
| sortOrder |
string |
否 |
排序方向:asc 或 desc |
desc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| code |
string |
业务状态码;成功为 200 |
200 |
| message |
string |
错误描述 |
请求的资源不存在 |
| requestId |
string |
请求追踪 ID |
019FF406-1B10-0065-A97D-2D1920C2A03D |
| directories |
array<object> |
查询根自身及全部后代目录,包含空间可见引用目录,不分页 |
[] |
|
object |
|||
| directoryId |
string |
目录 ID,包含查询根自身及其后代 |
dir_example |
| parentDirectoryId |
string |
父目录 ID;空间内部根为空 |
dir_parent |
| name |
string |
目录名称 |
项目资料 |
| description |
string |
目录描述 |
项目说明 |
| directoryType |
string |
原始目录类型;空间物理目录为 GROUP,引用目录保留原类型 |
GROUP |
| readOnly |
boolean |
是否为只读引用目录;false 仍需创建者或管理员权限才能修改,内部根始终不可修改 |
false |
| totalCount |
integer |
返回目录数量,等于 directories 长度 |
1 |
示例
正常返回示例
JSON格式
{
"code": "200",
"message": "请求的资源不存在",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
"directories": [
{
"directoryId": "dir_example",
"parentDirectoryId": "dir_parent",
"name": "项目资料",
"description": "项目说明",
"directoryType": "GROUP",
"readOnly": false
}
],
"totalCount": 1
}