产品简介

产品概述

功能介绍

产品优势

应用场景

基本概念

购买指南

快速入门

创建媒体库

发起请求

服务级 API 文档

History

Introduction

API Category

Making API Requests

PaaS Service APIs

Official Cloud Disk APIs

Data Types

Error Codes

业务级 API 文档

简介

访问令牌操作接口

租户空间操作接口

文件操作接口

目录或相簿操作接口

回收站操作接口

配额操作接口

查询任务操作接口

搜索操作接口

历史版本操作接口

目录和文件批量操作接口

收藏操作接口

Error Codes

SDK 文档

Android SDK

iOS SDK

鸿蒙 SDK

常见问题

企业网盘

产品简介

购买指南

快速入门

常见问题

Service Level Agreement

词汇表

查看目录或相簿

PDF

聚焦模式

字号

最后更新时间： 2026-01-07 14:52:06

功能描述 
查看目录或相簿详情
说明：
此接口可同时用于查看文件或文件夹详情，路径如果为文件，则返回文件详情，如果为文件夹，则返回文件夹详情。
请求
请求示例
GET /api/v1/directory/`{LibraryId}`/`{SpaceId}`/`{DirPath}`?info&with_inode=`{WithInode}`&access_token=`{AccessToken}`&with_favorite_status=`{WithFavoriteStatus}`
请求参数
请求参数
描述
类型
是否必选
LibraryId
媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见 创建媒体库﻿
String
是
SpaceId
空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(-)；如果媒体库为多租户模式，则为具体 ID，获取请参见 创建租户空间﻿
String
是
DirPath
目录路径或相簿名，对于多级目录，使用斜杠(/)分隔，例如 foo/bar；对于根目录，该参数留空
String
否
WithInode
0或1，是否返回 inode，即文件目录 ID，默认不返回
String
否
AccessToken
访问令牌，对于公有读媒体库或租户空间，可不指定该参数，否则必须指定该参数，获取请参见 生成访问令牌﻿
String
否
WithFavoriteStatus
0或1，是否返回收藏状态，默认不返回
String
否
请求体
该请求无请求体。
响应
响应码
获取成功，返回 HTTP 200 OK。
响应体
application/json
响应体示例：
{
  "path":["xxx","yyy"],
  "name": "file1.jpg",
  "type": "file",
  "userId": "23",
  "creationTime": "2020-09-22T07:44:45.000Z",
  "modificationTime": "2020-09-22T07:44:45.000Z",
  "contentType": "image/jpg",
  "size": "1048576",
  "eTag": "\\"b581c674266a2b0ff16a9505b4c52300\\"",
  "crc64": "16293198345556339838",
  "versionId": 23,
  "historySize": "2323",
  "metaData": {
      "x-smh-meta-foo": "bar"
  },
  "previewByDoc": true,
  "previewByCI": true,
  "previewAsIcon": true,
  "fileType": "powerpoint",
  "localSync": {
    "syncId": 4,
    "strategy": "local_to_cloud",
    "isSyncRootFolder": true,
    "syncUserId": "123"
  }
}
响应体字段说明：
响应参数
描述
类型
path
完整路径
Array
inode
文件目录 ID
String
name
目录或相簿名或文件名
String
type
条目类型：
dir：目录或相簿。
file：文件，仅用于文件类型媒体库。
image：图片，仅用于媒体类型媒体库。
video：视频，仅用于媒体类型媒体库。
symlink：符号链接。
String
userId
创建人 ID
String
creationTime
ISO 8601格式的日期与时间字符串，表示目录或相簿的创建时间或文件的上传时间，例如2020-10-14T10:17:57.953Z
String
modificationTime
文件最近一次被覆盖的时间，或者目录内最近一次增删子目录或文件的时间
String
contentType
媒体类型（仅非目录或相簿返回）
String
size
文件大小
String
eTag
目录或文件的 eTag
String
isFavorite
是否被收藏，当 WithFavoriteStatus = 1时返回
Boolean
crc64
文件的 CRC64-ECMA182 校验值
String
versionId
版本号（仅非目录或相簿返回）
String
metaData
文件元数据信息（仅非目录或相簿返回）
String
previewByDoc
是否可通过 wps 预览（仅非目录或相簿返回）
Boolean
previewByCI
是否可通过万象预览（仅非目录或相簿返回）
Boolean
previewAsIcon
是否可用预览图作为 icon（仅非目录或相簿返回）
Boolean
fileType
文件类型：Excel、PowerPoint 等（仅非目录或相簿返回）
String
labels
简易文件标签列表，跟tagList不同，它是通过上传、修改文件时指定的
Array
category
文件自定义的分类
Int
linkTo
符号链接指向的下一级文件的inode，当文件为符号链接时返回
String
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

智能媒资托管

查看目录或相簿

功能描述

请求

请求示例

请求参数

请求体

响应

响应码

响应体

错误码

帮助和支持

请求参数	描述	类型	是否必选
LibraryId	媒体库 ID，在媒体托管控制台创建媒体库后获取，请参见创建媒体库	String	是
SpaceId	空间 ID，如果媒体库为单租户模式，则该参数固定为连字符(`-`)；如果媒体库为多租户模式，则为具体 ID，获取请参见创建租户空间	String	是
DirPath	目录路径或相簿名，对于多级目录，使用斜杠(`/`)分隔，例如 `foo/bar`；对于根目录，该参数留空	String	否
WithInode	0或1，是否返回 inode，即文件目录 ID，默认不返回	String	否
AccessToken	访问令牌，对于公有读媒体库或租户空间，可不指定该参数，否则必须指定该参数，获取请参见生成访问令牌	String	否
WithFavoriteStatus	0或1，是否返回收藏状态，默认不返回	String	否

响应参数	描述	类型
path	完整路径	Array
inode	文件目录 ID	String
name	目录或相簿名或文件名	String
type	条目类型： dir：目录或相簿。 file：文件，仅用于文件类型媒体库。 image：图片，仅用于媒体类型媒体库。 video：视频，仅用于媒体类型媒体库。 symlink：符号链接。	String
userId	创建人 ID	String
creationTime	ISO 8601格式的日期与时间字符串，表示目录或相簿的创建时间或文件的上传时间，例如`2020-10-14T10:17:57.953Z`	String
modificationTime	文件最近一次被覆盖的时间，或者目录内最近一次增删子目录或文件的时间	String
contentType	媒体类型（仅非目录或相簿返回）	String
size	文件大小	String
eTag	目录或文件的 eTag	String
isFavorite	是否被收藏，当 WithFavoriteStatus = 1时返回	Boolean
crc64	文件的 CRC64-ECMA182 校验值	String
versionId	版本号（仅非目录或相簿返回）	String
metaData	文件元数据信息（仅非目录或相簿返回）	String
previewByDoc	是否可通过 wps 预览（仅非目录或相簿返回）	Boolean
previewByCI	是否可通过万象预览（仅非目录或相簿返回）	Boolean
previewAsIcon	是否可用预览图作为 icon（仅非目录或相簿返回）	Boolean
fileType	文件类型：Excel、PowerPoint 等（仅非目录或相簿返回）	String
labels	简易文件标签列表，跟tagList不同，它是通过上传、修改文件时指定的	Array
category	文件自定义的分类	Int
linkTo	符号链接指向的下一级文件的inode，当文件为符号链接时返回	String