获取空间使用量
适用版本>=v7.0.2412a.20241212
接口说明:获取空间使用量
请求说明
| 请求地址 | 配置域名+/openapi+/v7/space/statistics |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理空间配额(应用授权) kso.space_quota.readwrite |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| allocate_type | string | 是 | 配额主体的类型,user: 用户;doclib: 云文档团队;dept:部门 |
| allocate_to_list | string[] | 否 | 配额主体唯一标识,若传该值则scope_type、scope_id传参失效 |
| limit | int64 | 是 | 分页大小 |
| offset | int64 | 是 | 分页偏移 |
| scope_type | string | 否 | 查询范围类型,不传则默认查询根部门。可选值:dept: 部门 |
| scope_id | string | 否 | 查询范围id,若scope_type已传值,则该值必传。scope_type为dept时,scope_id为部门Id |
| with_file_parts | boolean | 否 | 是否获取文档类型组成分配 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 返回信息体 |
| ∟ items | object[] | |
| ∟ ∟ allocate_to | string | 配额主体唯一标识 |
| ∟ ∟ allocate_type | string | 配额主体类型 |
| ∟ ∟ file_parts | object[] | 文档组成部分 |
| ∟ ∟ ∟ type | string | 组成部分,document:文档;image:图片;audiovisual:音视频;other:其它; |
| ∟ ∟ ∟ used | string | 已使用大小;单位字节 |
| ∟ ∟ used | string | 已使用大小;单位字节 |
| ∟ total | string | 总数 |
响应体示例
json
{
"data": {
"items": [
{
"allocate_to": "string",
"allocate_type": "user",
"file_parts": [
{
"type": "document",
"used": 0
}
],
"used": 0
}
],
"total": 0
},
"code": 0,
"detail": "string",
"msg": "string"
}