接口功能介绍
本接口用于查询目录列表。
接口约束
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。
URI
GET /v2/dirs
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ParentDirId | 否 | String | 根据上级目录ID查询，不传该参数则按照根目录ID查询。 | 561297207819108352 | |
| DirName | 否 | String | 根据目录名称查询。 | openapi-dir | |
| SortBy | 否 | String | 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：DirName：目录名称；CreatedTime：目录创建时间；UpdatedTime：目录更新时间。 | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默认升序。取值：Asc(升序)，Desc(降序)。 | Asc | |
| PageNum | 否 | Integer | 第几个分页，默认为1。 | 1 | |
| PageSize | 否 | Integer | 分页大小，默认为20。取值范围为1～1000。 | 20 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Dirs | Array of Objects | 目录列表。 | Dir | |
| PageNum | Integer | 第几个分页。 | 1 | |
| PageSize | Integer | 分页大小。 | 10 | |
| TotalPage | Integer | 分页总数。 | 1 | |
| TotalNum | Integer | 目录总数。 | 10 | |
| RequestId | String | 请求ID。 | ba41650f6da84a20bc386c87285cebe6 |
表 Dir
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ParentDirId | String | 上级目录ID。 | 1 | |
| DirId | String | 目录ID。 | 693323900457467904 | |
| DirName | String | 目录名称。 | openapi-dir | |
| DirType | String | 目录类别。取值：common(普通)，virual(虚拟)。 | common | |
| DirCode | Integer | 目录编码。 | 0087 | |
| Description | String | 目录描述。 | 描述 | |
| TotalSize | Integer | 设备总数。 | 1 | |
| OnlineSize | Integer | 在线设备数。 | 1 | |
| OrderSequence | Integer | 序列号。 | -1680514055943 | |
| CreatedTime | String | 目录创建时间。 | 1679641940225 | |
| UpdatedTime | String | 目录更新时间。 | 1680513927459 |
枚举参数
无
请求示例
请求url
GET '/v2/dirs?PageNum=1&PageSize=1'
请求头header
无
请求体body
无
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "ba41650f6da84a20bc386c87285cebe6","returnObj": {"PageNum": "1","PageSize": "1","TotalPage": "94","TotalNum": "94","Dirs": [{"DirId": "693323900457467904","DirName": "openapi-dir","DirType": "common","Description": "","DirCode": "0087","ParentDirId": "1","CreatedTime": "1679641940225","UpdatedTime": "1680513927459","TotalSize": "0","OnlineSize": "0","OrderSequence": "-1680514055943"}],"RequestId": "ba41650f6da84a20bc386c87285cebe6"}}
状态码
请参考 状态码
错误码
请参考 错误码
