Skip to content

获取盘列表

适用版本>=v7.0.2410as.20241017

接口说明:获取盘列表

标签驱动盘

请求说明

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

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

查询参数 (Query)

属性名类型是否必填描述可选值
allotee_type
string盘归属身份类型,
可选值:
user:用户;group:用户组
-
allotee_id
string盘归属身份id,
allotee_type=user,allotee_id代表用户id
allotee_type=group,allotee_id代表用户组id
-
with_ext_attrs
boolean是否获取盘扩展属性-
page_size
integer分页大小,最大值:1024-
page_token
string分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果;当查询结果中next_page_token为空或无该返回值时,代表无下一页。-

响应体(Response)

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

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "allotee_id": "string",
        "allotee_type": "string",
        "bucket": "string",
        "company_id": "string",
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        },
        "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"
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "msg": "string"
}