获取文件信息
适用版本>=v7.0.2404b.20240425
接口说明:获取文件元信息
请求说明
| 请求地址 | 配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 应用身份管理文档(应用授权) kso.appfile.readwrite |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 驱动盘id,长度不超过1024位 |
| file_id | string | 是 | 文件id,长度不超过1024位 |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| with_permission | boolean | 否 | 是否返回文件操作权限(应用文档:忽略此参数) |
| with_link | boolean | 否 | 是否返回文件分享信息(应用文档:忽略此参数) |
| with_ext_attrs | boolean | 否 | 是否返回文件扩展属性(应用文档:忽略此参数) |
| with_drive | boolean | 否 | 是否返回文件所属drive信息 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ created_by | object | 创建者信息 |
| ∟ ∟ id | string | 身份ID |
| ∟ ∟ type | string | Enum: "user" "sp",身份类型 |
| ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ drive | object | 驱动盘信息 |
| ∟ ∟ allotee_id | string | 盘归属的应用id,长度不超过1024位 |
| ∟ ∟ allotee_type | string | 盘归属身份类型,固定为app |
| ∟ ∟ company_id | string | 企业id(应用文档:忽略此参数) |
| ∟ ∟ created_by | object | 创建者信息 |
| ∟ ∟ ∟ id | string | 身份ID |
| ∟ ∟ ∟ type | string | Enum: "user" "sp",身份类型 |
| ∟ ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ ∟ description | string | 盘描述 |
| ∟ ∟ ext_attrs | object[] | 盘扩展属性 |
| ∟ ∟ ∟ name | string | 名称 |
| ∟ ∟ ∟ value | string | 值 |
| ∟ ∟ id | string | 驱动盘id |
| ∟ ∟ mtime | integer | 修改时间,时间戳,单位为秒 |
| ∟ ∟ name | string | 驱动盘名称 |
| ∟ ∟ permission_mode | string | Enum: "builtin" "callback",权限校验模式 |
| ∟ ∟ quota | object[] | 盘容量(应用文档:返回-1) |
| ∟ ∟ ∟ deleted | integer | 回收站中的文件占用的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ remaining | integer | 剩余的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ total | integer | 允许的总存储空间,以字节为单位。只读。 |
| ∟ ∟ ∟ used | integer | 已使用的总空间,以字节为单位。只读。 |
| ∟ ∟ source | string | 盘来源,应用文档:appfile |
| ∟ ∟ status | string | Enum: "inuse" "deleted",盘状态 |
| ∟ ∟ storage_mode | string | Enum: "tree" "kv",驱动盘组织结构 |
| ∟ drive_id | string | 驱动盘id |
| ∟ id | string | 文件id |
| ∟ link_id | string | 链接id(应用文档:忽略此参数) |
| ∟ link_url | string | 链接url(应用文档:忽略此参数) |
| ∟ modified_by | object | 修改者信息 |
| ∟ ∟ id | string | 身份ID |
| ∟ ∟ type | string | Enum: "user" "sp",身份类型 |
| ∟ mtime | integer | 修改时间,时间戳,单位为秒 |
| ∟ name | string | 文件名 |
| ∟ parent_id | string | 父目录id(应用文档:0) |
| ∟ shared | boolean | 是否开启分享(应用文档:false) |
| ∟ size | integer | 文件大小 |
| ∟ type | string | Enum: "folder" "file" "shortcut",文件类型(应用文档:file) |
| ∟ version | integer | 文件版本号 |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
{
"data": {
"created_by": {
"id": "string",
"type": "sp"
},
"ctime": 0,
"drive": {
"allotee_id": "string",
"allotee_type": "app",
"company_id": "string",
"created_by": {
"id": "string",
"type": "sp"
},
"ctime": 0,
"description": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"mtime": 0,
"name": "string",
"permission_mode": "callback",
"quota": {
"deleted": -1,
"remaining": -1,
"total": -1,
"used": -1
},
"source": "string",
"status": "inuse",
"storage_mode": "kv"
},
"drive_id": "string",
"id": "string",
"link_id": "string",
"link_url": "string",
"modified_by": {
"id": "string",
"type": "sp"
},
"mtime": 0,
"name": "string",
"parent_id": "string",
"shared": false,
"size": 0,
"type": "file",
"version": 0
},
"code": 0,
"detail": "string",
"msg": "string"
}