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

标准模式文件操作API

概览

File API for StandardMode

版本信息

版本 : 2.0.0

URI scheme

域名 : {domainId}.api.aliyunpds.com基础路径 : /v2协议 : HTTP, HTTPS

请求Content-Type

  • application/json

响应Content-Type

  • application/json

API

获取异步任务信息

POST /v2/async_task/get

说明

如果目录拷贝、目录删除不能在限定时间内完成,将访问一个异步任务id,通过此接口获取异步任务的信息,以确定任务是否执行成功。

Body参数

请求参数

名称 : 获取异步任务请求标志 : 必填类型 : PDSGetAsyncTaskRequest

响应

HTTP代码

说明

类型

200

PDSGetAsyncTaskResponse

400

1. InvalidParameter.AsyncTaskId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1.ForbiddenNoPermission.AsyncTask

ForbiddenNoPermissionError

404

NotFound.AsyncTaskId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • async_task

HTTP请求示例

请求 path

/v2/async_task/get

请求 body

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
}

HTTP响应示例

响应 200

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "message" : "task is running",
  "state" : "success"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/batch

说明

对多个原子操作封装成一个批处理请求,服务端并行处理并打包返回每个操作的执行结果。支持对文件和文件夹的移动、删除、修改,每个批处理请求最多包含100个原则操作。

Body参数

请求参数

名称 : 批处理请求标志 : 必填类型 : PDSBatchRequest

响应

HTTP代码

说明

类型

200

PDSBatchResponse

400

1. InvalidParameter.Resource 2. InvalidParameter.Id 3. InvalidParameter.URL 4. InvalidParameter.Method

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

ForbiddenNoPermission.File

ForbiddenNoPermissionError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • batch

HTTP请求示例

请求 path

/v2/batch

请求 body

{
  "requests" : [ {
    "body" : {
      "drive_id" : "101",
      "file_id" : "xxxxxx"
    },
    "headers" : {
      "Content-Type" : "application/json"
    },
    "id" : "\"1\"",
    "method" : "\"POST\"",
    "url" : "/file/get"
  } ],
  "resource" : "\"file\""
}

HTTP响应示例

响应 200

{
  "responses" : [ {
    "body" : {
      "drive_id" : "101",
      "file_id" : "xxxxxx"
    },
    "id" : "\"1\"",
    "status" : 200
  } ]
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

创建Drive

POST /v2/drive/create

说明

支持normal和large两种drive,large类型的drive用于文件数多的场景,不支持list操作,当drive的文件数量大于1亿时,建议使用large类型。

Body参数

请求参数

名称 : 创建Drive请求标志 : 必填类型 : CreateDriveRequest

响应

HTTP代码

说明

类型

201

创建 drive 成功

CreateDriveResponse

400

1. InvalidRequestJSONFormatError 请求JSON格式错误 2. InvalidParameter.Owner 3. InvalidParameter.DriveName 4. InvalidParameter.Description 5. InvalidParameter.DriveType 6. InvalidParameter.Status 7. InvalidParameter.StoreId 8. InvalidParameter.RelativePath

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/create

请求 body

{
  "default" : true,
  "description" : "pds team drive",
  "drive_name" : "pdsdrive",
  "drive_type" : "normal",
  "encrypt_mode" : "string",
  "owner" : "pds-001",
  "relative_path" : "/d/e/f/",
  "status" : "enabled",
  "store_id" : "store_id",
  "total_size" : 1024
}

HTTP响应示例

响应 201

{
  "domain_id" : "hz999",
  "drive_id" : "123"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

删除Drive

POST /v2/drive/delete

说明

删除指定drive_id对应的Drive

Body参数

请求参数

名称 : 删除Drive请求标志 : 必填类型 : DeleteDriveRequest

响应

HTTP代码

说明

类型

204

无返回内容

无内容

400

1. InvalidParameter.DriveId 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/delete

请求 body

{
  "drive_id" : "123"
}

HTTP响应示例

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

获取Drive详细信息

POST /v2/drive/get

说明

获取指定drive_id对应的Drive详细信息。

Body参数

请求参数

名称 : 获取Drive信息请求标志 : 必填类型 : GetDriveRequest

响应

HTTP代码

说明

类型

200

获取drive信息成功

GetDriveResponse

400

1. InvalidRequestJSONFormatError 请求JSON格式错误 2. InvalidParameter.DriveId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

404

1.NotFound.Drive Drive不存在

NotFoundError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/get

请求 body

{
  "drive_id" : "123"
}

HTTP响应示例

响应 200

{
  "creator" : "pds",
  "description" : "pds team drive",
  "domain_id" : "hz999",
  "drive_id" : "123",
  "drive_name" : "pdsdrive",
  "drive_type" : "normal",
  "encrypt_data_access" : true,
  "encrypt_mode" : "string",
  "owner" : "pds",
  "relative_path" : "/a/b/e/",
  "status" : "enabled",
  "store_id" : "123",
  "total_size" : 102400,
  "used_size" : 1024
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

获取默认Drive信息

POST /v2/drive/get_default_drive

说明

一个用户可拥有多个drive,在创建drive时通过参数指定是否为这个用户的默认drive,每个用户只能设置一个默认drive。

Body参数

请求参数

名称 : 获取默认Drive信息请求标志 : 必填类型 : GetDefaultDriveRequest

响应

HTTP代码

说明

类型

200

获取默认 drive 详细信息成功

GetDriveResponse

400

1. InvalidParameter.UserId 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

404

1.NotFound.Drive Drive不存在

NotFoundError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/get_default_drive

请求 body

{
  "user_id" : "abc"
}

HTTP响应示例

响应 200

{
  "creator" : "pds",
  "description" : "pds team drive",
  "domain_id" : "hz999",
  "drive_id" : "123",
  "drive_name" : "pdsdrive",
  "drive_type" : "normal",
  "encrypt_data_access" : true,
  "encrypt_mode" : "string",
  "owner" : "pds",
  "relative_path" : "/a/b/e/",
  "status" : "enabled",
  "store_id" : "123",
  "total_size" : 102400,
  "used_size" : 1024
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

列举指定用户Drive

POST /v2/drive/list

说明

管理员列举指定用户的Drive

Body参数

请求参数

名称 : 列举指定用户Drive请求标志 : 必填类型 : ListDriveRequest

响应

HTTP代码

说明

类型

200

获取drive列表成功

ListDriveResponse

400

1. InvalidParameter.Marker 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/list

请求 body

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

HTTP响应示例

响应 200

{
  "items" : [ {
    "creator" : "pds",
    "description" : "pds team drive",
    "domain_id" : "hz999",
    "drive_id" : "123",
    "drive_name" : "pdsdrive",
    "drive_type" : "normal",
    "encrypt_data_access" : true,
    "encrypt_mode" : "string",
    "owner" : "pds",
    "relative_path" : "/a/b/e/",
    "status" : "enabled",
    "store_id" : "123",
    "total_size" : 102400,
    "used_size" : 1024
  } ],
  "next_marker" : "marker"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

列举当前用户的Drive

POST /v2/drive/list_my_drives

说明

列举当前用户(访问令牌)的Drive

Body参数

请求参数

名称 : 列举当前用户Drive请求标志 : 必填类型 : ListMyDriveRequest

响应

HTTP代码

说明

类型

200

获取drive列表成功

ListDriveResponse

400

1. InvalidParameter.Marker 2. InvalidRequestJSONFormatError 请求JSON格式错误

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/list_my_drives

请求 body

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

HTTP响应示例

响应 200

{
  "items" : [ {
    "creator" : "pds",
    "description" : "pds team drive",
    "domain_id" : "hz999",
    "drive_id" : "123",
    "drive_name" : "pdsdrive",
    "drive_type" : "normal",
    "encrypt_data_access" : true,
    "encrypt_mode" : "string",
    "owner" : "pds",
    "relative_path" : "/a/b/e/",
    "status" : "enabled",
    "store_id" : "123",
    "total_size" : 102400,
    "used_size" : 1024
  } ],
  "next_marker" : "marker"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

更新Drive信息

POST /v2/drive/update

说明

更新指定drive_id的Drive信息

Body参数

请求参数

名称 : 更新Drive信息请求标志 : 必填类型 : UpdateDriveRequest

响应

HTTP代码

说明

类型

200

更新drive成功

UpdateDriveResponse

400

1. InvalidRequestJSONFormatError 请求JSON格式错误 2. InvalidParameter.DriveId 3. InvalidParameter.TotalSize 4. InvalidParameter.DriveName 5. InvalidParameter.Description 6. InvalidParameter.Status

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 账号没找到 2. ForbiddenNoPermissionError.Drive 无法访问Drive资源

ForbiddenNoPermissionError

404

1.NotFound.Drive Drive不存在

NotFoundError

500

服务内部故障

InternalErrorError

503

服务临时不可用

ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path

/v2/drive/update

请求 body

{
  "description" : "pds team drive",
  "drive_id" : "123",
  "drive_name" : "pdsdrive",
  "encrypt_data_access" : true,
  "encrypt_mode" : "server",
  "status" : "enabled",
  "total_size" : 1024
}

HTTP响应示例

响应 200

{
  "creator" : "pds",
  "description" : "pds team drive",
  "domain_id" : "hz999",
  "drive_id" : "123",
  "drive_name" : "pdsdrive",
  "drive_type" : "normal",
  "encrypt_data_access" : true,
  "encrypt_mode" : "string",
  "owner" : "pds",
  "relative_path" : "/a/b/e/",
  "status" : "enabled",
  "store_id" : "123",
  "total_size" : 102400,
  "used_size" : 1024
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/complete

说明

完成文件上传。

Body参数

请求参数

名称 : 完成文件上传请求标志 : 必填类型 : PDSCompleteFileRequest

响应

HTTP代码

说明

类型

200

PDSCompleteFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.UploadId 5. InvalidParameter.ContentHash 6. QuotaExhausted.Drive

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.UploadId 3. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/complete

请求 body

{
  "drive_id" : "1",
  "part_info_list" : [ {
    "etag" : "0CC175B9C0F1B6A831C399E269772661",
    "part_number" : 1,
    "part_size" : 1024,
    "upload_url" : "https://pds.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
  } ],
  "upload_id" : "string",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

HTTP响应示例

响应 200

{
  "category" : "doc",
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "encrypt_mode" : "pin",
  "file_extension" : "jpg",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "hidden" : false,
  "image_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "exif" : "string",
    "faces" : "string",
    "height" : 720,
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇",
    "width" : 1024
  },
  "labels" : [ "label1:1", "label2:2" ],
  "meta" : "string",
  "name" : "pds.jpg",
  "parent_file_id" : "root",
  "size" : 1024,
  "starred" : false,
  "status" : "available",
  "streams_url_info" : {
    "string" : "[urlinfo](#urlinfo)"
  },
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "user_meta" : "user_meta",
  "video_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "duration" : "\"7704.573000\"",
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇"
  }
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/copy

说明

指定源文件或文件夹,拷贝到指定的文件夹。

Body参数

请求参数

名称 : 拷贝文件或文件夹请求标志 : 必填类型 : PDSCopyFileRequest

响应

HTTP代码

说明

类型

201

文件拷贝成功.

PDSCopyFileResponse

202

启动文件夹拷贝任务.

PDSCopyFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.ToParentFileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.ToParentFileId 3. NotFound.FileId 4. NotFound.ToDriveId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/copy

请求 body

{
  "auto_rename" : false,
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "new_name" : "pds.jpg",
  "to_drive_id" : "1",
  "to_parent_file_id" : "root"
}

HTTP响应示例

响应 201

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

响应 202

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/create

说明

在指定文件夹下创建文件或者文件夹,根文件夹用root表示,其他文件夹使用创建文件夹时返回的file_id。

Body参数

请求参数

名称 : 创建文件请求标志 : 必填类型 : PDSCreateFileRequest

响应

HTTP代码

说明

类型

201

创建成功

PDSCreateFileResponse

400

1. InvalidParameter.DriveId 2. InvalidParameter.ParentFileId 3. InvalidParameter.ContentHashName 4. InvalidParameter.Labels 5. InvalidParameter.Name 6. InvalidParameter.Size 7. InvalidParameter.Type 8. InvalidParameter.FileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.Drive 2. NotFound.FileId 3. NotFound.File

NotFoundError

409

1.同名文件夹或者同名文件已经存在。 2.ContentHashMultiMatched。

AlreadyExistError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/create

请求 body

{
  "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  "content_type" : "application/json",
  "name" : "pds.jpg",
  "part_info_list" : [ {
    "etag" : "0CC175B9C0F1B6A831C399E269772661",
    "part_number" : 1,
    "part_size" : 1024,
    "upload_url" : "https://pds.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
  } ],
  "size" : 0,
  "type" : "file",
  "auto_rename" : true,
  "check_name_mode" : "string",
  "content_hash" : "7C4A8D09CA3762AF61E59520943DC26494F8941B",
  "content_hash_name" : "sha1",
  "description" : "file description",
  "drive_id" : "1",
  "encrypt_mode" : "string",
  "file_id" : "string",
  "hidden" : false,
  "labels" : [ "label1", "label2" ],
  "last_updated_at" : "2019-08-20T06:51:27.292Z",
  "meta" : "string",
  "parent_file_id" : "root",
  "pre_hash" : "E10ADC3949BA59ABBE56E057F20F883E",
  "streams_info" : {
    "string" : "[streaminfo](#streaminfo)"
  },
  "user_meta" : "user_meta"
}

HTTP响应示例

响应 201

{
  "domain_id" : "domain",
  "drive_id" : "1",
  "encrypt_mode" : "pin",
  "file_id" : "5d79206586bb5dd69fb34c349282718146c55da7",
  "file_name" : "test.txt",
  "parent_file_id" : "root",
  "part_info_list" : "[",
  "rapid_upload" : false,
  "streams_upload_info" : {
    "string" : "[streamuploadinfo](#streamuploadinfo)"
  },
  "type" : "file",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 403

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

响应 404

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

响应 409

{
  "code" : "AlreadyExist",
  "message" : "{resource} has already exists. {extra_msg}"
}

响应 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/file/delete

说明

指定文件或文件夹ID,删除文件或者文件夹。

Body参数

请求参数

名称 : 删除文件或文件夹请求标志 : 必填类型 : PDSDeleteFileRequest

响应

HTTP代码

说明

类型

202

启动文件夹删除任务

PDSDeleteFileResponse

204

删除文件成功, 无响应body

无内容

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 3. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/delete

请求 body

{
  "drive_id" : "1",
  "file_id" : "5d792010669a1dd91087479e8071c9ae212065cc",
  "permanently" : false
}

HTTP响应示例

响应 202

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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."
}

下载文件

GET /v2/file/download

说明

指定文件ID,下载文件。

参数

类型

名称

说明

类型

Query

drive_id必填

drive id

string

Query

file_id必填

file id

string

Query

image_thumbnail_process可选

image_thumbnail_process

string

Query

video_thumbnail_process可选

video_thumbnail_processtype:string

string

响应

HTTP代码

说明

类型

301

重定向至下载 Url

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/download?drive_id=string&file_id=string

HTTP响应示例

响应 301

重定向至下载 Url

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/get

说明

获取指定文件或文件夹ID的信息。

Body参数

请求参数

名称 : 获取文件或文件夹信息请求标志 : 必填类型 : PDSGetFileRequest

响应

HTTP代码

说明

类型

200

PDSGetFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.UrlExpireSec

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 3. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/get

请求 body

{
  "drive_id" : "1",
  "fields" : "*",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/crop,w_100,h_100/rounded-corners,r_10/format,png",
  "url_expire_sec" : 900,
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "category" : "doc",
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "encrypt_mode" : "pin",
  "file_extension" : "jpg",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "hidden" : false,
  "image_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "exif" : "string",
    "faces" : "string",
    "height" : 720,
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇",
    "width" : 1024
  },
  "labels" : [ "label1:1", "label2:2" ],
  "meta" : "string",
  "name" : "pds.jpg",
  "parent_file_id" : "root",
  "size" : 1024,
  "starred" : false,
  "status" : "available",
  "streams_url_info" : {
    "string" : "[urlinfo](#urlinfo)"
  },
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "user_meta" : "user_meta",
  "video_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "duration" : "\"7704.573000\"",
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇"
  }
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/get_by_path

说明

根据路径获取指定文件或文件夹的信息。

Body参数

请求参数

名称 : 根据路径获取文件或文件夹信息请求标志 : 必填类型 : PDSGetFileByPathRequest

响应

HTTP代码

说明

类型

200

PDSGetFileByPathResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FilePath 4. InvalidParameter.UrlExpireSec

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 3. NotFound.FilePath

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/get_by_path

请求 body

{
  "drive_id" : "1",
  "fields" : "*",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "file_path" : "/a/b/c",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/crop,w_100,h_100/rounded-corners,r_10/format,png",
  "url_expire_sec" : 900,
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "category" : "doc",
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "encrypt_mode" : "pin",
  "file_extension" : "jpg",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "hidden" : false,
  "image_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "exif" : "string",
    "faces" : "string",
    "height" : 720,
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇",
    "width" : 1024
  },
  "labels" : [ "label1:1", "label2:2" ],
  "meta" : "string",
  "name" : "pds.jpg",
  "parent_file_id" : "root",
  "size" : 1024,
  "starred" : false,
  "status" : "available",
  "streams_url_info" : {
    "string" : "[urlinfo](#urlinfo)"
  },
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "user_meta" : "user_meta",
  "video_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "duration" : "\"7704.573000\"",
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇"
  }
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/get_download_url

说明

获取文件的下载地址,调用者可自己设置range头并发下载。

Body参数

请求参数

名称 : 获取文件下载地址请求标志 : 必填类型 : PDSGetDownloadUrlRequest

响应

HTTP代码

说明

类型

200

PDSGetDownloadUrlResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.ExpireSec 4. InvalidParameter.FileName

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/get_download_url

请求 body

{
  "drive_id" : "1",
  "expire_sec" : 15,
  "file_id" : "string",
  "file_name" : "pds.jpg"
}

HTTP响应示例

响应 200

{
  "expiration" : "2006-01-02T15:04:05.999Z07:00",
  "method" : "GET",
  "size" : 102400,
  "streams_url" : {
    "string" : "string"
  },
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/get_last_cursor

说明

获取drive内,增量数据最新的游标

Body参数

请求参数

名称 : 获取增量数据最新的游标请求标志 : 必填类型 : GetLastCursorRequest

响应

HTTP代码

说明

类型

200

Success

GetLastCursorResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file_delta

HTTP请求示例

请求 path

/v2/file/get_last_cursor

请求 body

{
  "drive_id" : "1"
}

HTTP响应示例

响应 200

"[getlastcursorresponse](#getlastcursorresponse)"

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/get_upload_url

说明

可指定分片信息,一次获取多个分片的上传地址。

Body参数

请求参数

名称 : 获取文件分片上传地址请求标志 : 必填类型 : PDSGetUploadUrlRequest

响应

HTTP代码

说明

类型

200

PDSGetUploadUrlResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.UploadId 5. InvalidParameter.PartInfoList

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.UploadId 3. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/get_upload_url

请求 body

{
  "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  "drive_id" : "1",
  "part_info_list" : [ ],
  "upload_id" : "3920F2BE4D9446D6967E2ED505A97EFD",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

HTTP响应示例

响应 200

{
  "create_at" : "2019-09-11T16:34:36.977Z",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "part_info_list" : [ ],
  "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/list

说明

列举指定目录下的文件或文件夹。

Body参数

请求参数

名称 : 列举文件或文件夹请求标志 : 必填类型 : PDSListFileRequest

响应

HTTP代码

说明

类型

200

列举文件成功

PDSListFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.ParentFileId 3. InvalidParameter.DriveId 4. InvalidParameter.Status 5. InvalidParameter.OrderBy 6. InvalidParameter.OrderDirection 7. InvalidParameter.Limit 8. InvalidParameter.Marker 9. InvalidParameter.UrlExpireSec

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

Drive或者Share不存在. 如果Domain path 是 oss path, 而且Domain绑定的bucket不存在,也会返回404。

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/list

请求 body

{
  "drive_id" : "1",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/resize,w_200",
  "limit" : 10,
  "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast",
  "Starred" : false,
  "all" : false,
  "category" : "image",
  "fields" : "*",
  "order_by" : "name",
  "order_direction" : "ASC",
  "parent_file_id" : "root",
  "status" : "available",
  "type" : "file",
  "url_expire_sec" : 900
}

HTTP响应示例

响应 200

{
  "items" : [ ],
  "next_marker" : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/list_by_custom_index_key

说明

根据自定义同步索引键列举文件或文件夹。

Body参数

请求参数

名称 : 列举文件或文件夹请求标志 : 必填类型 : PDSListFileByCustomIndexKeyRequest

响应

HTTP代码

说明

类型

200

列举文件成功

PDSListFileResponse

400

无效请求参数.

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. 无权限列举文件或文件夹. 2. share 过期

ForbiddenNoPermissionError

404

Drive或者Share不存在. 如果Domain path 是 oss path, 而且Domain绑定的bucket不存在,也会返回404。

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/list_by_custom_index_key

请求 body

{
  "drive_id" : "1",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/resize,w_200",
  "limit" : 10,
  "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast",
  "Starred" : false,
  "category" : "image",
  "custom_index_key" : "string",
  "encrypt_mode" : "string",
  "fields" : "*",
  "order_direction" : "ASC",
  "status" : "available",
  "type" : "file",
  "url_expire_sec" : 900
}

HTTP响应示例

响应 200

{
  "items" : [ ],
  "next_marker" : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/list_delta

说明

获取drive内,增量数据列表

Body参数

请求参数

名称 : 获取增量数据列表请求标志 : 必填类型 : ListFileDeltaRequest

响应

HTTP代码

说明

类型

200

Success

ListFileDeltaResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file_delta

HTTP请求示例

请求 path

/v2/file/list_delta

请求 body

{
  "cursor" : "abc",
  "drive_id" : "1",
  "limit" : 100
}

HTTP响应示例

响应 200

"[listfiledeltaresponse](#listfiledeltaresponse)"

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/list_uploaded_parts

说明

列举upload_id对应的已上传分片。

Body参数

请求参数

名称 : 列举已上传分片标志 : 必填类型 : PDSListUploadedPartRequest

响应

HTTP代码

说明

类型

200

列举uploadID对应的已上传分片成功

PDSListUploadedPartResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.UploadId 5. InvalidParameter.Limit

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId 3. NotFound.UploadId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/list_uploaded_parts

请求 body

{
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "limit" : 1,
  "part_number_marker" : 1,
  "upload_id" : "00668396C0814D818D90F0A92B04B355"
}

HTTP响应示例

响应 200

{
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "next_part_number_marker" : "4",
  "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4",
  "uploaded_parts" : [ ]
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/move

说明

指定源文件或文件夹,移动到指定的文件夹。

Body参数

请求参数

名称 : 移动文件或文件夹请求标志 : 必填类型 : PDSMoveFileRequest

响应

HTTP代码

说明

类型

200

PDSMoveFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.ToParentFileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.ToParentFileId 3. NotFound.FileId 4. NotFound.ToDriveId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/move

请求 body

{
  "drive_id" : "1",
  "new_name" : "pds.jpg",
  "overwrite" : false,
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "to_parent_file_id" : "root"
}

HTTP响应示例

响应 200

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/scan

说明

在指定drive下全量获取文件元信息。

Body参数

请求参数

名称 : 文件搜索请求标志 : 必填类型 : PDSScanFileMetaRequest

响应

HTTP代码

说明

类型

200

Success

PDSScanFileMetaResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.Category

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/scan

请求 body

{
  "category" : "image",
  "drive_id" : "1",
  "limit" : 1000,
  "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

HTTP响应示例

响应 200

{
  "items" : [ ],
  "next_marker" : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/search

说明

根据筛选条件,在指定drive下搜索文件。

Body参数

请求参数

名称 : 文件搜索请求标志 : 必填类型 : PDSSearchFileRequest

响应

HTTP代码

说明

类型

200

Success

PDSSearchFileResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter. Query 4. InvalidParameter.OrderBy 5. InvalidParameter.Limit 6. InvalidParameter.UrlExpireSec

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId

NotFoundError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/search

请求 body

{
  "drive_id" : "1",
  "image_thumbnail_process" : "image/resize,m_fill,h_128,w_128,limit_0",
  "image_url_process" : "image/resize,m_fill,h_128,w_128,limit_0",
  "limit" : 10,
  "marker" : "\"\"",
  "order_by" : "size",
  "query" : "not name=123",
  "url_expire_sec" : 900,
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "items" : [ ],
  "next_marker" : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 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/file/update

说明

对指定的文件或文件夹更新信息。

Body参数

请求参数

名称 : 更新文件或文件夹信息请求标志 : 必填类型 : PDSUpdateFileMetaRequest

响应

HTTP代码

说明

类型

200

PDSUpdateFileMetaResponse

400

1. InvalidRequestJSONFormat 2. InvalidParameter.DriveId 3. InvalidParameter.FileId 4. InvalidParameter.ToParentFileId

InvalidParameterError

401

AccessTokenInvalid

AccessTokenInvalidError

403

1. ForbiddenAccountNotFoundError 2. ForbiddenNoPermissionError.File

ForbiddenNoPermissionError

404

1. NotFound.DriveId 2. NotFound.FileId

NotFoundError

409

1. AlreadyExistError.File 文件已存在

AlreadyExistError

500

InternalError

InternalErrorError

503

ServiceUnavailable

ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path

/v2/file/update

请求 body

{
  "custom_index_key" : "string",
  "description" : "description",
  "drive_id" : "1",
  "encrypt_mode" : "string",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "hidden" : false,
  "labels" : [ "label1", "label2" ],
  "meta" : "string",
  "name" : "pds.jpg",
  "starred" : false,
  "user_meta" : "user_meta"
}

HTTP响应示例

响应 200

{
  "category" : "doc",
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "encrypt_mode" : "pin",
  "file_extension" : "jpg",
  "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "hidden" : false,
  "image_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "exif" : "string",
    "faces" : "string",
    "height" : 720,
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇",
    "width" : 1024
  },
  "labels" : [ "label1:1", "label2:2" ],
  "meta" : "string",
  "name" : "pds.jpg",
  "parent_file_id" : "root",
  "size" : 1024,
  "starred" : false,
  "status" : "available",
  "streams_url_info" : {
    "string" : "[urlinfo](#urlinfo)"
  },
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "user_meta" : "user_meta",
  "video_media_metadata" : {
    "address_line" : "北京市昌平区白各庄新村路",
    "city" : "杭州",
    "country" : "中国",
    "district" : "余杭区",
    "duration" : "\"7704.573000\"",
    "location" : "40.110333,116.349311",
    "province" : "浙江省",
    "time" : "string",
    "township" : "沙河镇"
  }
}

响应 400

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

响应 401

{
  "code" : "AccessTokenInvalid",
  "message" : "AccessToken is invalid. {message}"
}

响应 403

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

响应 404

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

响应 409

{
  "code" : "AlreadyExist",
  "message" : "{resource} has already exists. {extra_msg}"
}

响应 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

AccessTokenInvalidError

AccessTokenInvalidError AccessToken无效

名称

说明

类型

code必填

样例 : "AccessTokenInvalid"

string

message必填

样例 : "AccessToken is invalid. {message}"

string

AlreadyExistError

AlreadyExistError 已经存在错误

名称

说明

类型

code必填

样例 : "AlreadyExist"

string

message必填

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

string

AuthorizationPendingError

AuthorizationPendingError 等待用户登录

名称

说明

类型

code必填

样例 : "AuthorizationPending"

string

message必填

样例 : "OAuth 2.0 device flow error. Authorization is pending."

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

encrypt_mode可选

encrypt_mode 样例 : "pin"

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可选

样例 : "string"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1000}"样例 : "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)

streams_url_info可选

streams url info 样例 : {<br> "string" : "[urlinfo](#urlinfo)"<br>}

< string, UrlInfo > map

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

user_meta可选

user_meta 样例 : "user_meta"

string

video_media_metadata可选

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

VideoMediaResponse

BaseCompleteFileRequest

complete file request

名称

说明

类型

drive_id可选

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

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

upload_id可选

upload_id 样例 : "string"

string

BaseCreateFileRequest

create file request

名称

说明

类型

content_md5必填

ContentMd5 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

content_type必填

ContentType 样例 : "application/json"

string

name必填

Name 样例 : "pds.jpg"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

size必填

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

integer (int64)

type必填

Type 样例 : "file"

enum (file, folder)

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

encrypt_data_access可选

样例 : true

boolean

encrypt_mode可选

样例 : "string"

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)

BaseGetUploadUrlRequest

获取文件上传URL

名称

说明

类型

content_md5可选

content_md5 最大长度 : 32样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

drive_id可选

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

string

part_info_list可选

upload_part_list 样例 : [ ]

< UploadPartInfo > array

upload_id必填

upload_id 样例 : "3920F2BE4D9446D6967E2ED505A97EFD"

string

BaseListFileRequest

list file request

名称

说明

类型

drive_id可选

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

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "image/resize,w_200"

string

image_url_process可选

image_url_process 样例 : "image/resize,w_200"

string

limit可选

limit 默认值 : 50最小值 : 0最大值 : 100样例 : 10

integer (int64)

marker可选

marker 样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"

string

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

BaseMoveFileRequest

文件移动请求

名称

说明

类型

drive_id必填

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

string

new_name可选

new_name 样例 : "pds.jpg"

string

overwrite可选

overwritetype: boolean 默认值 : false样例 : false

boolean

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,1000}"样例 : "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

share_policy可选

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

< SharePermissionPolicy > array

status可选

status 样例 : "enabled"

string

updated_at可选

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

string

BatchSubRequest

名称

说明

类型

body可选

body 子请求的请求参数 json 字符串,可参考对于子请求文档, 当指定了body 必须传headers : “Content-Type” 对应的类型,目前子请求入参是”application/json” 样例 : {<br> "drive_id" : "101",<br> "file_id" : "xxxxxx"<br>}

< string, object > map

headers可选

headers 请求头,表示body传入数据的类型 样例 : {<br> "Content-Type" : "application/json"<br>}

< string, string > map

id必填

id 用于request 和 response关联, 不允许重复 样例 : "\"1\""

string

method必填

method 样例 : "\"POST\""

enum (POST, GET, PUT, DELETE, HEAD)

url必填

url 子请求的api path路径, 可参考对于子请求文档 样例 : "/file/get"

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)

PDSBatchRequest

批处理

名称

说明

类型

requests必填

Requests 请求合集 样例 : [ "[batchsubrequest](#batchsubrequest)" ]

< BatchSubRequest > array

resource必填

支持的资源类型 样例 : "\"file\""

string

PDSBatchResponse

batch operation response

名称

说明

类型

responses可选

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

< BatchSubResponse > array

PDSCompleteFileRequest

合并文件上传任务

多态性 : 成分

名称

说明

类型

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](#uploadpartinfo)" ]

< UploadPartInfo > array

upload_id可选

upload_id 样例 : "string"

string

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

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

encrypt_mode可选

encrypt_mode 样例 : "pin"

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可选

样例 : "string"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1000}"样例 : "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)

streams_url_info可选

streams url info 样例 : {<br> "string" : "[urlinfo](#urlinfo)"<br>}

< string, UrlInfo > map

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

user_meta可选

user_meta 样例 : "user_meta"

string

video_media_metadata可选

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

VideoMediaResponse

PDSCopyFileRequest

文件拷贝

名称

说明

类型

auto_rename可选

auto_renametype: boolean 默认值 : false样例 : false

boolean

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

new_name可选

new_name 样例 : "pds.jpg"

string

to_drive_id可选

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

string

to_parent_file_id必填

toparent_file_id 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“root”`

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

PDSCreateFileRequest

创建文件

多态性 : 成分

名称

说明

类型

check_name_mode可选

check_name_mode 默认值 : "ignore"样例 : "string"

enum (ignore, auto_rename, refuse)

content_hash可选

content_hash 样例 : "7C4A8D09CA3762AF61E59520943DC26494F8941B"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_md5必填

ContentMd5 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

content_type必填

ContentType 样例 : "application/json"

string

description可选

description 长度 : 1024 - 0样例 : "file description"

string

drive_id必填

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

string

encrypt_mode可选

encrypt_mode 样例 : "string"

string

file_id可选

file_id 样例 : "string"

string

hidden可选

hidden 样例 : false

boolean

labels可选

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

< string > array

last_updated_at可选

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

string

meta可选

样例 : "string"

string

name必填

Name 样例 : "pds.jpg"

string

parent_file_id必填

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

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

pre_hash可选

pre_hash 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

size必填

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

integer (int64)

streams_info可选

streams_info 样例 : {<br> "string" : "[streaminfo](#streaminfo)"<br>}

< string, StreamInfo > map

type必填

Type 样例 : "file"

enum (file, folder)

user_meta可选

user_meta 样例 : "user_meta"

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

encrypt_mode可选

encrypt_mode 样例 : "pin"

string

file_id可选

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

string

file_name可选

file_name 长度 : 1 - 255样例 : "test.txt"

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

exist可选

existtype: boolean 样例 : false

boolean

status可选

statustype: string 样例 : available

enum (uploading, available)

streams_upload_info可选

streams_upload_info 样例 : {<br> "string" : "[streamuploadinfo](#streamuploadinfo)"<br>}

< string, StreamUploadInfo > map

type可选

type 样例 : "file"

enum (file, folder)

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

PDSDeleteFileRequest

删除文件请求

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d792010669a1dd91087479e8071c9ae212065cc”`

string

permanently可选

permanentlytype: false 默认值 : false样例 : false

boolean

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

PDSDeleteFilesRequest

批量删除文件请求

名称

说明

类型

drive_id必填

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

string

file_id_list必填

file_id_list 样例 : [ ]

< string > array

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

PDSGetAsyncTaskRequest

获取异步人去信息

名称

说明

类型

async_task_id可选

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

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)

PDSGetDownloadUrlRequest

获取文件下载地址的请求body

名称

说明

类型

drive_id必填

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

string

expire_sec可选

expire_sec 默认值 : 900最小值 : 0最大值 : 14400样例 : 15

integer (int64)

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

file_name可选

file_name 长度 : 1 - 1024样例 : "pds.jpg"

string

PDSGetDownloadUrlResponse

获取download url response

名称

说明

类型

expiration可选

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

string

method可选

method 样例 : "GET"

string

size可选

size 样例 : 102400

integer (int64)

streams_url可选

streams url info 样例 : {<br> "string" : "string"<br>}

< string, string > map

url可选

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

string

PDSGetFileByPathRequest

根据路径获取 File 接口 body

名称

说明

类型

drive_id必填

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

string

fields可选

fields 默认值 : "*"样例 : "*"

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

file_path可选

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

string

image_thumbnail_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

image_url_process可选

image_thumbnail_processtype:string 样例 : "image/crop,w_100,h_100/rounded-corners,r_10/format,png"

string

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

PDSGetFileByPathResponse

根据路径获取文件元数据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

encrypt_mode可选

encrypt_mode 样例 : "pin"

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可选

样例 : "string"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1000}"样例 : "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)

streams_url_info可选

streams url info 样例 : {<br> "string" : "[urlinfo](#urlinfo)"<br>}

< string, UrlInfo > map

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

user_meta可选

user_meta 样例 : "user_meta"

string

video_media_metadata可选

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

VideoMediaResponse

PDSGetFileRequest

获取文件元数据

名称

说明

类型

drive_id必填

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

string

fields可选

fields 默认值 : "*"样例 : "*"

enum(*, thumbnail)

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

image_thumbnail_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

image_url_process可选

image_thumbnail_processtype:string 样例 : "image/crop,w_100,h_100/rounded-corners,r_10/format,png"

string

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

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

encrypt_mode可选

encrypt_mode 样例 : "pin"

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可选

样例 : "string"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1000}"样例 : "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)

streams_url_info可选

streams url info 样例 : {<br> "string" : "[urlinfo](#urlinfo)"<br>}

< string, UrlInfo > map

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

user_meta可选

user_meta 样例 : "user_meta"

string

video_media_metadata可选

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

VideoMediaResponse

PDSGetUploadUrlRequest

获取文件上传URL

多态性 : 成分

名称

说明

类型

content_md5可选

content_md5 最大长度 : 32样例 : "E10ADC3949BA59ABBE56E057F20F883E"

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可选

upload_part_list 样例 : [ ]

< UploadPartInfo > array

upload_id必填

upload_id 样例 : "3920F2BE4D9446D6967E2ED505A97EFD"

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

PDSListFileByCustomIndexKeyRequest

列举文件

多态性 : 成分

名称

说明

类型

Starred可选

starred 样例 : false

boolean

category可选

category 样例 : "image"

enum (image, video, music, doc, other)

custom_index_key必填

custom_index_key 样例 : "string"

string

drive_id可选

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

string

encrypt_mode可选

encrypt_mode 样例 : "string"

string

fields可选

fields 样例 : "*"

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "image/resize,w_200"

string

image_url_process可选

image_url_process 样例 : "image/resize,w_200"

string

limit可选

limit 默认值 : 50最小值 : 0最大值 : 100样例 : 10

integer (int64)

marker可选

marker 样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"

string

order_direction可选

order_direction 样例 : "ASC"

enum (ASC, DESC)

status可选

status 默认值 : "available"样例 : "available"

enum (uploading, available)

type可选

type 样例 : "file"

enum (file, folder)

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

PDSListFileRequest

列举文件

多态性 : 成分

名称

说明

类型

Starred可选

starred 样例 : false

boolean

all可选

all 默认值 : true样例 : false

boolean

category可选

category 样例 : "image"

enum (image, video, music, doc, other)

drive_id可选

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

string

fields可选

fields 样例 : "*"

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "image/resize,w_200"

string

image_url_process可选

image_url_process 样例 : "image/resize,w_200"

string

limit可选

limit 默认值 : 50最小值 : 0最大值 : 100样例 : 10

integer (int64)

marker可选

marker 样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"

string

order_by可选

order_by 样例 : "name"

enum (update_time, name)

order_direction可选

order_direction 样例 : "ASC"

enum (ASC, DESC)

parent_file_id必填

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

string

status可选

status 默认值 : "available"样例 : "available"

enum (uploading, available)

type可选

type 样例 : "file"

enum (file, folder)

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

PDSListFileResponse

List file response

名称

说明

类型

items可选

items 样例 : [ ]

< BasePDSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

PDSListUploadedPartRequest

列举uploadID对应的已上传分片

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

limit必填

limit 默认值 : 1000最小值 : 1最大值 : 1000样例 : 1

integer (int64)

part_number_marker可选

part_number_marker 最小值 : 1样例 : 1

integer (int64)

upload_id可选

upload_id 样例 : "00668396C0814D818D90F0A92B04B355"

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

PDSMoveFileRequest

文件移动请求

多态性 : 成分

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

new_name可选

new_name 样例 : "pds.jpg"

string

overwrite可选

overwritetype: boolean 默认值 : false样例 : false

boolean

to_parent_file_id必填

to_parent_file_id 长度 : 40 - 50样例 : "root"

string

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

PDSScanFileMetaRequest

全量获取file元信息的请求body

名称

说明

类型

category可选

category 样例 : "image"

string

drive_id必填

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

string

limit可选

limit 最小值 : 1最大值 : 5000样例 : 1000

integer (int32)

marker可选

marker 样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"

string

PDSScanFileMetaResponse

scan file meta response

名称

说明

类型

items可选

items 样例 : [ ]

< BasePDSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

PDSSearchFileRequest

搜索文件元数据

名称

说明

类型

drive_id必填

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

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "image/resize,m_fill,h_128,w_128,limit_0"

string

image_url_process可选

image_url_process 样例 : "image/resize,m_fill,h_128,w_128,limit_0"

string

limit可选

limit 默认值 : 50最小值 : 1最大值 : 100样例 : 10

integer (int32)

marker可选

Marker 样例 : "\"\""

string

order_by可选

order_by 默认值 : "updated_at"样例 : "size"

enum (name, created_at, updated_at, size)

query可选

query 最大长度 : 4096样例 : "not name=123"

string

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

PDSSearchFileResponse

search file response

名称

说明

类型

items可选

items 样例 : [ ]

< BasePDSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

PDSUpdateFileMetaRequest

更新文件元数据

名称

说明

类型

custom_index_key可选

样例 : "string"

string

description可选

descriptiontype: string 最大长度 : 1024样例 : "description"

string

drive_id必填

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

string

encrypt_mode可选

样例 : "string"

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`

string

hidden可选

hiddentype: boolean 默认值 : false样例 : false

boolean

labels可选

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

< string > array

meta可选

样例 : "string"

string

name可选

name 长度 : 1 - 1024样例 : "pds.jpg"

string

starred可选

starredtype: boolean 默认值 : false样例 : false

boolean

user_meta可选

user_meta 样例 : "user_meta"

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

encrypt_mode可选

encrypt_mode 样例 : "pin"

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可选

样例 : "string"

string

name必填

name 模式 : "[a-zA-Z0-9.-]{1,1000}"样例 : "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)

streams_url_info可选

streams url info 样例 : {<br> "string" : "[urlinfo](#urlinfo)"<br>}

< string, UrlInfo > map

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

user_meta可选

user_meta 样例 : "user_meta"

string

video_media_metadata可选

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

VideoMediaResponse

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

CompleteFileRequest

complete file request

名称

说明

类型

drive_id必填

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

string

file_id必填

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

string

file_path可选

样例 : "string"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

share_id可选

样例 : "string"

string

upload_id必填

upload_id 样例 : "string"

string

CopyFileRequest

文件移动请求

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

file_path可选

样例 : "string"

string

new_name必填

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

string

overwrite可选

overwritetype: boolean 默认值 : false样例 : true

boolean

share_id可选

样例 : "string"

string

to_parent_file_id必填

toparent_file_id 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

to_parent_file_path可选

样例 : "string"

string

CorsRule

名称

说明

类型

allowed_header可选

AllowedHeader 样例 : [ "h*" ]

< string > array

allowed_method可选

AllowedMethod 样例 : [ "PUT", "GET" ]

< string > array

allowed_origin可选

AllowedOrigin 样例 : [ "*" ]

< string > array

expose_header可选

ExposeHeader 样例 : [ "ETag" ]

< string > array

max_age_seconds可选

MaxAgeSeconds 样例 : 0

integer (int64)

CreateDriveRequest

create drive request

名称

说明

类型

default可选

是否默认drive, 只允许设置一个默认drive 默认值 : false样例 : true

boolean

description可选

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

string

drive_name必填

Drive 名称 样例 : "pdsdrive"

string

drive_type可选

Drive类型 默认值 : "normal"样例 : "normal"

enum (normal, large)

encrypt_mode可选

样例 : "string"

string

owner必填

所属者 样例 : "pds-001"

string

relative_path可选

domain的PathType为OSSPath时必选。 Drive存储基于store的相对路径 样例 : "/d/e/f/"

string

status可选

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

enum (disabled, enabled)

store_id可选

StoreID , domain的PathType为OSSPath时必选 样例 : "store_id"

string

total_size可选

总大小,单位Byte [如果设置 -1 代表不限制] 默认值 : -1样例 : 1024

integer (int64)

CreateDriveResponse

Create drive response

名称

说明

类型

domain_id可选

Domain ID 样例 : "hz999"

string

drive_id可选

Drive ID 样例 : "123"

string

CreateFileRequest

create file request

名称

说明

类型

content_hash可选

ContentHash 样例 : "string"

string

content_hash_name可选

ContentHashName 样例 : "sha1"

enum (sha1)

content_md5可选

ContentMd5 最大长度 : 32样例 : "string"

string

content_type必填

ContentType 样例 : "string"

string

description可选

Description 长度 : 1024 - 0样例 : "string"

string

drive_id必填

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

string

hidden可选

Hidden 样例 : true

boolean

meta可选

Meta 样例 : "string"

string

name必填

name 样例 : "pds.jpg"

string

parent_file_id必填

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

string

parent_file_path可选

ParentFilePath 样例 : "string"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

pre_hash可选

pre_hash 样例 : "string"

string

share_id可选

ShareID 样例 : "string"

string

size必填

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

integer (int64)

tags可选

tags 样例 : {<br> "string" : "object"<br>}

< string, object > map

type必填

Type 样例 : "string"

enum (file, folder)

CreateShareRequest

create share request

名称

说明

类型

description可选

description 样例 : "share description"

string

drive_id必填

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

string

expiration可选

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

string

owner必填

creator 样例 : "abc"

string

permissions可选

permissions 样例 : [ ]

< string > array

share_file_path必填

share_file_path 样例 : "string"

string

share_name可选

share_name 样例 : "share"

string

share_policy可选

share create policyshare_policy 样例 : [ "[sharepermissionpolicy](#sharepermissionpolicy)" ]

< SharePermissionPolicy > array

status可选

status 样例 : "enabled"

enum (enabled, disabled)

CreateShareResponse

Create share response

名称

说明

类型

domain_id可选

domain_id 样例 : "domain-1"

string

share_id可选

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

string

DeleteDriveRequest

Delete drive request

名称

说明

类型

drive_id必填

Drive ID 样例 : "123"

string

DeleteDriveResponse

delete drive response

类型 : object

DeleteFileRequest

删除文件请求

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

file_path可选

样例 : "string"

string

permanently可选

样例 : true

boolean

share_id可选

样例 : "string"

string

DeleteShareRequest

delete share request

名称

说明

类型

share_id必填

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

string

DownloadRequest

下载文件请求body

名称

说明

类型

DriveID必填

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

string

FileID必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

ImageProcess可选

image_process 样例 : "image/resize,w_200"

string

ShareID可选

样例 : "string"

string

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

GetAsyncTaskRequest

获取异步人去信息

名称

说明

类型

async_task_id可选

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

string

GetDefaultDriveRequest

Get default drive request

名称

说明

类型

user_id可选

用户ID 样例 : "abc"

string

GetDownloadUrlRequest

获取文件下载地址的请求body

名称

说明

类型

drive_id必填

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

string

expire_sec可选

expire_sec 默认值 : 900最小值 : 0最大值 : 14400样例 : 15

integer (int64)

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

file_name可选

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

string

file_path可选

样例 : "string"

string

share_id可选

样例 : "string"

string

GetDriveRequest

Get drive request

名称

说明

类型

drive_id必填

Drive ID 样例 : "123"

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

encrypt_data_access可选

样例 : true

boolean

encrypt_mode可选

样例 : "string"

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)

GetFileRequest

获取文件元数据

名称

说明

类型

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

file_path可选

样例 : "string"

string

image_thumbnail_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

image_url_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

share_id可选

样例 : "string"

string

GetLastCursorRequest

获取最新游标

名称

说明

类型

drive_id必填

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

string

GetLastCursorResponse

get last file op cursor response

名称

说明

类型

cursor可选

样例 : "string"

string

GetShareRequest

get share request

名称

说明

类型

share_id可选

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

string

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

share_policy可选

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

< SharePermissionPolicy > array

status可选

status 样例 : "enabled"

string

updated_at可选

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

string

GetUploadUrlRequest

获取文件上传URL

名称

说明

类型

content_md5可选

content_md5 最大长度 : 32样例 : "string"

string

drive_id必填

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

string

file_id必填

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

string

file_path可选

样例 : "string"

string

part_info_list可选

upload_part_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

share_id可选

样例 : "string"

string

upload_id必填

upload_id 样例 : "string"

string

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

名称

说明

类型

code必填

样例 : "HTTPMethodNotAllowed"

string

message必填

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

string

ImageMediaResponse

名称

说明

类型

address_line可选

address_line 样例 : "北京市昌平区白各庄新村路"

string

city可选

city 样例 : "杭州"

string

country可选

country 样例 : "中国"

string

district可选

district 样例 : "余杭区"

string

exif可选

exif json string 样例 : "string"

string

faces可选

faces json string 样例 : "string"

string

height可选

height 默认值 : 0样例 : 720

integer (int64)

location可选

location 样例 : "40.110333,116.349311"

string

province可选

province 样例 : "浙江省"

string

time可选

time 样例 : "string"

string (date-time)

township可选

township 样例 : "沙河镇"

string

width可选

width 默认值 : 0样例 : 1024

integer (int64)

IncorrectStatusError

IncorrectStatusError 状态不正确错误

名称

说明

类型

code必填

样例 : "IncorrectStatus"

string

message必填

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

string

IncorrectUserStatusError

IncorrectUserStatusError 状态不正确错误

名称

说明

类型

code必填

样例 : "IncorrectUserStatus"

string

message必填

样例 : "The current status of user 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

InvalidPasswordError

InvalidPasswordError 用户名或密码错误

名称

说明

类型

code必填

样例 : "InvalidPassword"

string

message必填

样例 : "Username or Password is invalid."

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

ListDriveRequest

List drive request

名称

说明

类型

limit可选

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

integer (int32)

marker可选

翻页标记, 接口返回的标记值 样例 : "marker"

string

owner可选

所属者 样例 : "abc"

string

ListDriveResponse

list drive response

名称

说明

类型

items可选

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

< BaseDriveResponse > array

next_marker可选

翻页标记 样例 : "marker"

string

ListFileDeltaRequest

获取增量文件操作记录

名称

说明

类型

cursor可选

cursor 游标 样例 : "abc"

string

drive_id必填

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

string

limit可选

limitdefault 100 样例 : 100

integer (int32)

ListFileDeltaResponse

list file op response

名称

说明

类型

cursor可选

cursor 样例 : "abc"

string

has_more可选

has_more 样例 : false

boolean

items可选

items 样例 : [ ]

< FileDeltaResponse > array

FileDeltaResponse

the file op info

名称

说明

类型

current_category可选

样例 : "string"

string

file可选

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

BasePDSFileResponse

file_id可选

样例 : "string"

string

op可选

样例 : "string"

string

ListFileRequest

list file request

名称

说明

类型

all可选

all 样例 : true

boolean

drive_id必填

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

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "string"

string

image_url_process可选

image_url_process 样例 : "string"

string

limit可选

limit 默认值 : 50最小值 : 0最大值 : 100样例 : 0

integer (int64)

marker可选

marker 样例 : "string"

string

parent_file_id必填

ParentFileID 长度 : 40 - 50模式 : "[a-z0-9.-_]{1,50}"样例 : "string"

string

parent_file_path可选

样例 : "string"

string

share_id可选

样例 : "string"

string

status可选

status 样例 : "string"

enum (uploading, available)

ListMyDriveRequest

List my drive request

名称

说明

类型

limit可选

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

integer (int32)

marker可选

翻页标记, 接口返回的标记值 样例 : "marker"

string

ListShareRequest

list share request

名称

说明

类型

creator可选

creator 样例 : "tom"

string

drive_id可选

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

string

limit必填

limit 最小值 : 1最大值 : 100样例 : 50

integer (int32)

marker可选

marker 样例 : "string"

string

owner可选

Owner 样例 : "jack"

string

share_file_path可选

share_file_path 样例 : "/a/b/"

string

ListShareResponse

List share response

名称

说明

类型

items可选

items 样例 : [ ]

< BaseShareResponse > array

next_marker可选

next_marker 样例 : "string"

string

ListStoreFileRequest

list store file

名称

说明

类型

limit可选

limit 默认值 : 100最小值 : 1最大值 : 1000样例 : 50

integer (int64)

marker可选

marker 样例 : "string"

string

parent_file_path可选

parent_file_path 样例 : "string"

string

store_id可选

store_id 样例 : "xxx"

string

type可选

type 样例 : "file"

enum (file, folder)

ListStoreFileResponse

List storage file

名称

说明

类型

items可选

itemsfile list 样例 : [ ]

< StoreFile > array

next_marker可选

样例 : "string"

string

ListStoreRequest

list storage file

名称

说明

类型

domain_id可选

domain_id 样例 : "10"

string

ListStoreResponse

List storage

名称

说明

类型

items可选

items 样例 : [ ]

< StoreItemResponse > array

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

OSSCompleteFileRequest

complete file request

多态性 : 成分

名称

说明

类型

drive_id可选

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

string

file_path可选

样例 : "string"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

share_id可选

样例 : "string"

string

upload_id可选

upload_id 样例 : "string"

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,1000}"样例 : "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

OSSCopyFileRequest

copy file request

名称

说明

类型

drive_id可选

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

string

file_path可选

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

string

new_name可选

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

string

overwrite可选

overwritetype: boolean 默认值 : false样例 : true

boolean

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

to_drive_id必填

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

string

to_parent_file_path必填

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

string

to_share_id可选

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

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

OSSCreateFileRequest

create file request

多态性 : 成分

名称

说明

类型

content_md5必填

ContentMd5 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

content_type必填

ContentType 样例 : "application/json"

string

drive_id可选

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

string

name必填

Name 样例 : "pds.jpg"

string

parent_file_path必填

parent_file_path 样例 : "string"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "string"

string

size必填

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

integer (int64)

type必填

Type 样例 : "file"

enum (file, folder)

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

OSSDeleteFileRequest

删除文件请求

名称

说明

类型

drive_id可选

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

string

file_path必填

file_path 长度 : 1 - 1000样例 : "string"

string

permanently可选

permanentlytype: false 样例 : false

boolean

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

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

OSSGetDownloadUrlRequest

获取文件下载地址的请求body

名称

说明

类型

drive_id可选

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

string

expire_sec可选

expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 15

integer (int64)

file_name可选

file_name 样例 : "pds.jpg"

string

file_path必填

file_path 长度 : 1 - 1000样例 : "/a/b/c.jpg"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

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

OSSGetFileRequest

获取文件元数据

名称

说明

类型

drive_id可选

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

string

file_path必填

file_id 长度 : 1 - 1000样例 : "string"

string

image_thumbnail_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

image_url_process可选

image_thumbnail_processtype:string 样例 : "image/resize,w_200"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

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,1000}"样例 : "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

OSSGetSecureUrlRequest

获取文件安全地址的请求body

名称

说明

类型

drive_id可选

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

string

expire_sec可选

expire_sec 单位秒 默认值 : 60样例 : 60

integer (int64)

file_path必填

file_path 长度 : 1 - 1000样例 : "/a/b/c.jpg"

string

secure_ip可选

secure_ip 样例 : "192.168.1.1/24"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

OSSGetSecureUrlResponse

获取secure url response

名称

说明

类型

expiration可选

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

string

url可选

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

string

OSSGetUploadUrlRequest

获取文件上传URL

多态性 : 成分

名称

说明

类型

content_md5可选

content_md5 最大长度 : 32样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

drive_id可选

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

string

file_path必填

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

string

part_info_list可选

upload_part_list 样例 : [ ]

< UploadPartInfo > array

share_id可选

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

string

upload_id必填

upload_id 样例 : "3920F2BE4D9446D6967E2ED505A97EFD"

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

OSSListFileRequest

list file request

名称

说明

类型

drive_id可选

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

string

image_thumbnail_process可选

image_thumbnail_process 样例 : "image/resize,w_200"

string

image_url_process可选

image_url_process 样例 : "image/resize,w_200"

string

limit可选

limit 默认值 : 50最小值 : 0最大值 : 100样例 : 10

integer (int64)

marker可选

marker 样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"

string

parent_file_path必填

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

string

share_id可选

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

string

url_expire_sec可选

url_expire_sec 默认值 : 900最小值 : 10最大值 : 14400样例 : 900

integer (int64)

video_thumbnail_process可选

video_thumbnail_processtype:string 样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"

string

OSSListFileResponse

List file response

名称

说明

类型

items可选

items 样例 : [ ]

< BaseOSSFileResponse > array

next_marker可选

next_marker 样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"

string

OSSListUploadedPartRequest

列举uploadID对应的已上传分片

名称

说明

类型

drive_id可选

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

string

file_path必填

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

string

limit必填

limit 默认值 : 1000最小值 : 1最大值 : 1000样例 : 1

integer (int64)

part_number_marker可选

part_number_marker 最小值 : 1样例 : 1

integer (int64)

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

upload_id可选

upload_id 样例 : "00668396C0814D818D90F0A92B04B355"

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

OSSMoveFileRequest

文件移动请求

名称

说明

类型

drive_id可选

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

string

file_path可选

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

string

new_name必填

new_name 样例 : "pds.jpg"

string

overwrite可选

overwritetype: boolean 默认值 : false样例 : true

boolean

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

to_parent_file_path可选

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

string

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,1000}"样例 : "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

OSSVideoDefinitionRequest

获取视频分辨率列表

名称

说明

类型

drive_id可选

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

string

file_path必填

file_path 长度 : 1 - 1000样例 : "/a/b/c.mp4"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

OSSVideoDefinitionResponse

转码接口response

名称

说明

类型

definition_list可选

definition_list 样例 : [ ]

< string > array

OSSVideoM3U8Request

获取视频的m3u8文件

名称

说明

类型

definition可选

definition 默认值 : "Original"样例 : "Original"

string

drive_id可选

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

string

expire_sec可选

expire_sec 默认值 : 60最小值 : 60最大值 : 86400样例 : 60

integer (int64)

file_path必填

file_path 长度 : 1 - 1000样例 : "/a/b/c.mp4"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

sign_token必填

sign_token 样例 : "a8swq28ue21has22das213eds"

string

OSSVideoTranscodeRequest

启动视频转码请求

名称

说明

类型

drive_id可选

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

string

file_path必填

file_path 长度 : 1 - 1000样例 : "/a/b/c.mp4"

string

hls_time可选

hls_time 样例 : 10

integer (int64)

remarks可选

remarks 样例 : "{\"userID\":\"xxx\"}"

string

share_id可选

share_id 模式 : "[0-9a-zA-Z-]+"样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"

string

transcode可选

transcode 默认值 : false样例 : true

boolean

OSSVideoTranscodeResponse

转码接口response

名称

说明

类型

definition_list可选

definition_list 样例 : [ ]

< string > array

duration可选

duration 样例 : 100

integer (int64)

hls_time可选

hls_time 样例 : 10

integer (int64)

OperationDeniedError

OperationDeniedError 拒绝此操作

名称

说明

类型

code必填

样例 : "OperationDenied"

string

message必填

样例 : "Operation not permitted. {message}"

string

OperationNotSupportError

OperationNotSupportError 不允许此操作

名称

说明

类型

code必填

样例 : "OperationNotSupport"

string

message必填

样例 : "This operation is not supported. {message}"

string

PasswordTooSimpleError

PasswordTooSimpleError 密码太简单

名称

说明

类型

code必填

样例 : "PasswordTooSimple"

string

message必填

样例 : "Password is too simple."

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

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

SharePermissionPolicy

名称

说明

类型

file_path可选

样例 : "string"

string

permission_inheritable可选

样例 : true

boolean

permission_list可选

样例 : [ "string" ]

< string > array

permission_type可选

样例 : "string"

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)

StreamInfo

名称

说明

类型

content_hash可选

content_hash 样例 : "7C4A8D09CA3762AF61E59520943DC26494F8941B"

string

content_hash_name可选

content_hash_name 样例 : "sha1"

enum (sha1)

content_md5必填

ContentMd5 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

part_info_list可选

part_info_list 样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]

< UploadPartInfo > array

pre_hash可选

pre_hash 样例 : "E10ADC3949BA59ABBE56E057F20F883E"

string

size必填

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

integer (int64)

StreamUploadInfo

名称

说明

类型

part_info_list可选

part_info_list 样例 : "["

< UploadPartInfo > array

pre_rapid_upload可选

pre_rapid_uploadtype: boolean 样例 : false

boolean

rapid_upload可选

rapid_uploadtype: boolean 样例 : false

boolean

upload_id可选

upload_id 样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"

string

TaskFailedError

TaskFailedError 任务运行中

名称

说明

类型

code必填

样例 : "TaskFailed"

string

message必填

样例 : "Task failed."

string

TaskIsExistError

TaskIsExistError 任务已存在

名称

说明

类型

code必填

样例 : "TaskIsExist"

string

message必填

样例 : "Task is exist."

string

TaskIsRunningError

TaskIsRunningError 任务运行中

名称

说明

类型

code必填

样例 : "TaskIsRunning"

string

message必填

样例 : "Task is running."

string

TaskNotExistError

TaskNotExistError 任务运行中

名称

说明

类型

code必填

样例 : "TaskNotExist"

string

message必填

样例 : "Task not exist."

string

ThrottlingError

ThrottlingError 操作被流控错误

名称

说明

类型

code必填

样例 : "Throttling"

string

message必填

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

string

UCGetObjectInfoByObjectKeyRequest

UCGetObjectInfoByObjectKeyRequest

名称

说明

类型

object_key可选

样例 : "string"

string

UCGetObjectInfoBySha1Request

UCGetObjectInfoBySha1Request

名称

说明

类型

sha1可选

样例 : "string"

string

UnSupportVideoFormatError

UnSupportVideoFormatError 不支持的视频格式

名称

说明

类型

code必填

样例 : "UnSupportVideoFormat"

string

message必填

样例 : "UnSupport video format."

string

UnauthorizedDeviceError

UnauthorizedDeviceError 等待用户登录

名称

说明

类型

code必填

样例 : "UnauthorizedDevice"

string

message必填

样例 : "This operation is forbidden."

string

UpdateDriveRequest

Update drive request

名称

说明

类型

description可选

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

string

drive_id必填

Drive ID 样例 : "123"

string

drive_name可选

Drive 名称 样例 : "pdsdrive"

string

encrypt_data_access可选

授权访问加密数据 默认值 : false样例 : true

boolean

encrypt_mode可选

加密模式 样例 : "server"

string

status可选

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

enum (disabled, enabled)

total_size可选

总大小,单位Byte [如果设置 -1 代表不限制] 默认值 : 0样例 : 1024

integer (int64)

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

encrypt_data_access可选

样例 : true

boolean

encrypt_mode可选

样例 : "string"

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)

UpdateFileMetaRequest

更新文件元数据

名称

说明

类型

description可选

descriptiontype: string 最大长度 : 1000样例 : "string"

string

drive_id必填

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

string

file_id必填

fileid 长度 : 40 - 50 模式 : `”[a-z0-9.-]{1,50}”<br>**样例** :“string”`

string

hidden可选

hiddentype: boolean 默认值 : false样例 : true

boolean

meta可选

meta 样例 : "string"

string

name必填

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

string

share_id可选

样例 : "string"

string

starred可选

starredtype: boolean 默认值 : false样例 : true

boolean

tags可选

tags 样例 : {<br> "string" : "object"<br>}

< string, object > map

UpdateShareRequest

update share request

名称

说明

类型

description可选

description 最大长度 : 1024样例 : "share description"

string

expiration可选

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

string

permissions可选

permissions 样例 : [ ]

< string > array

share_id必填

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

string

share_name可选

share_name 样例 : "new_share_name"

string

share_policy可选

share_policy 样例 : [ "[sharepermissionpolicy](#sharepermissionpolicy)" ]

< SharePermissionPolicy > array

status可选

status 样例 : "enabled"

enum (enabled, disabled)

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

share_policy可选

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

< SharePermissionPolicy > array

status可选

status 样例 : "enabled"

string

updated_at可选

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

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

UrlInfo

名称

说明

类型

download_url可选

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

string

thumbnail可选

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

string

url可选

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

string

UserAuthentication

名称

说明

类型

AuthenticationType必填

认证类型 样例 : "mobile"

string

CreatedAt必填

创建时间 样例 : 1556163159820

integer (int64)

Detail必填

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

string

DomainID必填

Domain ID 样例 : "5000"

string

Identity必填

唯一身份标识 样例 : "152****341"

string

LastLoginTime必填

最后登录时间 样例 : 1556163159820

integer (int64)

Status必填

状态 样例 : "normal"

string

UserID必填

用户ID 样例 : "00016a587b62b50003deea299a4f5b50"

string

extra可选

额外的信息,比如type为mobile时,此字段为国家编号,不填默认86 样例 : "1"

string

UserLockedError

UserLockedError 用户已锁定

名称

说明

类型

code必填

样例 : "UserLocked"

string

message必填

样例 : "User is locked."

string

VideoDefinitionNotFoundError

VideoDefinitionNotFoundError 没有找到此分辨率的转码视频

名称

说明

类型

code必填

样例 : "VideoDefinitionNotFound"

string

message必填

样例 : "Video definition not found."

string

VideoMediaResponse

名称

说明

类型

address_line可选

address_line 样例 : "北京市昌平区白各庄新村路"

string

city可选

city 样例 : "杭州"

string

country可选

country 样例 : "中国"

string

district可选

district 样例 : "余杭区"

string

duration可选

duration 单位 秒 样例 : "\"7704.573000\""

string

location可选

location 样例 : "40.110333,116.349311"

string

province可选

province 样例 : "浙江省"

string

time可选

time 样例 : "string"

string (date-time)

township可选

township 样例 : "沙河镇"

string