Skip to content

获取盘列表

标签驱动盘

请求说明

字段
请求地址
https://openapi.wps.cn/v7/drives
HTTP 方法
GET
接口描述
获取盘列表
签名方式
KSO-1
限频策略
权限要求
管理驱动盘(应用授权) kso.drive.readwrite
管理驱动盘(用户授权) kso.drive.readwrite

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external

查询参数 (Query)

属性名类型是否必填描述可选值
allotee_type
string盘归属身份类型,盘归属身份类型:user-获取操作者自己的私有盘列表,group-获取用户组下的盘列表, app-获取应用下的应用盘列表user, group, app
allotee_id
string盘归属身份id,当allotee_type为user时,该参数仅可传操作者id(公网可不传,默认为当前操作者id),或者可以不传默认为操作者id;当allotee_type为group时,传入group_id;当allotee_type为app时,仅传入操作应用的spid(公网可不传,默认为当前操作应用spid)-
with_ext_attrs
boolean是否获取盘扩展属性-
page_size
integer分页大小,公网限制最大为500-
page_token
string分页token-
sources
array盘来源,当allotee_type为user时该参数目前可多选

公网:special(我的云文档)、tmp(我的漫游箱)、secret(私密文件夹)、feature(签名团队)

私网:private(我的云文档)、roaming(我的漫游箱)
-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "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
        },
        "source": "string",
        "status": "inuse"
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "msg": "string"
}