查詢目錄
更新時間 2024-09-11 16:11:20
最近更新時間: 2024-09-11 16:11:20
分享文章
接口功能介紹
本接口用于查詢目錄信息。
接口約束
查詢目錄前確保存在該目錄。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/dirs/*
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| DirId | 是 | String | 目錄ID。 | 897098424844288 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ParentDirId | String | 上級目錄ID。 | 1 | |
| DirId | String | 目錄ID。 | 693323900457467904 | |
| DirName | String | 目錄名稱。 | openapi-dir | |
| DirType | String | 目錄類別。取值：common(普通)，virual(虛擬)。 | common | |
| DirCode | Integer | 目錄編碼。 | 0087 | |
| Description | String | 目錄描述。 | 描述 | |
| CreatedTime | String | 目錄創建時間。 | 1679641940225 | |
| UpdatedTime | String | 目錄更新時間。 | 1680513927459 | |
| RequestId | String | 請求ID。 | 8041c7552510454f924211a3540ea3e6 |
枚舉參數
無
請求示例
請求url
GET '/v2/dirs/693323900457467904'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "8041c7552510454f924211a3540ea3e6","returnObj": {"DirId": "693323900457467904","DirName": "openapi-dir","DirType": "common","Description": "","DirCode": "0087","ParentDirId": "1","CreatedTime": "1679641940225","UpdatedTime": "1680513927459","RequestId": "8041c7552510454f924211a3540ea3e6"}}
狀態碼
請參考
錯誤碼
請參考
