托管模式文件操作API

概览

File API for SelfHostedMode

版本信息

版本 : 2.0.0

URI scheme

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

基础路径 : /v2

协议 : HTTP, HTTPS

请求Content-Type

• application/json

返回Content-Type

• application/json

API

完成文件上传

POST /v2/osspath/file/complete

说明

完成文件上传

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/complete

请求 body

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

HTTP响应示例

响应 200

{
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "file_extension" : "jpg",
  "file_path" : "/a.jpg",
  "name" : "pds.jpg",
  "parent_file_path" : "/",
  "share_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "size" : 1024,
  "status" : "available",
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "crc" : "string"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

拷贝文件或文件夹

POST /v2/osspath/file/copy

说明

指定源文件或文件夹路径，拷贝到指定的文件夹。

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/copy

请求 body

{
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "new_name" : "pds.jpg",
  "overwrite" : true,
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "to_drive_id" : "1",
  "to_parent_file_path" : "/a/b/c/",
  "to_share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 201

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "share_id" : "test001"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

创建文件或者文件夹

POST /v2/osspath/file/create

说明

创建文件或者文件夹。

Body参数

文件创建请求

名称 : 创建文件或文件夹请求标志 : 必填类型 : OSSCreateFileRequest

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/create

请求 body

{
  "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  "content_type" : "application/json",
  "name" : "pds.jpg",
  "part_info_list" : [ {
    "etag" : "0CC175B9C0F1B6A831C399E269772661",
    "part_number" : 1,
    "part_size" : 1024,
    "upload_url" : "https://pds.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
  } ],
  "size" : 0,
  "type" : "file",
  "drive_id" : "1",
  "parent_file_path" : "string",
  "share_id" : "string"
}

HTTP响应示例

响应 201

{
  "domain_id" : "domain",
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "part_info_list" : "[",
  "share_id" : "1",
  "type" : "file",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6"
}

响应 400

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

响应 403

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

响应 404

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

响应 409

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

响应 500

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

响应 503

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

删除文件或文件夹

POST /v2/osspath/file/delete

说明

指定文件或文件夹路径，删除文件或文件夹

Body参数

删除请求

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/delete

请求 body

{
  "drive_id" : "1",
  "file_path" : "string",
  "permanently" : false,
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

获取文件或文件夹信息

POST /v2/osspath/file/get

说明

获取指定文件或文件夹路径，获取文件或文件夹信息。

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/get

请求 body

{
  "drive_id" : "1",
  "file_path" : "string",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/resize,w_200",
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 200

{
  "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  "content_hash_name" : "sha1",
  "content_type" : "application/json",
  "crc64_hash" : "string",
  "created_at" : "2019-08-20T06:51:27.292Z",
  "description" : "file description",
  "domain_id" : "test001",
  "download_url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "drive_id" : "1",
  "file_extension" : "jpg",
  "file_path" : "/a.jpg",
  "name" : "pds.jpg",
  "parent_file_path" : "/",
  "share_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  "size" : 1024,
  "status" : "available",
  "thumbnail" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  "trashed_at" : "string",
  "type" : "file",
  "updated_at" : "string",
  "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  "url" : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

获取文件下载地址

POST /v2/osspath/file/get_download_url

说明

指定文件路径，获取文件下载地址

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/get_download_url

请求 body

{
  "drive_id" : "1",
  "expire_sec" : 15,
  "file_name" : "pds.jpg",
  "file_path" : "/a/b/c.jpg",
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

获取文件分片的上传地址

POST /v2/osspath/file/get_upload_url

说明

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

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/get_upload_url

请求 body

{
  "content_md5" : "E10ADC3949BA59ABBE56E057F20F883E",
  "drive_id" : "1",
  "part_info_list" : [ ],
  "upload_id" : "3920F2BE4D9446D6967E2ED505A97EFD",
  "file_path" : "/a/b/c.jpg",
  "share_id" : "1"
}

HTTP响应示例

响应 200

{
  "create_at" : "2019-09-11T16:34:36.977Z",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "part_info_list" : [ ],
  "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

列举文件或者文件夹

POST /v2/osspath/file/list

说明

指定父文件夹路径，列举文件夹下的文件或者文件夹

Body参数

文件列举请求

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/list

请求 body

{
  "drive_id" : "1",
  "image_thumbnail_process" : "image/resize,w_200",
  "image_url_process" : "image/resize,w_200",
  "limit" : 10,
  "marker" : "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "parent_file_path" : "/a/b/c.jpg",
  "share_id" : "1"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

列举已上传分片

POST /v2/osspath/file/list_uploaded_parts

说明

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

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/list_uploaded_parts

请求 body

{
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "limit" : 1,
  "part_number_marker" : 1,
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "upload_id" : "00668396C0814D818D90F0A92B04B355"
}

HTTP响应示例

响应 200

{
  "file_path" : "/a/b/c.jpg",
  "next_part_number_marker" : "4",
  "upload_id" : "F3C25CDFA5C74ECB8DE32672F6211FD4",
  "uploaded_parts" : [ ]
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

移动文件或文件夹

POST /v2/osspath/file/move

说明

指定源文件或文件夹路径，移动到指定的文件夹。

Body参数

请求参数

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

响应

标签

• file

HTTP请求示例

请求 path

/v2/osspath/file/move

请求 body

{
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "new_name" : "pds.jpg",
  "overwrite" : true,
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "to_parent_file_path" : "/a/b/c/"
}

HTTP响应示例

响应 200

{
  "async_task_id" : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
  "domain_id" : "test001",
  "drive_id" : "1",
  "file_path" : "/a/b/c.jpg",
  "share_id" : "test001"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

创建共享

POST /v2/osspath/share/create

说明

创建共享。

Body参数

请求参数

名称 : 创建共享请求标志 : 必填类型 : CreateShareRequest

响应

标签

• share

HTTP请求示例

请求 path

/v2/osspath/share/create

请求 body

{
  "description" : "share description",
  "drive_id" : "1",
  "expiration" : "2006-01-02T15:04:05.999Z",
  "owner" : "abc",
  "permissions" : [ ],
  "share_file_path" : "string",
  "share_name" : "share",
  "status" : "enabled"
}

HTTP响应示例

响应 201

{
  "domain_id" : "domain-1",
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

删除共享

POST /v2/osspath/share/delete

说明

删除指定共享

Body参数

请求参数

名称 : 删除共享请求标志 : 必填类型 : DeleteShareRequest

响应

标签

• share

HTTP请求示例

请求 path

/v2/osspath/share/delete

请求 body

{
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 400

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

响应 403

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

响应 500

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

响应 503

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

获取共享信息

POST /v2/osspath/share/get

说明

获取共享信息。

Body参数

请求参数

名称 : 获取共享信息请求标志 : 必填类型 : GetShareRequest

响应

标签

• share

HTTP请求示例

请求 path

/v2/osspath/share/get

请求 body

{
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6"
}

HTTP响应示例

响应 301

{
  "created_at" : "2006-01-02T15:04:05.999Z",
  "creator" : "xxx",
  "description" : "share description",
  "domain_id" : "domain-1",
  "drive_id" : "1",
  "expiration" : "2006-01-02T15:04:05.999Z",
  "expired" : false,
  "owner" : "xxx",
  "permissions" : [ ],
  "share_file_path" : "/a/b/c/",
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "share_name" : "new_share",
  "status" : "enabled",
  "updated_at" : "2006-01-02T15:04:05.999Z"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

列举共享

POST /v2/osspath/share/list

说明

列举指定用户的共享

Body参数

请求参数

名称 : 列举共享请求标志 : 必填类型 : ListShareRequest

响应

标签

• share

HTTP请求示例

请求 path

/v2/osspath/share/list

请求 body

{
  "creator" : "abc",
  "limit" : 50,
  "marker" : "string",
  "owner" : "edf"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 500

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

响应 503

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

修改共享

POST /v2/osspath/share/update

说明

修改指定共享

Body参数

请求参数

名称 : 修改共享请求标志 : 必填类型 : UpdateShareRequest

响应

标签

• share

HTTP请求示例

请求 path

/v2/osspath/share/update

请求 body

{
  "description" : "share description",
  "expiration" : "2006-01-02T15:04:05.999Z",
  "permissions" : [ ],
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "share_name" : "new_share_name",
  "status" : "enabled"
}

HTTP响应示例

响应 200

{
  "created_at" : "2006-01-02T15:04:05.999Z",
  "creator" : "xxx",
  "description" : "share description",
  "domain_id" : "domain-1",
  "drive_id" : "1",
  "expiration" : "2006-01-02T15:04:05.999Z",
  "expired" : false,
  "owner" : "xxx",
  "permissions" : [ ],
  "share_file_path" : "/a/b/c/",
  "share_id" : "3d336314-63c8-4d96-bce0-17aefb6833b6",
  "share_name" : "new_share",
  "status" : "enabled",
  "updated_at" : "2006-01-02T15:04:05.999Z"
}

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

列举store

POST /v2/osspath/store/list

说明

列举指定Domain下的store列表。

Body参数

请求参数

名称 : 列举store请求标志 : 必填类型 : ListStorageRequest

响应

标签

• store

HTTP请求示例

请求 path

/v2/osspath/store/list

请求 body

{
  "domain_id" : "10"
}

HTTP响应示例

响应 200

{
  "items" : [ ]
}

响应 400

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

响应 403

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

响应 500

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

响应 503

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

列举store_file

POST /v2/osspath/store_file/list

说明

列举指定store下的所有文件。

Body参数

请求参数

名称 : 列举store下文件请求标志 : 必填类型 : ListStorageFileRequest

响应

标签

• store

HTTP请求示例

请求 path

/v2/osspath/store_file/list

请求 body

{
  "limit" : 50,
  "marker" : "string",
  "parent_file_path" : "string",
  "store_id" : "xxx",
  "type" : "file"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

创建Drive

POST /v2/drive/create

说明

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

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/create

请求 body

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

HTTP响应示例

响应 201

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

响应 400

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

响应 403

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

响应 500

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

响应 503

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

删除Drive

POST /v2/drive/delete

说明

删除指定drive_id对应的Drive

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/delete

请求 body

{
  "drive_id" : "123"
}

HTTP响应示例

响应 400

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

响应 403

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

响应 500

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

响应 503

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

获取Drive详细信息

POST /v2/drive/get

说明

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

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/get

请求 body

{
  "drive_id" : "123"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

获取默认Drive信息

POST /v2/drive/get_default_drive

说明

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

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/get_default_drive

请求 body

{
  "user_id" : "abc"
}

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

列举指定用户Drive

POST /v2/drive/list

说明

管理员列举指定用户的Drive

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/list

请求 body

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

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 500

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

响应 503

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

列举当前用户的Drive

POST /v2/drive/list_my_drives

说明

列举当前用户（访问令牌）的Drive

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/list_my_drives

请求 body

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

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 500

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

响应 503

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

更新Drive信息

POST /v2/drive/update

说明

更新指定drive_id的Drive信息

Body参数

请求参数

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

响应

标签

• drive

HTTP请求示例

请求 path

/v2/drive/update

请求 body

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

HTTP响应示例

响应 200

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

响应 400

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

定义

APIError

APIError is api error common struct

AlreadyExistError

AlreadyExistError 已经存在错误

BasePDSFileResponse

Base file response

BaseCompleteFileRequest

complete file request

BaseCreateFileRequest

create file request

BaseDriveResponse

Base drive response

BaseGetUploadUrlRequest

获取文件上传URL

BaseListFileRequest

list file request

BaseMoveFileRequest

文件移动请求

BaseOSSFileResponse

Base file response

BaseShareResponse

List share response

BatchSubRequest

BatchSubResponse

PDSBatchRequest

批处理

PDSBatchResponse

batch operation response

PDSCompleteFileRequest

合并文件上传任务

多态性 : 成分

PDSCompleteFileResponse

complete file response

多态性 : 成分

PDSCopyFileRequest

文件拷贝

PDSCopyFileResponse

文件拷贝 response

PDSCreateFileRequest

创建文件

多态性 : 成分

PDSCreateFileResponse

Create file response

PDSDeleteFileRequest

删除文件请求

PDSDeleteFileResponse

删除文件 response

PDSDeleteFilesRequest

批量删除文件请求

PDSDeleteFilesResponse

批量删除文件 response

PDSGetAsyncTaskRequest

获取异步人去信息

PDSGetAsyncTaskResponse

Get AsyncTask Response

PDSGetDownloadUrlRequest

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

PDSGetDownloadUrlResponse

获取download url response

PDSGetFileRequest

获取文件元数据

PDSGetFileResponse

获取文件元数据response

多态性 : 成分

PDSGetUploadUrlRequest

获取文件上传URL

多态性 : 成分

PDSGetUploadUrlResponse

Get UploadUrl Response

PDSListFileRequest

列举文件

多态性 : 成分

PDSListFileResponse

List file response

PDSListUploadedPartRequest

列举uploadID对应的已上传分片

PDSListUploadedPartResponse

获取签名 response

PDSMoveFileRequest

文件移动请求

多态性 : 成分

PDSMoveFileResponse

文件移动 response

PDSSearchFileRequest

搜索文件元数据

PDSSearchFileResponse

search file response

PDSUpdateFileMetaRequest

更新文件元数据

PDSUpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

CompleteFileRequest

complete file request

CopyFileRequest

copy file request

CreateDriveRequest

create drive request