查询目录
最近更新时间：2026-03-19 18:16:28
天翼云智能视图服务API
1.查询目录
接口功能介绍
本接口用于查询目录信息。
接口约束
无
URI
GET /dirs/{DirId}
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| DirId | 是 | String | 目录ID。 | 897098424844288 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 认证信息。 | CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f | |
| Content-Type | 是 | String | 互联网媒体类型。 | application/json;charset=utf-8 | |
| Host | 是 | String | 主机。 | vssapi.ctyun.cn | |
| Version | 是 | String | 版本。 | 2021-11-25 | |
| Timestamp | 是 | String | 时间戳。 | 1689643309 |
请求体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 '/dirs/693323900457467904'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=AVVG8XLD7V1IRZNLGXWM/2023-04-03/vss, SignedHeaders=content-type;host;timestamp, Signature=eb146c8aedd2f4d051ffc80fcb94d5e4cc923262b7bd5f94c3f6770f3f453fc8",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1680514603"
}
请求体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"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录：