文档首页/ 云空间服务 KooDrive/ API参考/ API/ 文件管理/ 获取文件详情
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

获取文件详情

功能介绍

获取文件详情，如文件大小、名称、修改时间等。

URI

POST /koodrive/ose/v1/files/{fileId}/detail

表1 路径参数

参数

是否必选

参数类型

描述

fileId

是

String

文件ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}

X-User-Id

是

String

用户id,用于app鉴权

X-Date

是

String

日期,用于app鉴权

Host

是

String

地址,用于app鉴权

X-Traceid

否

String

消息日志跟踪标识（必须58位）

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
表3 请求Body参数

参数

是否必选

参数类型

描述

containerId

是

String

空间标识

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

文件id

fileName

String

文件名，最长250个字符

fileType

String

文件类型，外部输入

mimeType

String

内容类型

recycled

Boolean

文件是否被放入回收站

parentFolder

Array of strings

父目录ID列表，注意：当前只取第一个父目录Id

properties

Map<String,String>

文件公共自定义属性。key-value个数不能超过30个；单个key-value长度不超过124字符

containers

Array of strings

空间标识

createdTime

String

文件创建时间，UTC时间。

editedTime

String

文件修改时间，UTC时间。

owners

Array of User objects

拥有者

lastEditor

User object

最后编辑者

fileSuffix

String

文件后缀，fullFileExtension最后一个字符串

size

Integer

文件大小

attachments

Array of AttachmentMetadata objects

附件（用途，附件）

code

String

返回码

msg

String

返回信息
表5 User

参数

参数类型

描述

category

String

类型，drive#user

userId

String

华为用户ID

displayName

String

用户显示名

me

Boolean

是否是我

permissionId

String

权限id
表6 AttachmentMetadata

参数

参数类型

描述

usage

String

用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段

hash

String

Asset关联的资源的hash

sha256

String

Asset关联的资源的sha256

asset

AssetMetadata object

资产
表7 AssetMetadata

参数

参数类型

描述

id

String

Asset ID

versionId

String

Asset版本ID

version

Long

版本号

mimeType

String

MIME type

state

Integer

数据的状态

  • 0：可用

  • 1：不可用

  • 2：临时

  • 3：留存（不可飞速）

  • 4：待割接

createdTime

String

数据创建时间，UTC时间。

modifiedTime

String

数据最后修改时间，UTC时间。

resource

ResourceMetadata object

资源

attributes

Map<String,Object>

类型属性（Key部分使用字母开头的字母加数字组合，Value部分禁止使用emoji字符，不限单个属性长度，限制总大小为16K以内）
表8 ResourceMetadata

参数

参数类型

描述

id

String

文件资源ID

length

Long

文件资源的长度

sha256

String

文件的sha256（用于完整性校验）

objects

Array of SliceObjectMetadata objects

分片对象，适用于type={0,3}
表9 SliceObjectMetadata

参数

参数类型

描述

id

String

分片ID

start

Long

分片的起始位置，不适用于type={12}

downloadUrl

EndpointURLMetadata object

下载url
表10 EndpointURLMetadata

参数

参数类型

描述

url

String

URL

method

String

http method

请求示例

查看文件详情。

POST /koodrive/ose/v1/files/FqNZrzGgSKHkfGmwjf7dLgLlGkwrLEU35/detail

Authorization:Bearer+10f88*********4791e9ff

{
  "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"
}

响应示例

状态码： 200

文件详情

{
  "id" : "FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y",
  "fileName" : "下载_20231213_160540.png",
  "mimeType" : "image/png",
  "fileSuffix" : "png",
  "recycled" : false,
  "size" : 81243,
  "parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ],
  "containers" : [ "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4" ],
  "properties" : {
    "localCreatedAt" : "",
    "localUpdatedAt" : "",
    "createUser" : "369528171409614001",
    "lastEditUser" : "369528171409614001"
  },
  "attachments" : [ {
    "asset" : {
      "id" : "1310155787561278720",
      "versionId" : "1310155787561278721",
      "version" : 612304,
      "mimeType" : "image/png",
      "state" : 0,
      "createdTime" : "2023-12-13T08:05:40.655Z",
      "modifiedTime" : "2023-12-13T08:05:40.655Z",
      "resource" : {
        "id" : "1275457496273837312",
        "length" : 81243,
        "sha256" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2",
        "object" : {
          "id" : "b91e8df8afba4145a310dde1bfb9f8c5086",
          "start" : 0,
          "downloadUrl" : {
            "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/b91e8df8afba4145a310dde1bfb9f8c5086?response-content-disposition=attachment%3B%20filename%3D%22%25E4%25B8%258B%25E8%25BD%25BD_20231213_160540.png%22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231227T073619Z&X-Amz-SignedHeaders=host&X-Amz-Expires=10000&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20231227%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=6fc56f74a9478e088e1e044f453c33f8cc7b403f4478d3aefd923449349373e4",
            "method" : "GET"
          }
        }
      },
      "attributes" : {
        "fileName" : "下载.png",
        "localCreatedAt" : "",
        "createdBy" : "40086000004871666",
        "resource" : {
          "id" : "1275457496273837312",
          "object" : {
            "bucket" : "b10-obs-ykj-uat-01",
            "objectId" : "b91e8df8afba4145a310dde1bfb9f8c5086"
          }
        },
        "localUpdatedAt" : ""
      }
    },
    "hash" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2",
    "usage" : "content",
    "sha256" : "f08b00d63f9109fda252e45cc70e2762347907aba7c5dea4de7eb179ddad1ab2"
  } ],
  "owners" : [ {
    "category" : "drive#user",
    "me" : true,
    "permissionId" : "1243622029865966464",
    "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
    "displayName" : "租户管理员"
  } ],
  "lastEditor" : {
    "category" : "drive#user",
    "me" : true,
    "permissionId" : "1243622029865966464",
    "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
    "displayName" : "租户管理员"
  },
  "fileType" : "15",
  "createdTime" : "2023-12-13T08:05:40.601Z",
  "editedTime" : "2023-12-13T08:05:41.054Z",
  "code" : 0,
  "msg" : "Success."
}

状态码

状态码

描述

200

文件详情
父主题： 文件管理

相关文档