全部产品
云市场

OSSPath文件操作API

更新时间:2019-09-12 18:10:58

CCP OSSPath API.

概览

CCP OSSPath API

版本信息

版本 : 2.0.0

URI scheme

  • Endpoint : {domainId}.api.alicloudccp.com
  • 基础路径 : /v2
  • 支持协议类型 : HTTP, HTTPS

请求Content-Type

  • application/json

返回Content-Type

  • application/json

路径

get async task info

  1. POST /v2/async_task/get

说明

This will get async task info

Body参数

get async task info

名称 : body标志 : 可选类型 : GetAsyncTaskRequest

响应

HTTP代码 说明 类型
200 GetAsyncTaskResponse
400 InvalidParameter InvalidParameterError
403 Forbidden ForbiddenNoPermissionError
404 NotFound NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • async_task

HTTP请求示例

请求 path
  1. /v2/async_task/get
请求 body
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "message" : "task is running",
  4. "state" : "success"
  5. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

创建Drive

  1. POST /v2/drive/create

说明

可以指定 Drive 类型来创建 Drive

Body参数

创建 drive 参数信息

名称 : body标志 : 可选类型 : CreateDriveRequest

响应

HTTP代码 说明 类型
201 创建 drive 成功 CreateDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1. ForbiddenNoPermissionError 没有drive接口权限 2. ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/create
请求 body
  1. {
  2. "default" : true,
  3. "description" : "ccp team drive",
  4. "drive_name" : "ccpdrive",
  5. "drive_type" : "normal",
  6. "owner" : "ccp-001",
  7. "relative_path" : "/d/e/f/",
  8. "status" : "enabled",
  9. "store_id" : "store_id",
  10. "total_size" : 1024
  11. }

HTTP响应示例

响应 201
  1. {
  2. "domain_id" : "hz999",
  3. "drive_id" : "123"
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

删除 Drive

  1. POST /v2/drive/delete

说明

该接口将会删除 Drive

Body参数

删除 drive 指定的参数信息

名称 : body标志 : 可选类型 : DeleteDriveRequest

响应

HTTP代码 说明 类型
204 无返回内容 无内容
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/delete
请求 body
  1. {
  2. "drive_id" : "123"
  3. }

HTTP响应示例

响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

获取 Drive 的详细信息

  1. POST /v2/drive/get

说明

通过该接口可以获取 Drive 详细信息

Body参数

获取 drive 的参数信息

名称 : body标志 : 可选类型 : GetDriveRequest

响应

HTTP代码 说明 类型
200 获取 drive 信息成功 GetDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
404 没有找到指定的 drive NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/get
请求 body
  1. {
  2. "drive_id" : "123"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "creator" : "ccp",
  3. "description" : "ccp team drive",
  4. "domain_id" : "hz999",
  5. "drive_id" : "123",
  6. "drive_name" : "ccpdrive",
  7. "drive_type" : "normal",
  8. "owner" : "ccp",
  9. "relative_path" : "/a/b/e/",
  10. "status" : "enabled",
  11. "store_id" : "123",
  12. "total_size" : 102400,
  13. "used_size" : 1024
  14. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

获取默认 Drive 信息

  1. POST /v2/drive/get_default_drive

说明

该接口可以获取默认 Drive 的详细信息

Body参数

获取默认 drive 的参数信息

名称 : body标志 : 可选类型 : GetDefaultDriveRequest

响应

HTTP代码 说明 类型
200 获取默认 drive 详细信息成功 GetDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
404 默认 drive 没找到或未设置 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/get_default_drive
请求 body
  1. {
  2. "user_id" : "abc"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "creator" : "ccp",
  3. "description" : "ccp team drive",
  4. "domain_id" : "hz999",
  5. "drive_id" : "123",
  6. "drive_name" : "ccpdrive",
  7. "drive_type" : "normal",
  8. "owner" : "ccp",
  9. "relative_path" : "/a/b/e/",
  10. "status" : "enabled",
  11. "store_id" : "123",
  12. "total_size" : 102400,
  13. "used_size" : 1024
  14. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

列举用户 Drive

  1. POST /v2/drive/list

说明

该接口将会列举用户的 Drive

Body参数

获取 drive 列表参数信息

名称 : body标志 : 可选类型 : ListDriveRequest

响应

HTTP代码 说明 类型
200 获取 drive 列表成功 ListDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/list
请求 body
  1. {
  2. "limit" : 10,
  3. "marker" : "marker",
  4. "owner" : "abc"
  5. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "creator" : "ccp",
  4. "description" : "ccp team drive",
  5. "domain_id" : "hz999",
  6. "drive_id" : "123",
  7. "drive_name" : "ccpdrive",
  8. "drive_type" : "normal",
  9. "owner" : "ccp",
  10. "relative_path" : "/a/b/e/",
  11. "status" : "enabled",
  12. "store_id" : "123",
  13. "total_size" : 102400,
  14. "used_size" : 1024
  15. } ],
  16. "next_marker" : "marker"
  17. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

列举当前用户的 Drive

  1. POST /v2/drive/list_my_drives

说明

该接口将会列举当前用户的 Drive

Body参数

获取 drive 列表参数信息

名称 : body标志 : 可选类型 : ListMyDriveRequest

响应

HTTP代码 说明 类型
200 获取 drive 列表成功 ListDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/list_my_drives
请求 body
  1. {
  2. "limit" : 10,
  3. "marker" : "marker"
  4. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "creator" : "ccp",
  4. "description" : "ccp team drive",
  5. "domain_id" : "hz999",
  6. "drive_id" : "123",
  7. "drive_name" : "ccpdrive",
  8. "drive_type" : "normal",
  9. "owner" : "ccp",
  10. "relative_path" : "/a/b/e/",
  11. "status" : "enabled",
  12. "store_id" : "123",
  13. "total_size" : 102400,
  14. "used_size" : 1024
  15. } ],
  16. "next_marker" : "marker"
  17. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

更新 Drive 信息

  1. POST /v2/drive/update

说明

该接口将会 更新 Drive 信息

Body参数

更新 drive 参数信息

名称 : body标志 : 可选类型 : UpdateDriveRequest

响应

HTTP代码 说明 类型
200 更新 drive 成功 UpdateDriveResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有drive接口权限 2.ForbiddenAccountNotFoundError 账号没找到 ForbiddenNoPermissionError
404 drive 没找到 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • drive

HTTP请求示例

请求 path
  1. /v2/drive/update
请求 body
  1. {
  2. "description" : "ccp team drive",
  3. "drive_id" : "123",
  4. "drive_name" : "ccpdrive",
  5. "status" : "enabled",
  6. "total_size" : 1024
  7. }

HTTP响应示例

响应 200
  1. {
  2. "creator" : "ccp",
  3. "description" : "ccp team drive",
  4. "domain_id" : "hz999",
  5. "drive_id" : "123",
  6. "drive_name" : "ccpdrive",
  7. "drive_type" : "normal",
  8. "owner" : "ccp",
  9. "relative_path" : "/a/b/e/",
  10. "status" : "enabled",
  11. "store_id" : "123",
  12. "total_size" : 102400,
  13. "used_size" : 1024
  14. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

complete file

  1. POST /v2/file/complete

说明

完成文件上传任务

Body参数

file req

名称 : body标志 : 可选类型 : OSSCompleteFileRequest

响应

HTTP代码 说明 类型
200 CompleteFileResponse
400 1. 请求参数无效 2. 请求body是无效的json格式. InvalidParameterError
403 1. 无权限访问CompleteFile API 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_path 或者upload_id 不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/complete
请求 body
  1. {
  2. "drive_id" : "1",
  3. "part_info_list" : [ {
  4. "etag" : "0CC175B9C0F1B6A831C399E269772661",
  5. "part_number" : 1,
  6. "part_size" : 1024,
  7. "upload_url" : "https://ccp.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
  8. } ],
  9. "upload_id" : "string",
  10. "file_path" : "string",
  11. "share_id" : "string"
  12. }

HTTP响应示例

响应 200
  1. {
  2. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  3. "content_hash_name" : "sha1",
  4. "content_type" : "application/json",
  5. "crc64_hash" : "string",
  6. "created_at" : "2019-08-20T06:51:27.292Z",
  7. "description" : "file description",
  8. "domain_id" : "test001",
  9. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  10. "drive_id" : "1",
  11. "file_extension" : "jpg",
  12. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  13. "file_path" : "/a.jpg",
  14. "hidden" : false,
  15. "meta" : "file meta",
  16. "name" : "ccp.jpg",
  17. "parent_file_id" : "root",
  18. "parent_file_path" : "/",
  19. "share_id" : "string",
  20. "size" : 1024,
  21. "starred" : false,
  22. "status" : "available",
  23. "tags" : {
  24. "tag1" : 1
  25. },
  26. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  27. "trashed_at" : "string",
  28. "type" : "file",
  29. "updated_at" : "string",
  30. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  31. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  32. "crc" : "string"
  33. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

copy file

  1. POST /v2/file/copy

说明

拷贝文件或者文件夹

Body参数

file req

名称 : body标志 : 可选类型 : OSSCopyFileRequest

响应

HTTP代码 说明 类型
201 文件拷贝成功. CopyFileResponse
202 启动文件夹拷贝任务. CopyFileResponse
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_id 不存在. 3. 如果Domain path 是oss path, 而且domain绑定的bucket不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/copy
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_path" : "/a/b/c.jpg",
  4. "new_name" : "ccp.jpg",
  5. "overwrite" : true,
  6. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  7. "to_drive_id" : "1",
  8. "to_parent_file_path" : "/a/b/c/",
  9. "to_share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
  10. }

HTTP响应示例

响应 201
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "string"
  8. }
响应 202
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "string"
  8. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

create file

  1. POST /v2/file/create

说明

创建文件或者文件夹

Body参数

文件创建请求

名称 : body标志 : 可选类型 : OSSCreateFileRequest

响应

HTTP代码 说明 类型
201 创建成功 CreateFileResponse
400 请求参数无效 InvalidParameterError
403 1. 无权限访问创建文件或文件夹. 2. share 过期 ForbiddenNoPermissionError
404 Drive或者Share不存在. 如果Domain path 是 oss path, 而且Domain绑定的bucket不存在,也会返回404。 NotFoundError
409 同名文件夹或者同名文件已经存在。 AlreadyExistError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/create
请求 body
  1. {
  2. "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  3. "content_type" : "application/json",
  4. "name" : "ccp.jpg",
  5. "part_info_list" : [ {
  6. "etag" : "0CC175B9C0F1B6A831C399E269772661",
  7. "part_number" : 1,
  8. "part_size" : 1024,
  9. "upload_url" : "https://ccp.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
  10. } ],
  11. "size" : 0,
  12. "type" : "file",
  13. "drive_id" : "1",
  14. "parent_file_path" : "string",
  15. "share_id" : "string"
  16. }

HTTP响应示例

响应 201
  1. {
  2. "domain_id" : "domain",
  3. "drive_id" : "1",
  4. "file_id" : "5d79206586bb5dd69fb34c349282718146c55da7",
  5. "file_path" : "/a/b/c.jpg",
  6. "parent_file_id" : "root",
  7. "part_info_list" : "[",
  8. "rapid_upload" : false,
  9. "share_id" : "1",
  10. "type" : "file",
  11. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6"
  12. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 409
  1. {
  2. "code" : "AlreadyExist",
  3. "message" : "{resource} has already exists. {extra_msg}"
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

delete file

  1. POST /v2/file/delete

说明

删除文件或者文件夹

Body参数

file req

名称 : body标志 : 可选类型 : OSSDeleteFileRequest

响应

HTTP代码 说明 类型
202 启动文件夹删除任务 DeleteFileResponse
204 删除文件成功 DeleteFileResponse
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_id 不存在. 3. 如果Domain path 是oss path, 而且domain绑定的bucket不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/delete
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_path" : "string",
  4. "permanently" : false,
  5. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
  6. }

HTTP响应示例

响应 202
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "string"
  8. }
响应 204
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "string"
  8. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

get file

  1. POST /v2/file/get

说明

获取文件meta信息

Body参数

file req

名称 : body标志 : 可选类型 : GetFileRequest

响应

HTTP代码 说明 类型
200 GetFileRequest
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_id 不存在. 3. 如果Domain path 是oss path, 而且domain绑定的bucket不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/get
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_id" : "string",
  4. "file_path" : "string",
  5. "image_thumbnail_process" : "image/resize,w_200",
  6. "image_url_process" : "image/resize,w_200",
  7. "share_id" : "string"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "drive_id" : "1",
  3. "file_id" : "string",
  4. "file_path" : "string",
  5. "image_thumbnail_process" : "image/resize,w_200",
  6. "image_url_process" : "image/resize,w_200",
  7. "share_id" : "string"
  8. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

get download url

  1. POST /v2/file/get_download_url

说明

获取文件 download url

Body参数

file req

名称 : body标志 : 可选类型 : GetDownloadUrlRequest

响应

HTTP代码 说明 类型
200 GetDownloadUrlResponse
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_id 不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/get_download_url
请求 body
  1. {
  2. "drive_id" : "1",
  3. "expire_sec" : 15,
  4. "file_id" : "string",
  5. "file_name" : "ccp.jpg",
  6. "file_path" : "string",
  7. "share_id" : "string"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "expiration" : "2006-01-02T15:04:05.999Z07:00",
  3. "method" : "GET",
  4. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"
  5. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

get upload url

  1. POST /v2/file/get_upload_url

说明

获取file Upload url

Body参数

获取文件upload url

名称 : body标志 : 可选类型 : OSSGetUploadUrlRequest

响应

HTTP代码 说明 类型
200 GetUploadUrlResponse
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_path 或者upload_id 不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/get_upload_url
请求 body
  1. {
  2. "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  3. "drive_id" : "1",
  4. "part_info_list" : [ ],
  5. "upload_id" : "3920F2BE4D9446D6967E2ED505A97EFD",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "1"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "create_at" : "2019-09-11T16:34:36.977Z",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "part_info_list" : [ ],
  8. "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4"
  9. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

list file

  1. POST /v2/file/list

说明

列举文件或者文件夹

Body参数

文件列举请求

名称 : body标志 : 可选类型 : OSSListFileRequest

响应

HTTP代码 说明 类型
200 列举文件成功 ListFileResponse
400 无效请求参数. InvalidParameterError
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
  1. /v2/file/list
请求 body
  1. {
  2. "drive_id" : "1",
  3. "image_thumbnail_process" : "image/resize,w_200",
  4. "image_url_process" : "image/resize,w_200",
  5. "limit" : 10,
  6. "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  7. "parent_file_path" : "/a/b/c.jpg",
  8. "share_id" : "1"
  9. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ ],
  3. "next_marker" : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

list uploaded parts

  1. POST /v2/file/list_uploaded_parts

说明

列举uploadID对应的已上传分片

Body参数

列举uploadID对应的已上传分片请求

名称 : body标志 : 可选类型 : OSSListUploadedPartRequest

响应

HTTP代码 说明 类型
200 列举uploadID对应的已上传分片成功 ListUploadedPartResponse
400 无效请求参数. InvalidParameterError
403 1. 无权列举uploadID对应的已上传分片. 2. share 过期 ForbiddenNoPermissionError
404 Drive或者Share不存在. 如果Domain path 是 oss path, 而且Domain绑定的bucket不存在,也会返回404。 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/list_uploaded_parts
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_path" : "/a/b/c.jpg",
  4. "limit" : 1,
  5. "part_number_marker" : 1,
  6. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  7. "upload_id" : "00668396C0814D818D90F0A92B04B355"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "next_part_number_marker" : "4",
  3. "uploaded_parts" : [ ]
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

move file

  1. POST /v2/file/move

说明

移动文件到相同drive的其他路径。

Body参数

file req

名称 : body标志 : 可选类型 : OSSMoveFileRequest

响应

HTTP代码 说明 类型
200 MoveFileResponse
400 1. 请求参数无效. 2. 请求body是无效的json格式 InvalidParameterError
403 1.无权限访问 get_signature 接口. 2. share 过期 ForbiddenNoPermissionError
404 1. Drive或者Share不存在. 2. file_id 不存在. 3. 如果Domain path 是oss path, 而且domain绑定的bucket不存在 NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • file

HTTP请求示例

请求 path
  1. /v2/file/move
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_path" : "/a/b/c.jpg",
  4. "new_name" : "ccp.jpg",
  5. "overwrite" : true,
  6. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  7. "to_parent_file_path" : "/a/b/c/"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "file_path" : "/a/b/c.jpg",
  7. "share_id" : "string"
  8. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

create share

  1. POST /v2/share/create

说明

This will create share

Body参数

list share

名称 : body标志 : 可选类型 : CreateShareRequest

响应

HTTP代码 说明 类型
201 CreateShareResponse
400 InvalidParameter InvalidParameterError
403 No permission to access create action ForbiddenNoPermissionError
404 The Drive that share belongs to can’t be found. NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • share

HTTP请求示例

请求 path
  1. /v2/share/create
请求 body
  1. {
  2. "description" : "share description",
  3. "drive_id" : "1",
  4. "expiration" : "2006-01-02T15:04:05.999Z",
  5. "owner" : "abc",
  6. "permissions" : [ ],
  7. "share_file_path" : "string",
  8. "share_name" : "share",
  9. "status" : "enabled"
  10. }

HTTP响应示例

响应 201
  1. {
  2. "domain_id" : "domain-1",
  3. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

delete share

  1. POST /v2/share/delete

说明

This will delete share

Body参数

delete share

名称 : body标志 : 可选类型 : DeleteShareRequest

响应

HTTP代码 说明 类型
204 No Content 无内容
400 No permission to access get share action. InvalidParameterError
403 Forbidden ForbiddenNoPermissionError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • share

HTTP请求示例

请求 path
  1. /v2/share/delete
请求 body
  1. {
  2. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
  3. }

HTTP响应示例

响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

get share

  1. POST /v2/share/get

说明

This will get share

Body参数

get share

名称 : body标志 : 可选类型 : GetShareRequest

响应

HTTP代码 说明 类型
301 GetShareResponse
400 InvalidParameter InvalidParameterError
403 No permission to access get share action. ForbiddenNoPermissionError
404 The Drive that share belongs to can’t be found. NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • share

HTTP请求示例

请求 path
  1. /v2/share/get
请求 body
  1. {
  2. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
  3. }

HTTP响应示例

响应 301
  1. {
  2. "created_at" : "2006-01-02T15:04:05.999Z",
  3. "creator" : "xxx",
  4. "description" : "share description",
  5. "domain_id" : "domain-1",
  6. "drive_id" : "1",
  7. "expiration" : "2006-01-02T15:04:05.999Z",
  8. "expired" : false,
  9. "owner" : "xxx",
  10. "permissions" : [ ],
  11. "share_file_path" : "/a/b/c/",
  12. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  13. "share_name" : "new_share",
  14. "status" : "enabled",
  15. "updated_at" : "2006-01-02T15:04:05.999Z"
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

list share

  1. POST /v2/share/list

说明

This will list share

Body参数

list share

名称 : body标志 : 可选类型 : ListShareRequest

响应

HTTP代码 说明 类型
200 ListShareResponse
400 InvalidParameter InvalidParameterError
403 Forbidden ForbiddenNoPermissionError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • share

HTTP请求示例

请求 path
  1. /v2/share/list
请求 body
  1. {
  2. "creator" : "abc",
  3. "limit" : 50,
  4. "marker" : "string",
  5. "owner" : "edf"
  6. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ ],
  3. "next_marker" : "string"
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

update share

  1. POST /v2/share/update

说明

This will update share

Body参数

update share

名称 : body标志 : 可选类型 : UpdateShareRequest

响应

HTTP代码 说明 类型
200 UpdateShareResponse
400 InvalidParameter InvalidParameterError
403 No permission to access get update share action. ForbiddenNoPermissionError
404 The Drive that share belongs to can’t be found. NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • share

HTTP请求示例

请求 path
  1. /v2/share/update
请求 body
  1. {
  2. "description" : "share description",
  3. "expiration" : "2006-01-02T15:04:05.999Z",
  4. "permissions" : [ ],
  5. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  6. "share_name" : "new_share_name",
  7. "status" : "enabled"
  8. }

HTTP响应示例

响应 200
  1. {
  2. "created_at" : "2006-01-02T15:04:05.999Z",
  3. "creator" : "xxx",
  4. "description" : "share description",
  5. "domain_id" : "domain-1",
  6. "drive_id" : "1",
  7. "expiration" : "2006-01-02T15:04:05.999Z",
  8. "expired" : false,
  9. "owner" : "xxx",
  10. "permissions" : [ ],
  11. "share_file_path" : "/a/b/c/",
  12. "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  13. "share_name" : "new_share",
  14. "status" : "enabled",
  15. "updated_at" : "2006-01-02T15:04:05.999Z"
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

storage share

  1. POST /v2/storage/list

说明

This will list storage

Body参数

list storage

名称 : body标志 : 可选类型 : ListStorageRequest

响应

HTTP代码 说明 类型
200 ListStorageResponse
400 InvalidParameter InvalidParameterError
403 Forbidden ForbiddenNoPermissionError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • storage

HTTP请求示例

请求 path
  1. /v2/storage/list
请求 body
  1. {
  2. "domain_id" : "10"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ ]
  3. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

list storage_file

  1. POST /v2/storage_file/list

说明

This will list storage_file

Body参数

list storagefile

名称 : body标志 : 可选类型 : ListStorageFileRequest

响应

HTTP代码 说明 类型
200 ListStorageFileResponse
400 InvalidParameter InvalidParameterError
403 Domain path type is not oss path ForbiddenNoPermissionError
404 Bucket bind to domain storage can’t be found. NotFoundError
500 InternalError InternalErrorError
503 ServiceUnavailable ServiceUnavailableError

标签

  • storage

HTTP请求示例

请求 path
  1. /v2/storage_file/list
请求 body
  1. {
  2. "limit" : 50,
  3. "marker" : "string",
  4. "parent_file_path" : "string",
  5. "store_id" : "xxx",
  6. "type" : "file"
  7. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ ],
  3. "next_marker" : "string"
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

定义

APIError

APIError is api error common struct

名称 说明 类型
code
必填
样例 : "string" string
message
必填
样例 : "string" string

AlreadyExistError

AlreadyExistError 已经存在错误

名称 说明 类型
code
必填
样例 : "AlreadyExist" string
message
必填
样例 : "{resource} has already exists. {extra_msg}" string

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
模式 : "[a-z0-9.-_]{1,1024}"
样例 : "ccp.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 创建者
样例 : "ccp"
string
description
可选
Drive 备注信息
样例 : "ccp team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "ccpdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "ccp"
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)

BaseFileResponse

Base file response

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
enum (application/json, text/html)
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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
样例 : "string" string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
tags
可选
tags
样例 : {<br> "tag1" : 1<br>}
< string, object > map
thumbnail
可选
thumbnail
样例 : "https://ccp.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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

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

BaseMoveFileRequest

文件移动请求

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
new_name
可选
new_name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: boolean
默认值 : false
样例 : false
boolean

BaseShareResponse

List share response

名称 说明 类型
created_at
可选
created_at
样例 : "2006-01-02T15:04:05.999Z"
string
creator
可选
creator
样例 : "xxx"
string
description
可选
description
样例 : "share description"
string
domain_id
可选
domain_id
样例 : "domain-1"
string
drive_id
可选
drive_id
样例 : "1"
string
expiration
可选
expiration
样例 : "2006-01-02T15:04:05.999Z"
string
expired
可选
expired
样例 : false
boolean
owner
可选
owner
样例 : "xxx"
string
permissions
可选
permissions
样例 : [ ]
< string > array
share_file_path
可选
share_path
样例 : "/a/b/c/"
string
share_id
可选
share_id
样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"
string
share_name
可选
share_name
样例 : "new_share"
string
status
可选
status
样例 : "enabled"
string
updated_at
可选
updated_at
样例 : "2006-01-02T15:04:05.999Z"
string

CCPCallbackRequest

CCPCallbackRequest

名称 说明 类型
bucket
可选
样例 : "string" string
endpoint
可选
样例 : "string" string
file_id
可选
样例 : "string" string
object_key
可选
样例 : "string" string
sha1
可选
样例 : "string" string
size
可选
样例 : 0 integer (int64)
upload_id
可选
样例 : "string" string

CCPCompleteFileRequest

合并文件上传任务

多态性 : 成分

名称 说明 类型
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

CCPCopyFileRequest

文件拷贝

名称 说明 类型
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
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: boolean
默认值 : false
样例 : false
boolean
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

CCPCreateFileRequest

创建文件

多态性 : 成分

名称 说明 类型
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
hidden
可选
hidden
样例 : false
boolean
meta
可选
meta
样例 : "meta test"
string
name
必填
Name
模式 : "[a-z0-9.-_]{1,1024}"
样例 : "ccp.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)
tags
可选
tags
样例 : {<br> "tag1" : 1,<br> "tag2" : 2<br>}
< string, object > map
type
必填
Type
样例 : "file"
enum (file, folder)

CCPDeleteFileRequest

删除文件请求

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
必填
fileid
长度 : 40 - 50
模式 : `”[a-z0-9.-
]{1, 50}”<br>**样例** :“5d792010669a1dd91087479e8071c9ae212065cc”`
string
permanently
可选
permanently
type: false
默认值 : false
样例 : false
boolean

CCPDeleteFilesRequest

批量删除文件请求

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id_list
必填
file_id_list
样例 : [ ]
< string > array

CCPGetAsyncTaskRequest

获取异步人去信息

名称 说明 类型
async_task_id
可选
async_task_id
type:string
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string

CCPGetDownloadUrlRequest

获取文件下载地址的请求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,1024}"
样例 : "ccp.jpg"
string

CCPGetFileRequest

获取文件元数据

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
必填
fileid
长度 : 40 - 50
模式 : `”[a-z0-9.-
]{1, 50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`
string
image_thumbnail_process
可选
image_thumbnail_process
type:string
样例 : "image/resize,w_200"
string
image_url_process
可选
image_thumbnail_process
type:string
样例 : "image/crop,w_100,h_100/rounded-corners,r_10/format,png"
string

CCPGetUploadUrlRequest

获取文件上传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

CCPListFileRequest

列举文件

多态性 : 成分

名称 说明 类型
all
可选
all
默认值 : false
样例 : false
boolean
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/crop,w_100,h_100/rounded-corners,r_10/format,png"
string
limit
可选
limit
默认值 : 50
最小值 : 0
最大值 : 100
样例 : 10
integer (int64)
marker
可选
marker
样例 : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
string
parent_file_id
必填
ParentFileID
长度 : 40 - 50
模式 : "[a-z0-9.-_]{1, 50}"
样例 : "root"
string
status
可选
status
默认值 : "available"
样例 : "available"
enum (uploading, available)

CCPListUploadedPartRequest

列举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

CCPMoveFileRequest

文件移动请求

多态性 : 成分

名称 说明 类型
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
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: boolean
默认值 : false
样例 : false
boolean
to_parent_file_id
必填
to_parent_file_id
长度 : 40 - 50
样例 : "root"
string

CCPSearchFileRequest

搜索文件元数据

名称 说明 类型
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

CCPUpdateFileMetaRequest

更新文件元数据

名称 说明 类型
description
可选
description
type: string
最大长度 : 1024
样例 : "description"
string
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
必填
fileid
长度 : 40 - 50
模式 : `”[a-z0-9.-
]{1, 50}”<br>**样例** :“5d5b846942cf94fa72324c14a4bda34e81da635d”`
string
hidden
可选
hidden
type: boolean
默认值 : false
样例 : false
boolean
meta
可选
meta
样例 : "meta test"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
starred
可选
starred
type: boolean
默认值 : false
样例 : false
boolean
tags
可选
tags
样例 : {<br> "tag1" : 1,<br> "tag2" : 2<br>}
< string, object > map

CcpCallback

名称 说明 类型
body
可选
样例 : {<br> "string" : "string"<br>} < string, string > map
url
可选
样例 : "string" 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

CompleteFileResponse

complete file response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
enum (application/json, text/html)
crc
可选
crc
样例 : "string"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
样例 : "string" string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
tags
可选
tags
样例 : {<br> "tag1" : 1<br>}
< string, object > map
thumbnail
可选
thumbnail
样例 : "https://ccp.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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

CopyFileRequest

copy file request

名称 说明 类型
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,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: boolean
默认值 : false
样例 : true
boolean
share_id
可选
样例 : "string" 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>**样例** :“string”`
string
to_parent_file_path
可选
样例 : "string" string
to_share_id
可选
样例 : "string" string

CopyFileResponse

文件拷贝 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
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
样例 : "string" string

CreateDriveRequest

create drive request

名称 说明 类型
default
可选
是否默认drive, 只允许设置一个默认drive
默认值 : false
样例 : true
boolean
description
可选
描述信息
样例 : "ccp team drive"
string
drive_name
必填
Drive 名称
样例 : "ccpdrive"
string
drive_type
可选
Drive类型
默认值 : "normal"
样例 : "normal"
enum (normal, large)
owner
必填
所属者
样例 : "ccp-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 [如果设置 0 代表不限制]
默认值 : 0
样例 : 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
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.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)

CreateFileResponse

Create file response

名称 说明 类型
domain_id
可选
domain_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "domain"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d79206586bb5dd69fb34c349282718146c55da7"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
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_upload
type: boolean
样例 : false
boolean
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "1"
string
type
可选
type
样例 : "file"
enum (file, folder)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string

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

DeleteFileResponse

删除文件 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
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
样例 : "string" string

DeleteFilesResponse

批量删除文件 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
可选
样例 : "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_id
type:string
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string

GetAsyncTaskResponse

Get AsyncTask Response

名称 说明 类型
async_task_id
可选
async_task_id
type:string
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
message
可选
message
样例 : "task is running"
string
state
可选
state
样例 : "success"
enum (Running, Failed, Succeed)

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,1024}"
样例 : "ccp.jpg"
string
file_path
可选
样例 : "string" string
share_id
可选
样例 : "string" string

GetDownloadUrlResponse

获取download url response

名称 说明 类型
expiration
可选
expiration
样例 : "2006-01-02T15:04:05.999Z07:00"
string
method
可选
method
样例 : "GET"
string
url
可选
url
样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"
string

GetDriveRequest

Get drive request

名称 说明 类型
drive_id
必填
Drive ID
样例 : "123"
string

GetDriveResponse

Get drive response

名称 说明 类型
creator
可选
Drive 创建者
样例 : "ccp"
string
description
可选
Drive 备注信息
样例 : "ccp team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "ccpdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "ccp"
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_process
type:string
样例 : "image/resize,w_200"
string
image_url_process
可选
image_thumbnail_process
type:string
样例 : "image/resize,w_200"
string
share_id
可选
样例 : "string" string

GetFileResponse

获取文件元数据response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
enum (application/json, text/html)
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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
样例 : "string" string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
tags
可选
tags
样例 : {<br> "tag1" : 1<br>}
< string, object > map
thumbnail
可选
thumbnail
样例 : "https://ccp.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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
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
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

GetUploadUrlResponse

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
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
part_info_list
可选
part_info_list
样例 : [ ]
< UploadPartInfo > array
upload_id
可选
upload_id
样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"
string

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

名称 说明 类型
code
必填
样例 : "HTTPMethodNotAllowed" string
message
必填
样例 : "The request http method is not supported for this resource." string

IncorrectStatusError

IncorrectStatusError 状态不正确错误

名称 说明 类型
code
必填
样例 : "IncorrectStatus" string
message
必填
样例 : "The current status does not support this operation." string

InternalErrorError

InternalErrorError 内部错误

名称 说明 类型
code
必填
样例 : "InternalError" string
message
必填
样例 : "The request has been failed due to some unknown error." string

InvalidHeaderError

InvalidHeaderError 请求头不合法错误

名称 说明 类型
code
必填
样例 : "InvalidHeader" string
message
必填
样例 : "Header {header_name} is not valid." string

InvalidParameterEmptyError

InvalidParameterEmptyError 参数为空错误

名称 说明 类型
code
必填
样例 : "InvalidParameterEmpty" string
message
必填
样例 : "The input parameter {parameter_name} is empty." string

InvalidParameterError

InvalidParameterError 参数非法错误

名称 说明 类型
code
必填
样例 : "InvalidParameter" string
message
必填
样例 : "The input parameter {parameter_name} is not valid." string

InvalidParameterExpiredError

InvalidParameterExpiredError 参数已经过期错误

名称 说明 类型
code
必填
样例 : "InvalidParameterExpired" string
message
必填
样例 : "The input parameter {resource} is expired. {extra_msg}" string

InvalidParameterMissingError

InvalidParameterMissingError 参数缺失

名称 说明 类型
code
必填
样例 : "InvalidParameterMissing" string
message
必填
样例 : "The input parameter {parameter_name} is missing." string

InvalidParameterNotMatchError

InvalidParameterNotMatchError 参数不匹配错误

名称 说明 类型
code
必填
样例 : "InvalidParameterNotMatch" string
message
必填
样例 : "The input parameter {parameter_name} doesn't match." string

InvalidParameterNotSupportedError

InvalidParameterNotSupportedError 参数不支持错误

名称 说明 类型
code
必填
样例 : "InvalidParameterNotSupported" string
message
必填
样例 : "The input parameter {parameter_name} is not supported." string

InvalidParameterOutOfRangeError

InvalidParameterOutOfRangeError 参数超过范围错误

名称 说明 类型
code
必填
样例 : "InvalidParameterOutOfRange" string
message
必填
样例 : "The input parameter {parameter_name} doesn't match the limitation." string

InvalidParameterWrongFormatError

InvalidParameterWrongFormatError 参数格式错误

名称 说明 类型
code
必填
样例 : "InvalidParameterWrongFormat" string
message
必填
样例 : "The input parameter {parameter_name} has invalid format." string

InvalidRequestJSONFormatError

InvalidRequestJSONFormatError 请求JSON格式错误

名称 说明 类型
code
必填
样例 : "InvalidRequestJSONFormat" string
message
必填
样例 : "{parameter_name} is invalid Json format." string

InvalidResourceError

InvalidResourceError 非法资源错误

名称 说明 类型
code
必填
样例 : "InvalidResource" string
message
必填
样例 : "The resource {resource_name} is not valid." string

InvalidResourceIsEmptyError

InvalidResourceIsEmptyError 资源为空错误

名称 说明 类型
code
必填
样例 : "InvalidResourceIsEmpty" string
message
必填
样例 : "The {resouce_name} resource %s is empty." string

InvalidResourceUnsupportedError

InvalidResourceUnsupportedError 资源不支持错误

名称 说明 类型
code
必填
样例 : "InvalidResourceUnsupported" string
message
必填
样例 : "The resource {resource_name} is not supported." string

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

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)

ListFileResponse

List file response

名称 说明 类型
items
可选
items
样例 : [ ]
< BaseFileResponse > array
next_marker
可选
next_marker
样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
string

ListMyDriveRequest

List my drive request

名称 说明 类型
limit
可选
每页大小限制
默认值 : 100
最小值 : 1
最大值 : 100
样例 : 10
integer (int32)
marker
可选
翻页标记, 接口返回的标记值
样例 : "marker"
string

ListShareRequest

list share request

名称 说明 类型
creator
必填
creator
样例 : "abc"
string
limit
必填
limit
最小值 : 1
最大值 : 100
样例 : 50
integer (int32)
marker
可选
marker
样例 : "string"
string
owner
必填
creator
样例 : "edf"
string

ListShareResponse

List share response

名称 说明 类型
items
可选
items
样例 : [ ]
< BaseShareResponse > array
next_marker
可选
next_marker
样例 : "string"
string

ListStorageFileRequest

list storage 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)

ListStorageFileResponse

List storage file

名称 说明 类型
items
可选
items
file list
样例 : [ ]
< StoreFile > array
next_marker
可选
样例 : "string" string

ListStorageRequest

list storage file

名称 说明 类型
domain_id
可选
domain_id
样例 : "10"
string

ListStorageResponse

List storage

名称 说明 类型
items
可选
items
样例 : [ ]
< StoreItemResponse > array

ListUploadedPartResponse

获取签名 response

名称 说明 类型
next_part_number_marker
可选
next_part_number_marker
样例 : "4"
string
uploaded_parts
可选
uploaded_parts
样例 : [ ]
< UploadPartInfo > array

MoveFileResponse

文件移动 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
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
样例 : "string" string

NotEmptyError

NotEmptyError 不为空错误

名称 说明 类型
code
必填
样例 : "NotEmpty" string
message
必填
样例 : "{resource_name} is not empty." string

NotFoundError

NotFoundError 没有找到错误

名称 说明 类型
code
必填
样例 : "NotFound" string
message
必填
样例 : "The resource {resource_name} cannot be found. Please check." string

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

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,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: 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

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
模式 : "[a-z0-9.-_]{1,1024}"
样例 : "ccp.jpg"
string
parent_file_path
必填
parent_file_path
样例 : "string"
string
part_info_list
可选
part_info_list
样例 : [ "[uploadpartinfo](#uploadpartinfo)" ]
< UploadPartInfo > array
share_id
可选
share_id
长度 : 50 - 40
样例 : "string"
string
size
必填
Size
最小值 : 0
最大值 : 53687091200
样例 : 0
integer (int64)
type
必填
Type
样例 : "file"
enum (file, folder)

OSSDeleteFileRequest

删除文件请求

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
必填
filepath
长度 : 40 - 50
模式 : `”[a-z0-9.-
]{1, 50}”<br>**样例** :“string”`
string
permanently
可选
permanently
type: false
样例 : false
boolean
share_id
可选
share_id
模式 : "[0-9a-zA-z-]+"
样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"
string

OSSGetFileRequest

获取文件元数据

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
必填
fileid
长度 : 40 - 50
模式 : `”[a-z0-9.-
]{1, 50}”<br>**样例** :“string”`
string
image_thumbnail_process
可选
image_thumbnail_process
type:string
样例 : "image/resize,w_200"
string
image_url_process
可选
image_thumbnail_process
type:string
样例 : "image/resize,w_200"
string
share_id
可选
share_id
模式 : "[0-9a-zA-z-]+"
样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"
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-9]+"
样例 : "1"
string
upload_id
必填
upload_id
样例 : "3920F2BE4D9446D6967E2ED505A97EFD"
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
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
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

OSSMoveFileRequest

文件移动请求

名称 说明 类型
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,1024}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: 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

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
parent_file_path
可选
parent_file_id
样例 : "/"
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

SearchFileResponse

search file response

名称 说明 类型
items
可选
items
样例 : [ ]
< BaseFileResponse > array
next_marker
可选
next_marker
样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
string

ServiceUnavailableError

ServiceUnavailableError 服务不可用错误

名称 说明 类型
code
必填
样例 : "ServiceUnavailable" string
message
必填
样例 : "The request has failed due to a temporary failure of the server." string

Sha1ConflictError

Sha1ConflictError Sha1冲突错误

名称 说明 类型
code
必填
样例 : "Sha1Conflict" string
message
必填
样例 : "Find multiple objects of the same sha1." string

SignatureDoesNotMatchError

SignatureDoesNotMatchError 签名不匹配错误

名称 说明 类型
code
必填
样例 : "SignatureDoesNotMatch" string
message
必填
样例 : "SignatureDoesNotMatch." string

StateConflictError

StateConflictError 状态冲突错误

名称 说明 类型
code
必填
样例 : "StateConflict" string
message
必填
样例 : "User operation is not valid." string

StoreFile

名称 说明 类型
domain_id
可选
样例 : "string" string
name
可选
样例 : "string" string
parent_file_path
可选
样例 : "string" string
store_id
可选
样例 : "string" string
type
可选
样例 : "string" string

StoreItemResponse

名称 说明 类型
base_path
可选
存储公共前缀
样例 : "ccp-data"
string
bucket
必填
bucket名称
样例 : "data-sz-bucket"
string
domain_id
可选
样例 : "string" string
endpoint
必填
存储访问地址
样例 : "https://oss-cn-shenzhen.aliyuncs.com/"
string
ownership
必填
存储归属,system表示系统提供,custom表示使用自己的存储
样例 : "system"
enum (system, custom)
policy
必填
Policy授权,system类型store会将bucket权限授予当前云账号
样例 : "string"
string
role_arn
可选
访问Bucket的角色ARN
样例 : "acs:oss:*:*:*"
string
store_id
必填
store ID
样例 : "cdjaksbwuiqbxuiassd"
string
type
必填
存储类型,当前只支持oss
样例 : "oss"
enum (oss)

ThrottlingError

ThrottlingError 操作被流控错误

名称 说明 类型
code
必填
样例 : "Throttling" string
message
必填
样例 : "The operation is blocked due to throttling control." string

UCCompleteFileRequest

create file request

多态性 : 成分

名称 说明 类型
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

UCCreateFileRequest

create file request

多态性 : 成分

名称 说明 类型
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
hidden
可选
hidden
样例 : false
boolean
meta
可选
meta
样例 : "meta test"
string
name
必填
Name
模式 : "[a-z0-9.-_]{1,1024}"
样例 : "ccp.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)
tags
可选
tags
样例 : {<br> "tag1" : 1,<br> "tag2" : 2<br>}
< string, object > map
type
必填
Type
样例 : "file"
enum (file, folder)

UCFileGetSignatureRequest

create file request

名称 说明 类型
action
可选
样例 : "string" string
bucket
可选
样例 : "string" string
content_md5
可选
样例 : "string" string
content_type
可选
样例 : "string" string
date
可选
样例 : "string" string
drive_id
可选
样例 : "string" string
headers
可选
样例 : {<br> "string" : "string"<br>} < string, string > map
object_key
可选
样例 : "string" string
parameters
可选
样例 : {<br> "string" : "object"<br>} < string, object > map
upload_id
可选
样例 : "string" string

UCFileUploadCallbackRequest

UCFileUploadCallbackRequest

名称 说明 类型
Bucket
可选
样例 : "string" string
ContentHash
可选
样例 : "string" string
DomainID
可选
样例 : "string" string
DriveID
可选
样例 : "string" string
Etag
可选
样例 : "string" string
MimeType
可选
样例 : "string" string
ObjectKey
可选
样例 : "string" string
Size
可选
样例 : 0 integer (int64)
UploadID
可选
样例 : "string" string

UCGetObjectInfoByObjectKeyRequest

UCGetObjectInfoByObjectKeyRequest

名称 说明 类型
object_key
可选
样例 : "string" string

UCGetObjectInfoBySha1Request

UCGetObjectInfoBySha1Request

名称 说明 类型
sha1
可选
样例 : "string" string

UpdateDriveRequest

Update drive request

名称 说明 类型
description
可选
描述信息
样例 : "ccp team drive"
string
drive_id
必填
Drive ID
样例 : "123"
string
drive_name
必填
Drive 名称
样例 : "ccpdrive"
string
status
可选
状态
默认值 : "enabled"
样例 : "enabled"
enum (disabled, enabled)
total_size
可选
总大小,单位Byte [如果设置 0 代表不限制]
默认值 : 0
样例 : 1024
integer (int64)

UpdateDriveResponse

Update drive response

名称 说明 类型
creator
可选
Drive 创建者
样例 : "ccp"
string
description
可选
Drive 备注信息
样例 : "ccp team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "ccpdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "ccp"
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
可选
description
type: 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
可选
hidden
type: boolean
默认值 : false
样例 : true
boolean
meta
可选
meta
样例 : "string"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
share_id
可选
样例 : "string" string
starred
可选
starred
type: boolean
默认值 : false
样例 : true
boolean
tags
可选
tags
样例 : {<br> "string" : "object"<br>}
< string, object > map

UpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
enum (application/json, text/html)
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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "ccp.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
样例 : "string" string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
tags
可选
tags
样例 : {<br> "tag1" : 1<br>}
< string, object > map
thumbnail
可选
thumbnail
样例 : "https://ccp.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://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

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
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
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://ccp.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
string