接口功能介绍
本接口用于查询目录信息。
接口约束
查询目录前确保存在该目录。
请求参数说明：
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"}}
状态码
请参考 状态码
错误码
请参考 错误码
