Skip to content

获取盘列表

适用版本>=v7.0.2412a.20241212

接口说明:获取驱动盘列表

请求说明

请求地址配置域名+/openapi+/v7/drives
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求管理驱动盘(应用授权) kso.drive.readwrite

请求头(Header)

名称类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
allotee_idstring盘归属的应用id,长度不超过1024位
allotee_typestring盘归属身份类型,固定为app
page_sizeinteger分页大小,[1,1024]
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果
with_ext_attrsboolean是否获取盘扩展属性
sourcesobject[]盘的来源,默认获取全部来源的盘,可多选(应用文档:忽略此参数)

响应体(Response)

名称类型说明
dataobject返回信息
itemsobject[]盘列表
allotee_idstring盘归属的应用id
allotee_typestring盘归属身份类型,固定为app
company_idstring企业id(应用文档:忽略此参数)
created_byobject创建者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
ctimeinteger创建时间,时间戳,单位为秒
descriptionstring盘描述
ext_attrsobject[]盘扩展属性
namestring名称
valuestring
idstring驱动盘id
mtimeinteger修改时间,时间戳,单位为秒
namestring驱动盘名称
permission_modestringEnum: "builtin" "callback",权限校验模式
quotaobject[]盘容量(应用文档:返回-1)
deletedinteger回收站中的文件占用的总空间,以字节为单位。只读。
remaininginteger剩余的总空间,以字节为单位。只读。
totalinteger允许的总存储空间,以字节为单位。只读。
usedinteger已使用的总空间,以字节为单位。只读。
sourcestring盘来源,应用文档:appfile
statusstring盘状态
inuse:使用中
deleted: 已删除
storage_modestringEnum: "tree" "kv",驱动盘组织结构
bucketstring驱动盘归属的存储key
next_page_tokenstring下一页分页标记,<= 1024 characters;当查询结果中next_page_token为空或无该返回值时,代表无下一页
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例

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