DescribeDirectories_目录操作接口_API参考

描述

查询目录列表。

请求参数

参数	类型	必要	示例值	描述
Action	String	是	DescribeDirectories	操作接口名，系统规定参数。取值：DescribeDirectories
GroupId	String	是	100001	目录所属空间ID
ParentId	String	否	600001	按上级目录ID查询
Name	String	否	目录1	按名称查询
SortBy	String	否	ID	按给定字段排序，默认按ID排序
SortDirection	String	否	asc	排序方式，默认升序取值：asc(升序),desc(降序)
PageSize	Long	否	20	分页大小，默认为20
PageNum	Long	否	1	第几个分页，默认为1
NoPagination	Bool	否	false	是否禁用分页，默认false

返回参数

参数	类型	示例值	描述
PageSize	Long	20	分页大小
PageNum	Long	1	第几个分页
PageCount	Long	1	分页总数
TotalCount	Long	1	空间总数
Directories	Directory[]		目录列表
RequestId	String	BEA5625F-8FCF-48F4-851B-CA63946DA664	该条任务请求ID。

Directory类型

参数	类型	示例值	描述
Id	String	600002	目录ID
Name	String	目录1	目录名称
Description	String	目录1	目录描述
GroupId	String	100001	目录所属空间ID
ParentId	String	600001	上级目录ID
CreatedTime	String	2019-09-10T21:00:00Z	目录创建时间

示例

请求示例

http://vs.aliyuncs.com?Action=DescribeDirectories&GroupId=100001&<公共请求参数>

返回示例

{
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "PageSize": 20,
    "PageNum": 1,
    "PageCount": 10,
    "Directories": [
        {
            "Id": "600002",
            "Name": "目录1",
            "Description": "目录1",
            "GroupId": "100001",
            "ParentId": "600001",
            "CreatedTime": "2019-09-10T21:00:00Z"
        }
    ]
}