查询目录列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vs:DescribeDirectories | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 是 | 目录所属空间 ID。 | 348*****174-cn-qingdao |
| ParentId | string | 否 | 按上级目录 ID 查询。 | 399*****774-cn-qingdao |
| SortBy | string | 否 | 按给定字段排序，默认按 ID 排序。 | ID |
| SortDirection | string | 否 | 排序方式，默认升序。取值：
| asc |
| PageSize | long | 否 | 分页大小，默认为 20 | 20 |
| PageNum | long | 否 | 第几个分页，默认为 1 | 1 |
| NoPagination | boolean | 否 | 是否禁用分页，默认 false | false |
返回参数
示例
正常返回示例
JSON格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 1,
"PageCount": 1,
"Directories": [
{
"ParentId": "399*****774-cn-qingdao",
"Description": "目录2",
"GroupId": "348*****174-cn-qingdao",
"Name": "目录2",
"CreatedTime": "2021-09-10T10:00:00Z",
"Id": "399*****488-cn-qingdao"
}
]
}JSON格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 1,
"PageCount": 1,
"Directories": [
{
"ParentId": "399*****774-cn-qingdao",
"Description": "目录2",
"GroupId": "348*****174-cn-qingdao",
"Name": "目录2",
"CreatedTime": "2021-09-10T10:00:00Z",
"Id": "399*****488-cn-qingdao"
}
]
}错误码
访问错误中心查看更多错误码。