功能介绍
默认接口请求频率限制：500次/秒。
查询目录列表。
接口约束
确保存在该业务组。
URI
GET /v1?
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeVSSDirs | 操作接口名，系统规定参数。 |
| GroupId | String | 是 | 883904285310976 | 根据目录所属组ID查询。 |
| ParentDirId | String | 否 | 897098424844288 | 根据上级目录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 |
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| 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 | Long | 设备总数量。 |
| OnlineSize | Long | 设备在线数量。 |
| OrderSequence | Long | 目录顺序。 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeVSSDirs&GroupId=581826016879132672
Connection: keep-alive
ctyun-eop-request-id: aa95b68d-3d31-424b-982c-0f2d912adbf0
Eop-date: 20221025T093758Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=my/78iCqEBBffJloK+rdZKuhDwx0app2SrwmQzpWa/4=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"PageNum": 1,
"PageSize": 20,
"TotalPage": 1,
"TotalNum": 1,
"Dirs": [
{
"DirId": "581826016879132673",
"DirName": "dir tiwbwo",
"Description": "description",
"GroupId": "581826016879132672",
"ParentDirId": "0",
"CreatedTime": "2022-10-25 09:37:59",
"UpdatedTime": "2022-10-25 09:37:59",
"InProtocol": "",
"TotalSize": 0,
"OnlineSize": 0,
"OrderSequence": "0"
}
],
"RequestId": "b4348e0f67c34e70865e52abf7e4621b"
}
