阿里云首页 相册与网盘服务

用户操作API

概览

用户操作API,适用于标准模式和托管模式。

版本信息

版本 : 2.0.0

URI scheme

域名 : {domainId}.api.aliyunpds.com

基础路径 : /v2

协议 : HTTP, HTTPS

请求Content-Type

  • application/json

返回Content-Typ

  • application/json

API

创建用户

POST /v2/user/create

说明

创建用户,只有管理员可以调用

Body参数

创建用户的请求参数

名称 : 创建用户请求标志 : 必填类型 : CreateUserRequest

响应

HTTP代码

说明

类型

201

创建用户成功

CreateUserResponse

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/create

请求 body

{
  "avatar" : "http://a.b.c/pds.jpg",
  "description" : "pds team user",
  "email" : "123@pds.com",
  "nick_name" : "pdsuser",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "user_id" : "pdsuserid",
  "user_name" : "abc"
}

HTTP响应示例

响应 201

{
  "avatar" : "http://a.b.c/pds.jpg",
  "created_at" : 1567407718386,
  "default_drive_id" : "123",
  "description" : "pds team user",
  "domain_id" : "hz999",
  "email" : "123@pds.com",
  "nick_name" : "abc",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "updated_at" : 1567407718386,
  "user_id" : "pdsuserid",
  "user_name" : "name"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

删除用户

POST /v2/user/delete

说明

只有管理员可以调用

Body参数

删除用户的请求参数

名称 : 删除用户请求标志 : 必填类型 : DeleteUserRequest

响应

HTTP代码

说明

类型

204

无返回内容

无内容

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/delete

请求 body

{
  "user_id" : "pdsuserid"
}

HTTP响应示例

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

获取用户信息

POST /v2/user/get

说明

获取用户详细信息,普通用户只能获取自己的信息,管理员可以获取任意用户的信息。

Body参数

获取用户信息的请求参数

名称 : 获取用户信息请求标志 : 必填类型 : GetUserRequest

响应

HTTP代码

说明

类型

200

获取用户信息成功

GetUserResponse

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

404

指定的用户不存在

NotFoundError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/get

请求 body

{
  "user_id" : "string"
}

HTTP响应示例

响应 200

{
  "avatar" : "http://a.b.c/pds.jpg",
  "created_at" : 1567407718386,
  "default_drive_id" : "123",
  "description" : "pds team user",
  "domain_id" : "hz999",
  "email" : "123@pds.com",
  "nick_name" : "abc",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "updated_at" : 1567407718386,
  "user_id" : "pdsuserid",
  "user_name" : "name"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 404

{
  "code" : "NotFound",
  "message" : "The resource {resource_name} cannot be found. Please check."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

获取用户列表

POST /v2/user/list

说明

只有管理员可以调用

Body参数

列举用户的请求参数

名称 : 列举用户请求标志 : 必填类型 : ListUserRequest

响应

HTTP代码

说明

类型

200

列举用户列表成功

ListUserResponse

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/list

请求 body

{
  "limit" : 10,
  "marker" : "marker"
}

HTTP响应示例

响应 200

{
  "items" : [ {
    "avatar" : "http://a.b.c/pds.jpg",
    "created_at" : 1567407718386,
    "default_drive_id" : "123",
    "description" : "pds team user",
    "domain_id" : "hz999",
    "email" : "123@pds.com",
    "nick_name" : "abc",
    "phone" : "1370000****",
    "role" : "user",
    "status" : "enabled",
    "updated_at" : 1567407718386,
    "user_id" : "pdsuserid",
    "user_name" : "name"
  } ],
  "next_marker" : "nextmarker"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

查询用户

POST /v2/user/search

说明

该接口将会根据条件查询用户,只有管理员可以调用

Body参数

查询用户的请求参数

名称 : 查询用户请求标志 : 必填类型 : SearchUserRequest

响应

HTTP代码

说明

类型

200

查询用户成功

ListUserResponse

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/search

请求 body

{
  "email" : "abc@pds.com",
  "limit" : 10,
  "marker" : "marker",
  "nick_name" : "la",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "user_name" : "abc"
}

HTTP响应示例

响应 200

{
  "items" : [ {
    "avatar" : "http://a.b.c/pds.jpg",
    "created_at" : 1567407718386,
    "default_drive_id" : "123",
    "description" : "pds team user",
    "domain_id" : "hz999",
    "email" : "123@pds.com",
    "nick_name" : "abc",
    "phone" : "1370000****",
    "role" : "user",
    "status" : "enabled",
    "updated_at" : 1567407718386,
    "user_id" : "pdsuserid",
    "user_name" : "name"
  } ],
  "next_marker" : "nextmarker"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

更新用户信息

POST /v2/user/update

说明

用户可以修改自己的description,nick_name,avatar;管理员在用户基础上还可修改status(可以修改任意用户);超级管理员在管理员基础上还可修改role(可以修改任意用户)。

Body参数

更新用户的请求参数

名称 : 更新用户信息请求标志 : 必填类型 : UpdateUserRequest

响应

HTTP代码

说明

类型

200

更新用户成功

UpdateUserResponse

400

1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

403

1.ForbiddenNoPermissionError 没有用户接口权限 2.ForbiddenAccountNotFoundError 账号没找到

ForbiddenNoPermissionError

404

指定的用户不存在

NotFoundError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • user

HTTP请求示例

请求 path

/v2/user/update

请求 body

{
  "avatar" : "http://a.b.c/pds.jpg",
  "description" : "pds team user",
  "email" : "123@pds.com",
  "nick_name" : "pdsuser",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "user_id" : "pdsuserid"
}

HTTP响应示例

响应 200

{
  "avatar" : "http://a.b.c/pds.jpg",
  "created_at" : 1567407718386,
  "default_drive_id" : "123",
  "description" : "pds team user",
  "domain_id" : "hz999",
  "email" : "123@pds.com",
  "nick_name" : "abc",
  "phone" : "1370000****",
  "role" : "user",
  "status" : "enabled",
  "updated_at" : 1567407718386,
  "user_id" : "pdsuserid",
  "user_name" : "name"
}

响应 400

{
  "code" : "InvalidParameter",
  "message" : "The input parameter {parameter_name} is not valid."
}

响应 403

{
  "code" : "ForbiddenNoPermission",
  "message" : "No Permission to access resource {resource_name}."
}

响应 404

{
  "code" : "NotFound",
  "message" : "The resource {resource_name} cannot be found. Please check."
}

响应 500

{
  "code" : "InternalError",
  "message" : "The request has been failed due to some unknown error."
}

响应 503

{
  "code" : "ServiceUnavailable",
  "message" : "The request has failed due to a temporary failure of the server."
}

定义

APIError

APIError is api error common struct

名称

说明

类型

code必填

样例 : "string"

string

message必填

样例 : "string"

string

AlreadyExistError

AlreadyExistError 已经存在错误

名称

说明

类型

code必填

样例 : "AlreadyExist"

string

message必填

样例 : "{resource} has already exists. {extra_msg}"

string

BasePDSFileResponse

Base file response

名称

说明

类型

category可选

category 样例 : "doc"

enum (doc, image, audio, video)

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

hidden可选

Hiddentype: boolean 样例 : false

boolean

image_media_metadata可选

样例 : "[imagemediaresponse](#imagemediaresponse)"

ImageMediaResponse

labels可选

labels 样例 : [ "label1:1", "label2:2" ]

< string > array

meta可选

meta 样例 : "file meta"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_id可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "root"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

starred可选

starredtype: boolean 样例 : false

boolean

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

BaseDriveResponse

Base drive response

名称

说明

类型

creator可选

Drive 创建者 样例 : "pds"

string

description可选

Drive 备注信息 样例 : "pds team drive"

string

domain_id可选

Domain ID 样例 : "hz999"

string

drive_id可选

Drive ID 样例 : "123"

string

drive_name可选

Drive 名称 样例 : "pdsdrive"

string

drive_type可选

Drive 类型 样例 : "normal"

string

owner可选

Drive 所有者 样例 : "pds"

string

relative_path可选

Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/"

string

status可选

Drive 状态 样例 : "enabled"

string

store_id可选

存储 ID, domain的PathType为OSSPath时返回 样例 : "123"

string

total_size可选

Drive 空间总量 样例 : 102400

integer (int64)

used_size可选

Drive 空间已使用量 样例 : 1024

integer (int64)

BaseOSSFileResponse

Base file response

名称

说明

类型

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_path可选

file_path 样例 : "/a.jpg"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_path可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "/"

string

share_id可选

share_id 模式 : "[0-9]+"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

BaseShareResponse

List share response

名称

说明

类型

created_at可选

created_at 样例 : "2006-01-02T15:04:05.999Z"

string

creator可选

creator 样例 : "xxx"

string

description可选

description 样例 : "share description"

string

domain_id可选

domain_id 样例 : "domain-1"

string

drive_id可选

drive_id 样例 : "1"

string

expiration可选

expiration 样例 : "2006-01-02T15:04:05.999Z"

string

expired可选

expired 样例 : false

boolean

owner可选

owner 样例 : "xxx"

string

permissions可选

permissions 样例 : [ ]

< string > array

share_file_path可选

share_path 样例 : "/a/b/c/"

string

share_id可选

share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

share_name可选

share_name 样例 : "new_share"

string

status可选

status 样例 : "enabled"

string

updated_at可选

updated_at 样例 : "2006-01-02T15:04:05.999Z"

string

BaseUserResponse

Base user response

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

created_at可选

用户创建时间 样例 : 1567407718386

integer (int64)

default_drive_id可选

默认 Drive ID 样例 : "123"

string

description可选

用户备注信息 样例 : "pds team user"

string

domain_id可选

Domain ID 样例 : "hz999"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "abc"

string

phone可选

电话 样例 : "1370000****"

string

role可选

角色 样例 : "user"

string

status可选

用户状态 样例 : "enabled"

string

updated_at可选

用户修改时间 样例 : 1567407718386

integer (int64)

user_id可选

用户 ID 样例 : "pdsuserid"

string

user_name可选

用户名称 样例 : "name"

string

BatchSubResponse

名称

说明

类型

body可选

body 子请求的返回结果,可参考对于子请求文档 json 字符串 样例 : {<br> "drive_id" : "101",<br> "file_id" : "xxxxxx"<br>}

< string, object > map

id可选

id 请求带过来的id, 可以跟 request 进行关联 样例 : "\"1\""

string

status可选

status 子请求的返回状态码,可参考对于子请求文档 样例 : 200

integer (int64)

PDSBatchResponse

batch operation response

名称

说明

类型

responses可选

responses 返回结果合集 样例 : [ "[batchsubresponse](#batchsubresponse)" ]

< BatchSubResponse > array

PDSCompleteFileResponse

complete file response

多态性 : 成分

名称

说明

类型

category可选

category 样例 : "doc"

enum (doc, image, audio, video)

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc可选

crc 样例 : "string"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

hidden可选

Hiddentype: boolean 样例 : false

boolean

image_media_metadata可选

样例 : "[imagemediaresponse](#imagemediaresponse)"

ImageMediaResponse

labels可选

labels 样例 : [ "label1:1", "label2:2" ]

< string > array

meta可选

meta 样例 : "file meta"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_id可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "root"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

starred可选

starredtype: boolean 样例 : false

boolean

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

PDSCopyFileResponse

文件拷贝 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

PDSCreateFileResponse

Create file response

名称

说明

类型

domain_id可选

domain_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "domain"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d79206586bb5dd69fb34c349282718146c55da7"

string

parent_file_id可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "root"

string

part_info_list可选

part_info_list 样例 : "["

< UploadPartInfo > array

rapid_upload可选

rapid_uploadtype: boolean 样例 : false

boolean

type可选

type 样例 : "file"

enum (file, folder)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

PDSDeleteFileResponse

删除文件 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

PDSDeleteFilesResponse

批量删除文件 response

名称

说明

类型

deleted_file_id_list可选

deleted_file_id_list 样例 : [ ]

< string > array

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

PDSGetAsyncTaskResponse

Get AsyncTask Response

名称

说明

类型

async_task_id可选

async_task_idtype:string 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

message可选

message 样例 : "task is running"

string

state可选

state 样例 : "success"

enum (Running, Failed, Succeed)

PDSGetDownloadUrlResponse

获取download url response

名称

说明

类型

expiration可选

expiration 样例 : "2006-01-02T15:04:05.999Z07:00"

string

method可选

method 样例 : "GET"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"

string

PDSGetFileResponse

获取文件元数据response

多态性 : 成分

名称

说明

类型

category可选

category 样例 : "doc"

enum (doc, image, audio, video)

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

hidden可选

Hiddentype: boolean 样例 : false

boolean

image_media_metadata可选

样例 : "[imagemediaresponse](#imagemediaresponse)"

ImageMediaResponse

labels可选

labels 样例 : [ "label1:1", "label2:2" ]

< string > array

meta可选

meta 样例 : "file meta"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_id可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "root"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

starred可选

starredtype: boolean 样例 : false

boolean

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

PDSGetUploadUrlResponse

Get UploadUrl Response

名称

说明

类型

create_at可选

created_at 样例 : "2019-09-11T16:34:36.977Z"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

part_info_list可选

part_info_list 样例 : [ ]

< UploadPartInfo > array

upload_id可选

upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"

string

PDSListFileResponse

List file response

名称

说明

类型

items可选

items 样例 : [ ]

< BasePDSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

PDSListUploadedPartResponse

获取签名 response

名称

说明

类型

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

next_part_number_marker可选

next_part_number_marker 样例 : "4"

string

upload_id可选

upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"

string

uploaded_parts可选

uploaded_parts 样例 : [ ]

< UploadPartInfo > array

PDSMoveFileResponse

文件移动 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

PDSSearchFileResponse

search file response

名称

说明

类型

items可选

items 样例 : [ ]

< BasePDSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

PDSUpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

名称

说明

类型

category可选

category 样例 : "doc"

enum (doc, image, audio, video)

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

DomainID 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_id可选

file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

hidden可选

Hiddentype: boolean 样例 : false

boolean

image_media_metadata可选

样例 : "[imagemediaresponse](#imagemediaresponse)"

ImageMediaResponse

labels可选

labels 样例 : [ "label1:1", "label2:2" ]

< string > array

meta可选

meta 样例 : "file meta"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_id可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "root"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

starred可选

starredtype: boolean 样例 : false

boolean

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

Captcha

名称

说明

类型

captcha必填

图片验证码,base64格式 样例 : "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABRElEQVR42t3YsQ4CIQwA0CZ+i36Bg5uTo1/gqquDTvf1JwkJqRR7vZYCJ2HClOMBVw5h/i7P9yvU+X8LFFsju728wRNhcQR+gyj27G2GtQGHxy5USaN6PV1n2Qt8Ou6ZKllPJ/MQ4PN0CzXrs9i4jS2dIelKMuBse18vd1zdweHZdnC2V3kwDsm0OnYHMDVLtnQICbZ0XuIpqAamaaMjmGbvOAV0Fmqew7XAmXlV0kqButcYhDs5PqYiGA9dDm6atCK7bpbGx5Jknxszlj5pYR5t8QMX8b5gLMSVCZGfw4svdtHsDqZmPooHJxte5NTCnx3twKvKIhgLcaXrSbP0iGBhIK/99aXlnrQst1/7BajDt7Txxl/rrqvuBOaGJY3Szt4GOBuoka2LhQYw/ic1eyww/5eV95x229IDmqHlS1vdrOjkA5iK2BYUhM2zAAAAAElFTkSuQmCC"

string

captcha_format必填

图片格式 样例 : "png"

string

captcha_id必填

图片验证码ID 样例 : "f4690fc255e2fb24c10ede079d3802b4cClRimRh67Q"

string

CreateDriveResponse

Create drive response

名称

说明

类型

domain_id可选

Domain ID 样例 : "hz999"

string

drive_id可选

Drive ID 样例 : "123"

string

CreateShareResponse

Create share response

名称

说明

类型

domain_id可选

domain_id 样例 : "domain-1"

string

share_id可选

share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

CreateUserRequest

Create user request

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

description可选

描述信息 样例 : "pds team user"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "pdsuser"

string

phone可选

电话号码 样例 : "1370000****"

string

role可选

角色 默认值 : "user"样例 : "user"

enum (superadmin, admin, user)

status可选

状态 默认值 : "enabled"样例 : "enabled"

enum (enabled, disabled)

user_id必填

用户 ID 样例 : "pdsuserid"

string

user_name可选

用户名称 样例 : "abc"

string

CreateUserResponse

Create user response

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

created_at可选

用户创建时间 样例 : 1567407718386

integer (int64)

default_drive_id可选

默认 Drive ID 样例 : "123"

string

description可选

用户备注信息 样例 : "pds team user"

string

domain_id可选

Domain ID 样例 : "hz999"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "abc"

string

phone可选

电话 样例 : "1370000****"

string

role可选

角色 样例 : "user"

string

status可选

用户状态 样例 : "enabled"

string

updated_at可选

用户修改时间 样例 : 1567407718386

integer (int64)

user_id可选

用户 ID 样例 : "pdsuserid"

string

user_name可选

用户名称 样例 : "name"

string

DeleteDriveResponse

delete drive response

类型 : object

DeleteUserRequest

Delete user request

名称

说明

类型

user_id必填

用户 ID 样例 : "pdsuserid"

string

DeleteUserResponse

Delete user response

类型 : object

DriveRelativePathNestedError

DriveRelativePathNestedError 路径嵌套错误

名称

说明

类型

code必填

样例 : "DriveRelativePathNested"

string

message必填

样例 : "the parameter relative_path nested inside of another relative_path: {path}."

string

ForbiddenAccountInDebtError

ForbiddenAccountInDebtError 账号欠费错误

名称

说明

类型

code必填

样例 : "ForbiddenAccountInDebt"

string

message必填

样例 : "The specified account is in debt."

string

ForbiddenAccountNotFoundError

ForbiddenAccountNotFoundError 账号没找到错误

名称

说明

类型

code必填

样例 : "ForbiddenAccountNotFound"

string

message必填

样例 : "The specified account does not exist."

string

ForbiddenError

ForbiddenError 被禁止错误

名称

说明

类型

code必填

样例 : "Forbidden"

string

message必填

样例 : "User not authorized to operate on the specified APIs."

string

ForbiddenNoPermissionError

ForbiddenNoPermissionError 没有权限错误

名称

说明

类型

code必填

样例 : "ForbiddenNoPermission"

string

message必填

样例 : "No Permission to access resource {resource_name}."

string

ForbiddenRiskControlError

ForbiddenRiskControlError 风险控制禁止访问错误

名称

说明

类型

code必填

样例 : "ForbiddenRiskControl"

string

message必填

样例 : "This operation is forbidden by Alibaba Cloud RiskControl system."

string

ForbiddenServiceRoleError

ForbiddenServiceRoleError 服务角色禁止访问错误

名称

说明

类型

code必填

样例 : "ForbiddenServiceRole"

string

message必填

样例 : "Cannot access specified service role."

string

GetDriveResponse

Get drive response

名称

说明

类型

creator可选

Drive 创建者 样例 : "pds"

string

description可选

Drive 备注信息 样例 : "pds team drive"

string

domain_id可选

Domain ID 样例 : "hz999"

string

drive_id可选

Drive ID 样例 : "123"

string

drive_name可选

Drive 名称 样例 : "pdsdrive"

string

drive_type可选

Drive 类型 样例 : "normal"

string

owner可选

Drive 所有者 样例 : "pds"

string

relative_path可选

Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/"

string

status可选

Drive 状态 样例 : "enabled"

string

store_id可选

存储 ID, domain的PathType为OSSPath时返回 样例 : "123"

string

total_size可选

Drive 空间总量 样例 : 102400

integer (int64)

used_size可选

Drive 空间已使用量 样例 : 1024

integer (int64)

GetShareResponse

Get share response

名称

说明

类型

created_at可选

created_at 样例 : "2006-01-02T15:04:05.999Z"

string

creator可选

creator 样例 : "xxx"

string

description可选

description 样例 : "share description"

string

domain_id可选

domain_id 样例 : "domain-1"

string

drive_id可选

drive_id 样例 : "1"

string

expiration可选

expiration 样例 : "2006-01-02T15:04:05.999Z"

string

expired可选

expired 样例 : false

boolean

owner可选

owner 样例 : "xxx"

string

permissions可选

permissions 样例 : [ ]

< string > array

share_file_path可选

share_path 样例 : "/a/b/c/"

string

share_id可选

share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

share_name可选

share_name 样例 : "new_share"

string

status可选

status 样例 : "enabled"

string

updated_at可选

updated_at 样例 : "2006-01-02T15:04:05.999Z"

string

GetUserRequest

Get user request

名称

说明

类型

user_id可选

用户 ID, 使用ak方式访问,该项必传, access_token访问如果不传,默认取自己的user信息example 样例 : "string"

string

GetUserResponse

Get user response

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

created_at可选

用户创建时间 样例 : 1567407718386

integer (int64)

default_drive_id可选

默认 Drive ID 样例 : "123"

string

description可选

用户备注信息 样例 : "pds team user"

string

domain_id可选

Domain ID 样例 : "hz999"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "abc"

string

phone可选

电话 样例 : "1370000****"

string

role可选

角色 样例 : "user"

string

status可选

用户状态 样例 : "enabled"

string

updated_at可选

用户修改时间 样例 : 1567407718386

integer (int64)

user_id可选

用户 ID 样例 : "pdsuserid"

string

user_name可选

用户名称 样例 : "name"

string

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

名称

说明

类型

code必填

样例 : "HTTPMethodNotAllowed"

string

message必填

样例 : "The request http method is not supported for this resource."

string

ImageMediaResponse

名称

说明

类型

height可选

height 默认值 : 0样例 : 720

integer (int64)

time可选

time 样例 : "string"

string (date-time)

width可选

width 默认值 : 0样例 : 1024

integer (int64)

IncorrectStatusError

IncorrectStatusError 状态不正确错误

名称

说明

类型

code必填

样例 : "IncorrectStatus"

string

message必填

样例 : "The current status does not support this operation."

string

InternalErrorError

InternalErrorError 内部错误

名称

说明

类型

code必填

样例 : "InternalError"

string

message必填

样例 : "The request has been failed due to some unknown error."

string

InvalidHeaderError

InvalidHeaderError 请求头不合法错误

名称

说明

类型

code必填

样例 : "InvalidHeader"

string

message必填

样例 : "Header {header_name} is not valid."

string

InvalidParameterEmptyError

InvalidParameterEmptyError 参数为空错误

名称

说明

类型

code必填

样例 : "InvalidParameterEmpty"

string

message必填

样例 : "The input parameter {parameter_name} is empty."

string

InvalidParameterError

InvalidParameterError 参数非法错误

名称

说明

类型

code必填

样例 : "InvalidParameter"

string

message必填

样例 : "The input parameter {parameter_name} is not valid."

string

InvalidParameterExpiredError

InvalidParameterExpiredError 参数已经过期错误

名称

说明

类型

code必填

样例 : "InvalidParameterExpired"

string

message必填

样例 : "The input parameter {resource} is expired. {extra_msg}"

string

InvalidParameterMissingError

InvalidParameterMissingError 参数缺失

名称

说明

类型

code必填

样例 : "InvalidParameterMissing"

string

message必填

样例 : "The input parameter {parameter_name} is missing."

string

InvalidParameterNotMatchError

InvalidParameterNotMatchError 参数不匹配错误

名称

说明

类型

code必填

样例 : "InvalidParameterNotMatch"

string

message必填

样例 : "The input parameter {parameter_name} doesn't match."

string

InvalidParameterNotSupportedError

InvalidParameterNotSupportedError 参数不支持错误

名称

说明

类型

code必填

样例 : "InvalidParameterNotSupported"

string

message必填

样例 : "The input parameter {parameter_name} is not supported."

string

InvalidParameterOutOfRangeError

InvalidParameterOutOfRangeError 参数超过范围错误

名称

说明

类型

code必填

样例 : "InvalidParameterOutOfRange"

string

message必填

样例 : "The input parameter {parameter_name} doesn't match the limitation."

string

InvalidParameterWrongFormatError

InvalidParameterWrongFormatError 参数格式错误

名称

说明

类型

code必填

样例 : "InvalidParameterWrongFormat"

string

message必填

样例 : "The input parameter {parameter_name} has invalid format."

string

InvalidRequestJSONFormatError

InvalidRequestJSONFormatError 请求JSON格式错误

名称

说明

类型

code必填

样例 : "InvalidRequestJSONFormat"

string

message必填

样例 : "{parameter_name} is invalid Json format."

string

InvalidResourceError

InvalidResourceError 非法资源错误

名称

说明

类型

code必填

样例 : "InvalidResource"

string

message必填

样例 : "The resource {resource_name} is not valid."

string

InvalidResourceIsEmptyError

InvalidResourceIsEmptyError 资源为空错误

名称

说明

类型

code必填

样例 : "InvalidResourceIsEmpty"

string

message必填

样例 : "The {resouce_name} resource %s is empty."

string

InvalidResourceUnsupportedError

InvalidResourceUnsupportedError 资源不支持错误

名称

说明

类型

code必填

样例 : "InvalidResourceUnsupported"

string

message必填

样例 : "The resource {resource_name} is not supported."

string

ListDriveResponse

list drive response

名称

说明

类型

items可选

Drive 列表 样例 : [ "[basedriveresponse](#basedriveresponse)" ]

< BaseDriveResponse > array

next_marker可选

翻页标记 样例 : "marker"

string

ListShareResponse

List share response

名称

说明

类型

items可选

items 样例 : [ ]

< BaseShareResponse > array

next_marker可选

next_marker 样例 : "string"

string

ListStorageFileResponse

List storage file

名称

说明

类型

items可选

itemsfile list 样例 : [ ]

< StoreFile > array

next_marker可选

样例 : "string"

string

ListStorageResponse

List storage

名称

说明

类型

items可选

items 样例 : [ ]

< StoreItemResponse > array

ListUserRequest

List user request

名称

说明

类型

limit可选

每页大小限制 默认值 : 100最小值 : 1最大值 : 100样例 : 10

integer (int32)

marker可选

翻页标记 样例 : "marker"

string

ListUserResponse

List user response

名称

说明

类型

items可选

样例 : [ "[baseuserresponse](#baseuserresponse)" ]

< BaseUserResponse > array

next_marker可选

翻页标记 样例 : "nextmarker"

string

NotEmptyError

NotEmptyError 不为空错误

名称

说明

类型

code必填

样例 : "NotEmpty"

string

message必填

样例 : "{resource_name} is not empty."

string

NotFoundError

NotFoundError 没有找到错误

名称

说明

类型

code必填

样例 : "NotFound"

string

message必填

样例 : "The resource {resource_name} cannot be found. Please check."

string

OSSCompleteFileResponse

complete file response

多态性 : 成分

名称

说明

类型

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc可选

crc 样例 : "string"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_path可选

file_path 样例 : "/a.jpg"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_path可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "/"

string

share_id可选

share_id 模式 : "[0-9]+"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

OSSCopyFileResponse

文件拷贝 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z-]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

share_id可选

drive_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

OSSCreateFileResponse

Create file response

名称

说明

类型

domain_id可选

domain_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "domain"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

part_info_list可选

part_info_list 样例 : "["

< UploadPartInfo > array

share_id可选

share_id 模式 : "[0-9]+"样例 : "1"

string

type可选

type 样例 : "file"

enum (file, folder)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

OSSDeleteFileResponse

删除文件 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

share_id可选

share_id 模式 : "[a-z0-9A-Z]+"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

OSSDeleteFilesResponse

批量删除文件 response

名称

说明

类型

deleted_file_id_list可选

deleted_file_id_list 样例 : [ ]

< string > array

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

share_id可选

share_id 模式 : "[0-9]+"样例 : "1"

string

OSSGetDownloadUrlResponse

获取download url response

名称

说明

类型

expiration可选

expiration 样例 : "2006-01-02T15:04:05.999Z07:00"

string

method可选

method 样例 : "GET"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"

string

OSSGetFileResponse

获取文件元数据response

多态性 : 成分

名称

说明

类型

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_path可选

file_path 样例 : "/a.jpg"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_path可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "/"

string

share_id可选

share_id 模式 : "[0-9]+"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

OSSGetUploadUrlResponse

Get UploadUrl Response

名称

说明

类型

create_at可选

created_at 样例 : "2019-09-11T16:34:36.977Z"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

part_info_list可选

part_info_list 样例 : [ ]

< UploadPartInfo > array

upload_id可选

upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"

string

OSSListFileResponse

List file response

名称

说明

类型

items可选

items 样例 : [ ]

< BaseOSSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

OSSListUploadedPartResponse

获取签名 response

名称

说明

类型

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

next_part_number_marker可选

next_part_number_marker 样例 : "4"

string

upload_id可选

upload_id 样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"

string

uploaded_parts可选

uploaded_parts 样例 : [ ]

< UploadPartInfo > array

OSSMoveFileResponse

文件移动 response

名称

说明

类型

async_task_id可选

async_task_id 样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z-]+"样例 : "test001"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_path可选

file_path 样例 : "/a/b/c.jpg"

string

share_id可选

drive_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

OSSSearchFileResponse

search file response

名称

说明

类型

items可选

items 样例 : [ ]

< BaseOSSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

OSSUpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

名称

说明

类型

content_hash可选

Content Hash 样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_type可选

content_type 样例 : "application/json"

string

crc64_hash可选

crc64_hash 样例 : "string"

string

created_at可选

created_at 样例 : "2019-08-20T06:51:27.292Z"

string

description可选

description 样例 : "file description"

string

domain_id可选

domain_id 模式 : "[a-z0-9A-Z]+"样例 : "test001"

string

download_url可选

download_url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

drive_id可选

drive_id 模式 : "[0-9]+"样例 : "1"

string

file_extension可选

file_extension 样例 : "jpg"

string

file_path可选

file_path 样例 : "/a.jpg"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1024}"样例 : "pds.jpg"

string

parent_file_path可选

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "/"

string

share_id可选

share_id 模式 : "[0-9]+"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

size可选

Size 最小值 : 0最大值 : 53687091200样例 : 1024

integer (int64)

status可选

status 样例 : "available"

enum (uploading, available)

thumbnail可选

thumbnail 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

trashed_at可选

trashed_at 样例 : "string"

string (date-time)

type可选

type 样例 : "file"

enum (file, folder)

updated_at可选

updated_at 样例 : "string"

string (date-time)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

url可选

url 样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"

string

PreHashCheckSuccessResponse

Pre hash check Response

名称

说明

类型

code可选

code 样例 : "string"

string

file_name可选

file_name 样例 : "string"

string

message可选

message 样例 : "string"

string

parent_file_id必填

parent_file_id 长度 : 40 - 50模式 : "[a-z0-9]{1, 50}"样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"

string

pre_hash可选

pre_hash 样例 : "string"

string

QuotaExhaustedError

QuotaExhaustedError 超出配额错误

名称

说明

类型

code必填

样例 : "QuotaExhausted"

string

message必填

样例 : "The resource {resource_name} has exceeded the limit."

string

ReadBodyErrorError

ReadBodyErrorError 读取Body错误

名称

说明

类型

code必填

样例 : "ReadBodyError"

string

message必填

样例 : "Read body error."

string

SearchUserRequest

Search user request

名称

说明

类型

email可选

邮箱 样例 : "abc@pds.com"

string

limit可选

每页大小限制 默认值 : 100最小值 : 1最大值 : 100样例 : 10

integer (int32)

marker可选

翻页标记 样例 : "marker"

string

nick_name可选

昵称 样例 : "la"

string

phone可选

电话号码 样例 : "1370000****"

string

role可选

角色 默认值 : "user"样例 : "user"

enum (superadmin, admin, user)

status可选

状态 默认值 : "enabled"样例 : "enabled"

enum (enabled, disabled)

user_name可选

用户名 样例 : "abc"

string

ServiceUnavailableError

ServiceUnavailableError 服务不可用错误

名称

说明

类型

code必填

样例 : "ServiceUnavailable"

string

message必填

样例 : "The request has failed due to a temporary failure of the server."

string

Sha1ConflictError

Sha1ConflictError Sha1冲突错误

名称

说明

类型

code必填

样例 : "Sha1Conflict"

string

message必填

样例 : "Find multiple objects of the same sha1."

string

SignatureDoesNotMatchError

SignatureDoesNotMatchError 签名不匹配错误

名称

说明

类型

code必填

样例 : "SignatureDoesNotMatch"

string

message必填

样例 : "SignatureDoesNotMatch."

string

StateConflictError

StateConflictError 状态冲突错误

名称

说明

类型

code必填

样例 : "StateConflict"

string

message必填

样例 : "User operation is not valid."

string

StoreFile

名称

说明

类型

domain_id可选

样例 : "string"

string

name可选

样例 : "string"

string

parent_file_path可选

样例 : "string"

string

store_id可选

样例 : "string"

string

type可选

样例 : "string"

string

StoreItemResponse

名称

说明

类型

accelerate_endpoint可选

全球加速域名 样例 : "https://oss-cn-shenzhen.aliyuncs.com/"

string

base_path可选

存储公共前缀 样例 : "pds-data"

string

bucket必填

bucket名称 样例 : "data-sz-bucket"

string

customized_endpoint可选

用户自定义绑定存储地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/"

string

domain_id可选

样例 : "string"

string

endpoint必填

存储访问地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/"

string

internal_endpoint可选

内网存储地址 样例 : "https://oss-cn-shenzhen.aliyuncs.com/"

string

ownership必填

存储归属,system表示系统提供,custom表示使用自己的存储 样例 : "system"

enum (system, custom)

policy必填

Policy授权,system类型store会将bucket权限授予当前云账号 样例 : "string"

string

role_arn可选

访问Bucket的角色ARN 样例 : "acs:oss:*:*:*"

string

store_id必填

store ID 样例 : "cdjaksbwuiqbxuiassd"

string

type必填

存储类型,当前只支持oss 样例 : "oss"

enum (oss)

ThrottlingError

ThrottlingError 操作被流控错误

名称

说明

类型

code必填

样例 : "Throttling"

string

message必填

样例 : "The operation is blocked due to throttling control."

string

UpdateDriveResponse

Update drive response

名称

说明

类型

creator可选

Drive 创建者 样例 : "pds"

string

description可选

Drive 备注信息 样例 : "pds team drive"

string

domain_id可选

Domain ID 样例 : "hz999"

string

drive_id可选

Drive ID 样例 : "123"

string

drive_name可选

Drive 名称 样例 : "pdsdrive"

string

drive_type可选

Drive 类型 样例 : "normal"

string

owner可选

Drive 所有者 样例 : "pds"

string

relative_path可选

Drive存储基于store的相对路径,domain的PathType为OSSPath时返回 样例 : "/a/b/e/"

string

status可选

Drive 状态 样例 : "enabled"

string

store_id可选

存储 ID, domain的PathType为OSSPath时返回 样例 : "123"

string

total_size可选

Drive 空间总量 样例 : 102400

integer (int64)

used_size可选

Drive 空间已使用量 样例 : 1024

integer (int64)

UpdateShareResponse

Update share response

名称

说明

类型

created_at可选

created_at 样例 : "2006-01-02T15:04:05.999Z"

string

creator可选

creator 样例 : "xxx"

string

description可选

description 样例 : "share description"

string

domain_id可选

domain_id 样例 : "domain-1"

string

drive_id可选

drive_id 样例 : "1"

string

expiration可选

expiration 样例 : "2006-01-02T15:04:05.999Z"

string

expired可选

expired 样例 : false

boolean

owner可选

owner 样例 : "xxx"

string

permissions可选

permissions 样例 : [ ]

< string > array

share_file_path可选

share_path 样例 : "/a/b/c/"

string

share_id可选

share_id 样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

share_name可选

share_name 样例 : "new_share"

string

status可选

status 样例 : "enabled"

string

updated_at可选

updated_at 样例 : "2006-01-02T15:04:05.999Z"

string

UpdateUserRequest

Update user request

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

description可选

描述信息 样例 : "pds team user"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "pdsuser"

string

phone可选

电话号码 样例 : "1370000****"

string

role可选

角色 默认值 : "user"样例 : "user"

enum (superadmin, admin, user)

status可选

状态 默认值 : "enabled"样例 : "enabled"

enum (enabled, disabled)

user_id必填

用户 ID 样例 : "pdsuserid"

string

UpdateUserResponse

Update user response

名称

说明

类型

avatar可选

头像 样例 : "http://a.b.c/pds.jpg"

string

created_at可选

用户创建时间 样例 : 1567407718386

integer (int64)

default_drive_id可选

默认 Drive ID 样例 : "123"

string

description可选

用户备注信息 样例 : "pds team user"

string

domain_id可选

Domain ID 样例 : "hz999"

string

email可选

邮箱 样例 : "123@pds.com"

string

nick_name可选

昵称 样例 : "abc"

string

phone可选

电话 样例 : "1370000****"

string

role可选

角色 样例 : "user"

string

status可选

用户状态 样例 : "enabled"

string

updated_at可选

用户修改时间 样例 : 1567407718386

integer (int64)

user_id可选

用户 ID 样例 : "pdsuserid"

string

user_name可选

用户名称 样例 : "name"

string

UploadPartInfo

名称

说明

类型

etag可选

etag 样例 : "0CC175B9C0F1B6A831C399E269772661"

string

part_number可选

PartNumber 最小值 : 10000最大值 : 1样例 : 1

integer (int64)

part_size可选

PartSize: 最小值 : 102400最大值 : 5368709120样例 : 1024

integer (int64)

upload_url可选

upload_url 样例 : "https://pds.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"

string

UserAuthentication

名称

说明

类型

AuthenticationType必填

认证类型 样例 : "mobile"

string

CreatedAt必填

创建时间 样例 : 1556163159820

integer (int64)

Detail必填

详情 样例 : "{name:abc}"

string

DomainID必填

Domain ID 样例 : "5000"

string

Identity必填

唯一身份标识 样例 : "15208345000"

string

LastLoginTime必填

最后登录时间 样例 : 1556163159820

integer (int64)

Status必填

状态 样例 : "normal"

string

UserID必填

用户ID 样例 : "00016a587b62b50003deea299a4f5b50"

string