全部产品

CCPPath文件操作API

更新时间:2020-04-23 16:30:40

概览

CCPPath API

版本信息

版本 : 2.0.0

URI scheme

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

请求Content-Type

  • application/json

响应Content-Type

  • application/json

API

获取异步任务信息

  1. POST /v2/async_task/get

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPGetAsyncTaskResponse
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
  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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

批处理

  1. POST /v2/batch

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPBatchResponse
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
  1. /v2/batch
请求 body
  1. {
  2. "requests" : [ {
  3. "body" : {
  4. "drive_id" : "101",
  5. "file_id" : "xxxxxx"
  6. },
  7. "headers" : {
  8. "Content-Type" : "application/json"
  9. },
  10. "id" : "\"1\"",
  11. "method" : "\"POST\"",
  12. "url" : "/file/get"
  13. } ],
  14. "resource" : "\"file\""
  15. }

HTTP响应示例

响应 200
  1. {
  2. "responses" : [ {
  3. "body" : {
  4. "drive_id" : "101",
  5. "file_id" : "xxxxxx"
  6. },
  7. "id" : "\"1\"",
  8. "status" : 200
  9. } ]
  10. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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/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
  1. /v2/drive/create
请求 body
  1. {
  2. "default" : true,
  3. "description" : "ccp team drive",
  4. "drive_name" : "ccpdrive",
  5. "drive_type" : "normal",
  6. "encrypt_mode" : "string",
  7. "owner" : "ccp-001",
  8. "relative_path" : "/d/e/f/",
  9. "status" : "enabled",
  10. "store_id" : "store_id",
  11. "total_size" : 1024
  12. }

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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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_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
  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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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_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
  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. "encrypt_data_access" : true,
  9. "encrypt_mode" : "string",
  10. "owner" : "ccp",
  11. "relative_path" : "/a/b/e/",
  12. "status" : "enabled",
  13. "store_id" : "123",
  14. "total_size" : 102400,
  15. "used_size" : 1024
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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,在创建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
  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. "encrypt_data_access" : true,
  9. "encrypt_mode" : "string",
  10. "owner" : "ccp",
  11. "relative_path" : "/a/b/e/",
  12. "status" : "enabled",
  13. "store_id" : "123",
  14. "total_size" : 102400,
  15. "used_size" : 1024
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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请求标志 : 必填类型 : 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
  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. "encrypt_data_access" : true,
  10. "encrypt_mode" : "string",
  11. "owner" : "ccp",
  12. "relative_path" : "/a/b/e/",
  13. "status" : "enabled",
  14. "store_id" : "123",
  15. "total_size" : 102400,
  16. "used_size" : 1024
  17. } ],
  18. "next_marker" : "marker"
  19. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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请求标志 : 必填类型 : 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
  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. "encrypt_data_access" : true,
  10. "encrypt_mode" : "string",
  11. "owner" : "ccp",
  12. "relative_path" : "/a/b/e/",
  13. "status" : "enabled",
  14. "store_id" : "123",
  15. "total_size" : 102400,
  16. "used_size" : 1024
  17. } ],
  18. "next_marker" : "marker"
  19. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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_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
  1. /v2/drive/update
请求 body
  1. {
  2. "description" : "ccp team drive",
  3. "drive_id" : "123",
  4. "drive_name" : "ccpdrive",
  5. "encrypt_data_access" : true,
  6. "encrypt_mode" : "server",
  7. "status" : "enabled",
  8. "total_size" : 1024
  9. }

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. "encrypt_data_access" : true,
  9. "encrypt_mode" : "string",
  10. "owner" : "ccp",
  11. "relative_path" : "/a/b/e/",
  12. "status" : "enabled",
  13. "store_id" : "123",
  14. "total_size" : 102400,
  15. "used_size" : 1024
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

完成文件上传

  1. POST /v2/file/complete

说明

完成文件上传。

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPCompleteFileResponse
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
  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_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
  11. }

HTTP响应示例

响应 200
  1. {
  2. "category" : "doc",
  3. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  4. "content_hash_name" : "sha1",
  5. "content_type" : "application/json",
  6. "crc64_hash" : "string",
  7. "created_at" : "2019-08-20T06:51:27.292Z",
  8. "description" : "file description",
  9. "domain_id" : "test001",
  10. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  11. "drive_id" : "1",
  12. "encrypt_mode" : "pin",
  13. "file_extension" : "jpg",
  14. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  15. "hidden" : false,
  16. "image_media_metadata" : {
  17. "address_line" : "北京市昌平区白各庄新村路",
  18. "city" : "杭州",
  19. "country" : "中国",
  20. "district" : "余杭区",
  21. "exif" : "string",
  22. "faces" : "string",
  23. "height" : 720,
  24. "location" : "40.110333,116.349311",
  25. "province" : "浙江省",
  26. "time" : "string",
  27. "township" : "沙河镇",
  28. "width" : 1024
  29. },
  30. "labels" : [ "label1:1", "label2:2" ],
  31. "meta" : "string",
  32. "name" : "ccp.jpg",
  33. "parent_file_id" : "root",
  34. "size" : 1024,
  35. "starred" : false,
  36. "status" : "available",
  37. "streams_url_info" : {
  38. "string" : "[urlinfo](#urlinfo)"
  39. },
  40. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  41. "trashed_at" : "string",
  42. "type" : "file",
  43. "updated_at" : "string",
  44. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  45. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  46. "user_meta" : "user_meta",
  47. "video_media_metadata" : {
  48. "address_line" : "北京市昌平区白各庄新村路",
  49. "city" : "杭州",
  50. "country" : "中国",
  51. "district" : "余杭区",
  52. "duration" : "\"7704.573000\"",
  53. "location" : "40.110333,116.349311",
  54. "province" : "浙江省",
  55. "time" : "string",
  56. "township" : "沙河镇"
  57. }
  58. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

拷贝文件或文件夹

  1. POST /v2/file/copy

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
201 文件拷贝成功. CCPCopyFileResponse
202 启动文件夹拷贝任务. CCPCopyFileResponse
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
  1. /v2/file/copy
请求 body
  1. {
  2. "auto_rename" : false,
  3. "drive_id" : "1",
  4. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  5. "new_name" : "ccp.jpg",
  6. "to_drive_id" : "1",
  7. "to_parent_file_id" : "root"
  8. }

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. }
响应 202
  1. {
  2. "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  3. "domain_id" : "test001",
  4. "drive_id" : "1",
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
  6. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

创建文件或者文件夹

  1. POST /v2/file/create

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
201 创建成功 CCPCreateFileResponse
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
  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. "auto_rename" : true,
  14. "check_name_mode" : "string",
  15. "content_hash" : "7C4A8D09CA3762AF61E59520943DC26494F8941B",
  16. "content_hash_name" : "sha1",
  17. "description" : "file description",
  18. "drive_id" : "1",
  19. "encrypt_mode" : "string",
  20. "file_id" : "string",
  21. "hidden" : false,
  22. "labels" : [ "label1", "label2" ],
  23. "last_updated_at" : "2019-08-20T06:51:27.292Z",
  24. "meta" : "string",
  25. "parent_file_id" : "root",
  26. "pre_hash" : "E10ADC3949BA59ABBE56E057F20F883E",
  27. "streams_info" : {
  28. "string" : "[streaminfo](#streaminfo)"
  29. },
  30. "user_meta" : "user_meta"
  31. }

HTTP响应示例

响应 201
  1. {
  2. "domain_id" : "domain",
  3. "drive_id" : "1",
  4. "encrypt_mode" : "pin",
  5. "file_id" : "5d79206586bb5dd69fb34c349282718146c55da7",
  6. "file_name" : "test.txt",
  7. "parent_file_id" : "root",
  8. "part_info_list" : "[",
  9. "rapid_upload" : false,
  10. "streams_upload_info" : {
  11. "string" : "[streamuploadinfo](#streamuploadinfo)"
  12. },
  13. "type" : "file",
  14. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6"
  15. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

删除文件或文件夹

  1. POST /v2/file/delete

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
202 启动文件夹删除任务 CCPDeleteFileResponse
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
  1. /v2/file/delete
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_id" : "5d792010669a1dd91087479e8071c9ae212065cc",
  4. "permanently" : false
  5. }

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. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

下载文件

  1. GET /v2/file/download

说明

指定文件ID,下载文件。

参数

类型 名称 说明 类型
Query DriveID
必填
drive id string
Query FileID
必填
file id string
Query ImageThumbnailProcess
可选
image_thumbnail_process string
Query VideoThumbnailProcess
可选
video_thumbnail_process
type:string
string

响应

HTTP代码 说明 类型
301 CCPGetDownloadUrlRequest
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
  1. /v2/file/download?DriveID=string&FileID=string

HTTP响应示例

响应 301
  1. {
  2. "drive_id" : "1",
  3. "expire_sec" : 15,
  4. "file_id" : "string",
  5. "file_name" : "ccp.jpg"
  6. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

获取文件或文件夹信息

  1. POST /v2/file/get

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPGetFileResponse
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
  1. /v2/file/get
请求 body
  1. {
  2. "drive_id" : "1",
  3. "fields" : "*",
  4. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  5. "image_thumbnail_process" : "image/resize,w_200",
  6. "image_url_process" : "image/crop,w_100,h_100/rounded-corners,r_10/format,png",
  7. "url_expire_sec" : 900,
  8. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  9. }

HTTP响应示例

响应 200
  1. {
  2. "category" : "doc",
  3. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  4. "content_hash_name" : "sha1",
  5. "content_type" : "application/json",
  6. "crc64_hash" : "string",
  7. "created_at" : "2019-08-20T06:51:27.292Z",
  8. "description" : "file description",
  9. "domain_id" : "test001",
  10. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  11. "drive_id" : "1",
  12. "encrypt_mode" : "pin",
  13. "file_extension" : "jpg",
  14. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  15. "hidden" : false,
  16. "image_media_metadata" : {
  17. "address_line" : "北京市昌平区白各庄新村路",
  18. "city" : "杭州",
  19. "country" : "中国",
  20. "district" : "余杭区",
  21. "exif" : "string",
  22. "faces" : "string",
  23. "height" : 720,
  24. "location" : "40.110333,116.349311",
  25. "province" : "浙江省",
  26. "time" : "string",
  27. "township" : "沙河镇",
  28. "width" : 1024
  29. },
  30. "labels" : [ "label1:1", "label2:2" ],
  31. "meta" : "string",
  32. "name" : "ccp.jpg",
  33. "parent_file_id" : "root",
  34. "size" : 1024,
  35. "starred" : false,
  36. "status" : "available",
  37. "streams_url_info" : {
  38. "string" : "[urlinfo](#urlinfo)"
  39. },
  40. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  41. "trashed_at" : "string",
  42. "type" : "file",
  43. "updated_at" : "string",
  44. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  45. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  46. "user_meta" : "user_meta",
  47. "video_media_metadata" : {
  48. "address_line" : "北京市昌平区白各庄新村路",
  49. "city" : "杭州",
  50. "country" : "中国",
  51. "district" : "余杭区",
  52. "duration" : "\"7704.573000\"",
  53. "location" : "40.110333,116.349311",
  54. "province" : "浙江省",
  55. "time" : "string",
  56. "township" : "沙河镇"
  57. }
  58. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

根据路径获取文件或文件夹信息

  1. POST /v2/file/get_by_path

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPGetFileByPathResponse
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
  1. /v2/file/get_by_path
请求 body
  1. {
  2. "drive_id" : "1",
  3. "fields" : "*",
  4. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  5. "file_path" : "/a/b/c",
  6. "image_thumbnail_process" : "image/resize,w_200",
  7. "image_url_process" : "image/crop,w_100,h_100/rounded-corners,r_10/format,png",
  8. "url_expire_sec" : 900,
  9. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  10. }

HTTP响应示例

响应 200
  1. {
  2. "category" : "doc",
  3. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  4. "content_hash_name" : "sha1",
  5. "content_type" : "application/json",
  6. "crc64_hash" : "string",
  7. "created_at" : "2019-08-20T06:51:27.292Z",
  8. "description" : "file description",
  9. "domain_id" : "test001",
  10. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  11. "drive_id" : "1",
  12. "encrypt_mode" : "pin",
  13. "file_extension" : "jpg",
  14. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  15. "hidden" : false,
  16. "image_media_metadata" : {
  17. "address_line" : "北京市昌平区白各庄新村路",
  18. "city" : "杭州",
  19. "country" : "中国",
  20. "district" : "余杭区",
  21. "exif" : "string",
  22. "faces" : "string",
  23. "height" : 720,
  24. "location" : "40.110333,116.349311",
  25. "province" : "浙江省",
  26. "time" : "string",
  27. "township" : "沙河镇",
  28. "width" : 1024
  29. },
  30. "labels" : [ "label1:1", "label2:2" ],
  31. "meta" : "string",
  32. "name" : "ccp.jpg",
  33. "parent_file_id" : "root",
  34. "size" : 1024,
  35. "starred" : false,
  36. "status" : "available",
  37. "streams_url_info" : {
  38. "string" : "[urlinfo](#urlinfo)"
  39. },
  40. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  41. "trashed_at" : "string",
  42. "type" : "file",
  43. "updated_at" : "string",
  44. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  45. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  46. "user_meta" : "user_meta",
  47. "video_media_metadata" : {
  48. "address_line" : "北京市昌平区白各庄新村路",
  49. "city" : "杭州",
  50. "country" : "中国",
  51. "district" : "余杭区",
  52. "duration" : "\"7704.573000\"",
  53. "location" : "40.110333,116.349311",
  54. "province" : "浙江省",
  55. "time" : "string",
  56. "township" : "沙河镇"
  57. }
  58. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

获取文件下载地址

  1. POST /v2/file/get_download_url

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPGetDownloadUrlResponse
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
  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. }

HTTP响应示例

响应 200
  1. {
  2. "expiration" : "2006-01-02T15:04:05.999Z07:00",
  3. "method" : "GET",
  4. "size" : 102400,
  5. "streams_url" : {
  6. "string" : "string"
  7. },
  8. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"
  9. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

获取增量数据最新的游标

  1. 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
  1. /v2/file/get_last_cursor
请求 body
  1. {
  2. "drive_id" : "1"
  3. }

HTTP响应示例

响应 200
  1. "[getlastcursorresponse](#getlastcursorresponse)"
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

获取文件分片的上传地址

  1. POST /v2/file/get_upload_url

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPGetUploadUrlResponse
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
  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_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d"
  7. }

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. "part_info_list" : [ ],
  7. "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4"
  8. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

列举文件或文件夹

  1. POST /v2/file/list

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 列举文件成功 CCPListFileResponse
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
  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. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast",
  8. "Starred" : false,
  9. "all" : false,
  10. "category" : "image",
  11. "fields" : "*",
  12. "order_by" : "name",
  13. "order_direction" : "ASC",
  14. "parent_file_id" : "root",
  15. "status" : "available",
  16. "type" : "file",
  17. "url_expire_sec" : 900
  18. }

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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

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

  1. POST /v2/file/list_by_custom_index_key

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 列举文件成功 CCPListFileResponse
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
  1. /v2/file/list_by_custom_index_key
请求 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. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast",
  8. "Starred" : false,
  9. "category" : "image",
  10. "custom_index_key" : "string",
  11. "encrypt_mode" : "string",
  12. "fields" : "*",
  13. "order_direction" : "ASC",
  14. "status" : "available",
  15. "type" : "file",
  16. "url_expire_sec" : 900
  17. }

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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

获取增量数据列表

  1. 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
  1. /v2/file/list_delta
请求 body
  1. {
  2. "cursor" : "abc",
  3. "drive_id" : "1",
  4. "limit" : 100
  5. }

HTTP响应示例

响应 200
  1. "[listfiledeltaresponse](#listfiledeltaresponse)"
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

列举已上传分片

  1. POST /v2/file/list_uploaded_parts

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 列举uploadID对应的已上传分片成功 CCPListUploadedPartResponse
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
  1. /v2/file/list_uploaded_parts
请求 body
  1. {
  2. "drive_id" : "1",
  3. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  4. "limit" : 1,
  5. "part_number_marker" : 1,
  6. "upload_id" : "00668396C0814D818D90F0A92B04B355"
  7. }

HTTP响应示例

响应 200
  1. {
  2. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  3. "next_part_number_marker" : "4",
  4. "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4",
  5. "uploaded_parts" : [ ]
  6. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

移动文件或文件夹

  1. POST /v2/file/move

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPMoveFileResponse
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
  1. /v2/file/move
请求 body
  1. {
  2. "drive_id" : "1",
  3. "new_name" : "ccp.jpg",
  4. "overwrite" : false,
  5. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  6. "to_parent_file_id" : "root"
  7. }

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. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

全量获取文件元信息

  1. POST /v2/file/scan

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 Success CCPScanFileMetaResponse
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
  1. /v2/file/scan
请求 body
  1. {
  2. "category" : "image",
  3. "drive_id" : "1",
  4. "limit" : 1000,
  5. "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
  6. }

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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

文件搜索

  1. POST /v2/file/search

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 Success CCPSearchFileResponse
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
  1. /v2/file/search
请求 body
  1. {
  2. "drive_id" : "1",
  3. "image_thumbnail_process" : "image/resize,m_fill,h_128,w_128,limit_0",
  4. "image_url_process" : "image/resize,m_fill,h_128,w_128,limit_0",
  5. "limit" : 10,
  6. "marker" : "\"\"",
  7. "order_by" : "size",
  8. "query" : "not name=123",
  9. "url_expire_sec" : 900,
  10. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  11. }

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. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

更新文件或文件夹信息

  1. POST /v2/file/update

说明

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

Body参数

请求参数

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

响应

HTTP代码 说明 类型
200 CCPUpdateFileMetaResponse
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
  1. /v2/file/update
请求 body
  1. {
  2. "custom_index_key" : "string",
  3. "description" : "description",
  4. "drive_id" : "1",
  5. "encrypt_mode" : "string",
  6. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  7. "hidden" : false,
  8. "labels" : [ "label1", "label2" ],
  9. "meta" : "string",
  10. "name" : "ccp.jpg",
  11. "starred" : false,
  12. "user_meta" : "user_meta"
  13. }

HTTP响应示例

响应 200
  1. {
  2. "category" : "doc",
  3. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  4. "content_hash_name" : "sha1",
  5. "content_type" : "application/json",
  6. "crc64_hash" : "string",
  7. "created_at" : "2019-08-20T06:51:27.292Z",
  8. "description" : "file description",
  9. "domain_id" : "test001",
  10. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  11. "drive_id" : "1",
  12. "encrypt_mode" : "pin",
  13. "file_extension" : "jpg",
  14. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  15. "hidden" : false,
  16. "image_media_metadata" : {
  17. "address_line" : "北京市昌平区白各庄新村路",
  18. "city" : "杭州",
  19. "country" : "中国",
  20. "district" : "余杭区",
  21. "exif" : "string",
  22. "faces" : "string",
  23. "height" : 720,
  24. "location" : "40.110333,116.349311",
  25. "province" : "浙江省",
  26. "time" : "string",
  27. "township" : "沙河镇",
  28. "width" : 1024
  29. },
  30. "labels" : [ "label1:1", "label2:2" ],
  31. "meta" : "string",
  32. "name" : "ccp.jpg",
  33. "parent_file_id" : "root",
  34. "size" : 1024,
  35. "starred" : false,
  36. "status" : "available",
  37. "streams_url_info" : {
  38. "string" : "[urlinfo](#urlinfo)"
  39. },
  40. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  41. "trashed_at" : "string",
  42. "type" : "file",
  43. "updated_at" : "string",
  44. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  45. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  46. "user_meta" : "user_meta",
  47. "video_media_metadata" : {
  48. "address_line" : "北京市昌平区白各庄新村路",
  49. "city" : "杭州",
  50. "country" : "中国",
  51. "district" : "余杭区",
  52. "duration" : "\"7704.573000\"",
  53. "location" : "40.110333,116.349311",
  54. "province" : "浙江省",
  55. "time" : "string",
  56. "township" : "沙河镇"
  57. }
  58. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  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. }

定义

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

BaseCCPFileResponse

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://ccp.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
可选
Hidden
type: 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}"
样例 : "ccp.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
可选
starred
type: 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://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
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
样例 : "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
encrypt_data_access
可选
样例 : true boolean
encrypt_mode
可选
样例 : "string" 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)

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_process
type: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
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: 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://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_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1000}"
样例 : "ccp.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://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

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)

CCPBatchRequest

批处理

名称 说明 类型
requests
必填
Requests 请求合集
样例 : [ "[batchsubrequest](#batchsubrequest)" ]
< BatchSubRequest > array
resource
必填
支持的资源类型
样例 : "\"file\""
string

CCPBatchResponse

batch operation response

名称 说明 类型
responses
可选
responses 返回结果合集
样例 : [ "[batchsubresponse](#batchsubresponse)" ]
< BatchSubResponse > array

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

CCPCompleteFileResponse

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://ccp.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
可选
Hidden
type: 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}"
样例 : "ccp.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
可选
starred
type: 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://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
user_meta
可选
user_meta
样例 : "user_meta"
string
video_media_metadata
可选
样例 : "[videomediaresponse](#videomediaresponse)" VideoMediaResponse

CCPCopyFileRequest

文件拷贝

名称 说明 类型
auto_rename
可选
auto_rename
type: 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
样例 : "ccp.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

CCPCopyFileResponse

文件拷贝 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

CCPCreateFileRequest

创建文件

多态性 : 成分

名称 说明 类型
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
样例 : "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)
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

CCPCreateFileResponse

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_upload
type: boolean
样例 : false
boolean
exist
可选
exist
type: boolean
样例 : false
boolean
status
可选
status
type: 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

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

CCPDeleteFileResponse

删除文件 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

CCPDeleteFilesRequest

批量删除文件请求

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

CCPDeleteFilesResponse

批量删除文件 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

CCPGetAsyncTaskRequest

获取异步人去信息

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

CCPGetAsyncTaskResponse

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)

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
长度 : 1 - 1024
样例 : "ccp.jpg"
string

CCPGetDownloadUrlResponse

获取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://ccp.data.aliyuncs.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt"
string

CCPGetFileByPathRequest

根据路径获取 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_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
url_expire_sec
可选
url_expire_sec
默认值 : 900
最小值 : 10
最大值 : 14400
样例 : 900
integer (int64)
video_thumbnail_process
可选
video_thumbnail_process
type:string
样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
string

CCPGetFileByPathResponse

根据路径获取文件元数据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://ccp.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
可选
Hidden
type: 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}"
样例 : "ccp.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
可选
starred
type: 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://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
user_meta
可选
user_meta
样例 : "user_meta"
string
video_media_metadata
可选
样例 : "[videomediaresponse](#videomediaresponse)" VideoMediaResponse

CCPGetFileRequest

获取文件元数据

名称 说明 类型
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_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
url_expire_sec
可选
url_expire_sec
默认值 : 900
最小值 : 10
最大值 : 14400
样例 : 900
integer (int64)
video_thumbnail_process
可选
video_thumbnail_process
type:string
样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
string

CCPGetFileResponse

获取文件元数据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://ccp.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
可选
Hidden
type: 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}"
样例 : "ccp.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
可选
starred
type: 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://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
user_meta
可选
user_meta
样例 : "user_meta"
string
video_media_metadata
可选
样例 : "[videomediaresponse](#videomediaresponse)" VideoMediaResponse

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

CCPGetUploadUrlResponse

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

CCPListFileByCustomIndexKeyRequest

列举文件

多态性 : 成分

名称 说明 类型
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_process
type:string
样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
string

CCPListFileRequest

列举文件

多态性 : 成分

名称 说明 类型
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_process
type:string
样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
string

CCPListFileResponse

List file response

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

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

CCPListUploadedPartResponse

获取签名 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

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
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: boolean
默认值 : false
样例 : false
boolean
to_parent_file_id
必填
to_parent_file_id
长度 : 40 - 50
样例 : "root"
string

CCPMoveFileResponse

文件移动 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

CCPScanFileMetaRequest

全量获取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

CCPScanFileMetaResponse

scan file meta response

名称 说明 类型
items
可选
items
样例 : [ ]
< BaseCCPFileResponse > array
next_marker
可选
next_marker
样例 : "NWQ1YmI4MjA0ZGU1ZWNjYzAzODM0ZDVkODlkMWJiMzcyNzM1NTU4OA"
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
url_expire_sec
可选
url_expire_sec
默认值 : 900
最小值 : 10
最大值 : 14400
样例 : 900
integer (int64)
video_thumbnail_process
可选
video_thumbnail_process
type:string
样例 : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
string

CCPSearchFileResponse

search file response

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

CCPUpdateFileMetaRequest

更新文件元数据

名称 说明 类型
custom_index_key
可选
样例 : "string" string
description
可选
description
type: 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
可选
hidden
type: boolean
默认值 : false
样例 : false
boolean
labels
可选
labels
样例 : [ "label1", "label2" ]
< string > array
meta
可选
样例 : "string" string
name
可选
name
长度 : 1 - 1024
样例 : "ccp.jpg"
string
starred
可选
starred
type: boolean
默认值 : false
样例 : false
boolean
user_meta
可选
user_meta
样例 : "user_meta"
string

CCPUpdateFileMetaResponse

更新文件元数据 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://ccp.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
可选
Hidden
type: 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}"
样例 : "ccp.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
可选
starred
type: 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://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
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}"
样例 : "ccp.jpg"
string
overwrite
可选
overwrite
type: 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
可选
描述信息
样例 : "ccp team drive"
string
drive_name
必填
Drive 名称
样例 : "ccpdrive"
string
drive_type
可选
Drive类型
默认值 : "normal"
样例 : "normal"
enum (normal, large)
encrypt_mode
可选
样例 : "string" string
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 [如果设置 -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
样例 : "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)

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 policy
share_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_id
type: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}"
样例 : "ccp.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 创建者
样例 : "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
encrypt_data_access
可选
样例 : true boolean
encrypt_mode
可选
样例 : "string" 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

GetLastCursorRequest

获取最新游标

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "1"
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
可选
limit
default 100
样例 : 100
integer (int32)

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
可选
items
file 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://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_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1000}"
样例 : "ccp.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://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

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

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
样例 : "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
模式 : "[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
可选
permanently
type: 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
样例 : "ccp.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://ccp.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_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
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://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_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1000}"
样例 : "ccp.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://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

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://ccp.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_process
type: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
样例 : "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

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://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_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1000}"
样例 : "ccp.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://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

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
可选
存储公共前缀
样例 : "ccp-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_upload
type: boolean
样例 : false
boolean
rapid_upload
可选
rapid_upload
type: 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
可选
描述信息
样例 : "ccp team drive"
string
drive_id
必填
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "ccpdrive"
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 创建者
样例 : "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
encrypt_data_access
可选
样例 : true boolean
encrypt_mode
可选
样例 : "string" 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,1000}"
样例 : "ccp.jpg"
string
share_id
可选
样例 : "string" string
starred
可选
starred
type: 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://ccp.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
string

UrlInfo

名称 说明 类型
download_url
可选
download_url
样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
thumbnail
可选
thumbnail
样例 : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
url
可选
url
样例 : "https://ccp.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
必填
唯一身份标识
样例 : "15208345000"
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