查詢目錄列表
更(geng)新時間 2024-09-11 16:11:21
最(zui)近更新時間(jian): 2024-09-11 16:11:21
分(fen)享文章
接口功能介紹
本接口用于查(cha)詢目錄列表。
接口約束
請求參數說明：
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"}}
狀態碼
請參考
錯誤碼
請參考
