调用DescribeDirectories查询目录列表_视图计算(VECS)-阿里云帮助中心

查询目录列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	目录所属空间 ID。	348*****174-cn-qingdao
ParentId	string	否	按上级目录 ID 查询。	399*****774-cn-qingdao
SortBy	string	否	按给定字段排序，默认按 ID 排序。	ID
SortDirection	string	否	排序方式，默认升序。取值： asc（升序） desc（降序）	asc
PageSize	long	否	分页大小，默认为 20	20
PageNum	long	否	第几个分页，默认为 1	1
NoPagination	boolean	否	是否禁用分页，默认 false	false

返回参数

名称	类型	描述	示例值
	object
PageNum	long	第几个分页。	1
PageSize	long	分页大小。	20
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664
TotalCount	long	空间总数。	1
PageCount	long	分页总数。	1
Directories	object []	目录列表。
ParentId	string	上级目录 ID。	399*****774-cn-qingdao
Description	string	目录描述。	目录2
GroupId	string	目录所属空间 ID。	348*****174-cn-qingdao
Name	string	目录名称。	目录2
CreatedTime	string	目录创建时间。	2021-09-10T10:00:00Z
Id	string	目录 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"
    }
  ]
}

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"
    }
  ]
}

错误码

访问错误中心查看更多错误码。