获取盘信息
获取盘信息
请求说明
| 请求地址 | https://openapi.wps.cn/v7/drives/{drive_id}/meta |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1 |
| 权限要求 | 管理驱动盘（应用授权） kso.drive.readwrite管理驱动盘（用户授权） kso.drive.readwrite |
请求头（Header）
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用：application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值，详见《签名方法》 |
| Authorization | string | 是 | 授权凭证，格式为：Bearer {access_token} |
路径参数（Path）
| 名称 | 参数类型 | 说明 |
|---|---|---|
| drive_id | string |
查询参数（Query）
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| with_ext_attrs | boolean | 否 | 是否获取盘扩展属性 |
请求地址示例
[GET] https://openapi.wps.cn/v7/drives/{drive_id}/meta?with_ext_attrs={boolean}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败，参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ allotee_id | string | 盘归属身份 id |
| ∟ allotee_type | string[enum] | 盘归属身份类型 user；group；app |
| ∟ company_id | string | 企业 id |
| ∟ created_by | object | 创建者 |
| ∟ ∟ avatar | string | 用户或应用的头像 |
| ∟ ∟ company_id | string | 身份所归属的公司 |
| ∟ ∟ id | string | 身份 id |
| ∟ ∟ name | string | 用户或应用的名称 |
| ∟ ∟ type | string[enum] | 身份类型 user；sp |
| ∟ ctime | integer | 创建时间 |
| ∟ description | string | 盘描述 |
| ∟ ext_attrs | array[object] | 盘扩展属性 |
| ∟ ∟ name | string | 属性名 |
| ∟ ∟ value | string | 属性值 |
| ∟ id | string | 驱动盘 id |
| ∟ mtime | integer | 修改时间 |
| ∟ name | string | 驱动盘名称 |
| ∟ quota | object | 盘容量 |
| ∟ ∟ deleted | integer | 回收站中的文件占用的总空间，以字节为单位。只读 |
| ∟ ∟ remaining | integer | 剩余的总空间，以字节为单位。只读 |
| ∟ ∟ total | integer | 允许的总存储空间，以字节为单位。只读 |
| ∟ ∟ used | integer | 已使用的总空间，以字节为单位。只读 |
| ∟ source | string | 盘来源 |
| ∟ status | string[enum] | 盘状态 inuse；deleted |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"allotee_id": "string",
"allotee_type": "string[enum]",
"company_id": "string",
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "string[enum]"
},
"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
},
"source": "string",
"status": "string[enum]"
},
"msg": "string"
}