1. 接口描述

接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。

查询目录列表。

2. 请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DescribeVSSDirs	操作接口名，系统规定参数。
GroupId	String	是	1001	根据目录所属组ID查询。
ParentDirId	String	否	2001	根据上级目录ID查询。
DirName	String	否	目录1	根据目录名称查询。
SortBy	String	否	CreatedTime	选择按一个字段排序，可选值为： - DirName - CreatedTime - UpdatedTime 默认为CreatedTime，按照创建时间排序。
SortDirection	String	否	asc	排序方式，默认升序。取值：asc(升序), desc(降序)。
PageNum	Long	否	1	第几个分页，默认为1。
PageSize	Long	否	20	分页大小，默认为20。取值范围为1～1000

3. 返回参数

参数	类型	描述
PageNum	Long	第几个分页。
PageSize	Long	分页大小。
TotalPage	Long	分页总数。
TotalNum	Long	目录总数。
Dirs	Dir[]	目录列表。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

Dir

参数	类型	描述
DirId	String	目录ID，如6001。
DirName	String	目录名称。
Description	String	目录描述。
GroupId	String	目录所属组ID。
ParentDirId	String	上级目录ID。
CreatedTime	String	目录创建时间。
UpdatedTime	String	目录更新时间。
InProtocol	String	协议类型。
TotalSize	Int	总数量。
OnlineSize	Int	在线数量。
OrderSequence	Int	顺序。

4. 示例

4.1 请求示例

https://vssapi.ctyun.cn/
?Action=DescribeVSSDirs
&GroupId=748928498239799296
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=UanNauxoTTb2RVSqp%2BGY4fjE6VA%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1781925721
&SignatureVersion=1.0
&Timestamp=1600046171

4.2 返回示例

{
  "PageNum": 1,
  "PageSize": 20,
  "TotalPage": 1,
  "TotalNum": 2,
  "Dirs": [
    {
      "DirId": "748928844311822336",
      "DirName": "device",
      "Description": "",
      "GroupId": "748928498239799296",
      "ParentDirId": "0",
      "CreatedTime": "2020-08-28 15:35:51",
      "UpdatedTime": "2020-08-28 15:35:51",
      "InProtocol": "",
      "TotalSize": "0",
      "OnlineSize": "0",
      "OrderSequence": "0"
    }
  ],
  "RequestId": "e0fa3aeb20b547a68a239480e1ae9307"
}

5. 错误码

ErrorCode	ErrorMessage

查询目录列表

最近更新时间：2025-02-21 02:50:53

1. 接口描述

2. 请求参数

3. 返回参数

Dir

4. 示例

4.1 请求示例

4.2 返回示例

5. 错误码