获取文档库信息
适用版本>=v7.0.2308b.20230824
接口说明:获取文档库信息
请求说明
| 请求地址 | 配置域名+/graph+/v7/doclib/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 更新文档库(用户授权) kso.doclib.write 查询文档库(应用授权) kso.appdrive.doclib.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间,示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 文档库驱动盘id |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 文档库模型 |
| ∟ drive | object | 文档库驱动盘信息 |
| ∟ ∟ allotee_id | string | 盘归属身份idallotee_type=user,allotee_id代表用户id;allotee_type=group,allotee_id代表用户组id |
| ∟ ∟ allotee_type | string | 盘归属身份类型,可选值: user:用户 group:用户组 |
| ∟ ∟ company_id | string | 企业id,<= 1024 characters |
| ∟ ∟ created_by | object | 创建者 |
| ∟ ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ∟ ctime | int | 创建时间,时间戳,单位为秒 |
| ∟ ∟ description | string | 盘描述,<= 1024 characters |
| ∟ ∟ ext_attrs | object[] | 盘扩展属性,<= 1024 items |
| ∟ ∟ ∟ name | string | 属性名,<= 1024 characters |
| ∟ ∟ ∟ value | string | 属性值,<= 1024 characters |
| ∟ ∟ id | string | 驱动盘id |
| ∟ ∟ mtime | int | 修改时间,时间戳,单位为秒 |
| ∟ ∟ name | string | 驱动盘名称 |
| ∟ ∟ quota | object | 盘容量 |
| ∟ ∟ ∟ deleted | int | 回收站中的文件占用的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ remaining | int | 剩余的总空间,以字节为单位。只读。 |
| ∟ ∟ ∟ total | int | 允许的总存储空间,以字节为单位。只读。 |
| ∟ ∟ ∟ used | int | 已使用的总空间,以字节为单位。只读。 |
| ∟ ∟ status | string | 盘状态inuse:使用中;deleted:已删除; |
| ∟ group | object | 文档库用户组信息 |
| ∟ ∟ avatar | string | 头像 |
| ∟ ∟ creator_id | string | 创建者ID 创建时即确定,不被修改。 |
| ∟ ∟ ctime | int | 创建时间,时间戳,单位为秒 |
| ∟ ∟ description | string | 描述介绍 |
| ∟ ∟ id | string | 组ID |
| ∟ ∟ mtime | int | 修改时间,时间戳,单位为秒 |
| ∟ ∟ name | string | 名称 |
| ∟ ∟ owner_id | string | 拥有者ID |
| ∟ ∟ status | string | 用户组状态enable:正常;deleted:删除; |
| ∟ ∟ type | string | 用户组类型normal:普通用户组;dept:部门用户组;whole:全员用户组 |
| ∟ user_role | string | 当前成员角色信息normal:普通成员;admin:管理员;owner:拥有者 |
响应体示例
{
"data": {
"drive": {
"allotee_id": "string",
"allotee_type": "user",
"company_id": "string",
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "user"
},
"ctime": 0,
"description": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"mtime": 0,
"name": "string",
"quota": {
"deleted": 0,
"remaining": 0,
"total": 0,
"used": 0
},
"status": "inuse"
},
"group": {
"avatar": "string",
"company_id": "string",
"creator_id": "string",
"ctime": 1,
"description": "string",
"id": "string",
"mtime": 1,
"name": "string",
"owner_id": "string",
"status": "enable",
"type": "normal"
},
"user_role": "normal"
},
"code": 0,
"detail": "string",
"msg": "string"
}