全部产品

图像操作API

更新时间:2020-09-10 17:14:12

概览

Image API

版本信息

版本 : 2.0.0

URI scheme

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

请求Content-Type

  • application/json

返回Content-Type

  • application/json

API

列举人脸分组

  1. POST /v2/image/list_face_groups

说明

该接口将会列举人脸分组

Body参数

人脸分组列表请求参数

名称 : 获取人脸分组列表请求标志 : 必填类型 : ListImageFaceGroupsRequest

响应

HTTP代码 说明 类型
200 Success ListImageFaceGroupsResponse
400 1. InvalidParameterError:请求参数不正确 2. InvalidRequestJSONFormatError 请求JSON格式错误 InvalidParameterError
403 1.ForbiddenNoPermissionError 没有人脸分组接口权限 ForbiddenNoPermissionError
404 drive 没找到 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/list_face_groups
请求 body
  1. {
  2. "drive_id" : "123",
  3. "limit" : 10,
  4. "marker" : "marker"
  5. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "created_at" : "2019-02-20T09:35:51.057Z",
  4. "face_count" : 2,
  5. "group_cover_url" : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx",
  6. "group_id" : "abc",
  7. "group_name" : "abc",
  8. "updated_at" : "2019-02-20T09:35:51.057Z"
  9. } ],
  10. "next_marker" : "string"
  11. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

列举场景标记

  1. POST /v2/image/list_tags

说明

该接口将会展示场景标记

Body参数

获取图片标签列表的请求参数

名称 : 获取图片标签列表请求标志 : 必填类型 : ListImageTagsRequest

响应

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/list_tags
请求 body
  1. {
  2. "drive_id" : "123",
  3. "image_thumbnail_process" : "image/resize,w_200"
  4. }

HTTP响应示例

响应 200
  1. {
  2. "tags" : [ {
  3. "count" : 1,
  4. "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
  5. "name" : "篮球"
  6. } ]
  7. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

定义

APIError

APIError is api error common struct

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

AlreadyExistError

AlreadyExistError 已经存在错误

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

BasePDSFileResponse

Base file response

名称 说明 类型
category
可选
category
样例 : "doc"
enum (doc, image, audio, video)
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
image_media_metadata
可选
样例 : "[imagemediaresponse](#imagemediaresponse)" ImageMediaResponse
labels
可选
labels
样例 : [ "label1:1", "label2:2" ]
< string > array
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

BaseDriveResponse

Base drive response

名称 说明 类型
creator
可选
Drive 创建者
样例 : "pds"
string
description
可选
Drive 备注信息
样例 : "pds team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "pdsdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "pds"
string
relative_path
可选
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回
样例 : "/a/b/e/"
string
status
可选
Drive 状态
样例 : "enabled"
string
store_id
可选
存储 ID, domain的PathType为OSSPath时返回
样例 : "123"
string
total_size
可选
Drive 空间总量
样例 : 102400
integer (int64)
used_size
可选
Drive 空间已使用量
样例 : 1024
integer (int64)

BaseOSSFileResponse

Base file response

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

BaseShareResponse

List share response

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

BatchSubResponse

名称 说明 类型
body
可选
body 子请求的返回结果,可参考对于子请求文档 json 字符串
样例 : {<br> "drive_id" : "101",<br> "file_id" : "xxxxxx"<br>}
< string, object > map
id
可选
id 请求带过来的id, 可以跟 request 进行关联
样例 : "\"1\""
string
status
可选
status 子请求的返回状态码,可参考对于子请求文档
样例 : 200
integer (int64)

PDSBatchResponse

batch operation response

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

PDSCompleteFileResponse

complete file response

多态性 : 成分

名称 说明 类型
category
可选
category
样例 : "doc"
enum (doc, image, audio, video)
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc
可选
crc
样例 : "string"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
image_media_metadata
可选
样例 : "[imagemediaresponse](#imagemediaresponse)" ImageMediaResponse
labels
可选
labels
样例 : [ "label1:1", "label2:2" ]
< string > array
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

PDSCopyFileResponse

文件拷贝 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string

PDSCreateFileResponse

Create file response

名称 说明 类型
domain_id
可选
domain_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "domain"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d79206586bb5dd69fb34c349282718146c55da7"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
part_info_list
可选
part_info_list
样例 : "["
< UploadPartInfo > array
rapid_upload
可选
rapid_upload
type: boolean
样例 : false
boolean
type
可选
type
样例 : "file"
enum (file, folder)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string

PDSDeleteFileResponse

删除文件 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string

PDSDeleteFilesResponse

批量删除文件 response

名称 说明 类型
deleted_file_id_list
可选
deleted_file_id_list
样例 : [ ]
< string > array
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string

PDSGetAsyncTaskResponse

Get AsyncTask Response

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

PDSGetDownloadUrlResponse

获取download url response

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

PDSGetFileResponse

获取文件元数据response

多态性 : 成分

名称 说明 类型
category
可选
category
样例 : "doc"
enum (doc, image, audio, video)
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
image_media_metadata
可选
样例 : "[imagemediaresponse](#imagemediaresponse)" ImageMediaResponse
labels
可选
labels
样例 : [ "label1:1", "label2:2" ]
< string > array
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

PDSGetUploadUrlResponse

Get UploadUrl Response

名称 说明 类型
create_at
可选
created_at
样例 : "2019-09-11T16:34:36.977Z"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
part_info_list
可选
part_info_list
样例 : [ ]
< UploadPartInfo > array
upload_id
可选
upload_id
样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"
string

PDSListFileResponse

List file response

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

PDSListUploadedPartResponse

获取签名 response

名称 说明 类型
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
next_part_number_marker
可选
next_part_number_marker
样例 : "4"
string
upload_id
可选
upload_id
样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"
string
uploaded_parts
可选
uploaded_parts
样例 : [ ]
< UploadPartInfo > array

PDSMoveFileResponse

文件移动 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string

PDSSearchFileResponse

search file response

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

PDSUpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

名称 说明 类型
category
可选
category
样例 : "doc"
enum (doc, image, audio, video)
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
DomainID
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_id
可选
file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
hidden
可选
Hidden
type: boolean
样例 : false
boolean
image_media_metadata
可选
样例 : "[imagemediaresponse](#imagemediaresponse)" ImageMediaResponse
labels
可选
labels
样例 : [ "label1:1", "label2:2" ]
< string > array
meta
可选
meta
样例 : "file meta"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_id
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "root"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
starred
可选
starred
type: boolean
样例 : false
boolean
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

Captcha

名称 说明 类型
captcha
必填
图片验证码,base64格式
样例 : "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABRElEQVR42t3YsQ4CIQwA0CZ+i36Bg5uTo1/gqquDTvf1JwkJqRR7vZYCJ2HClOMBVw5h/i7P9yvU+X8LFFsju728wRNhcQR+gyj27G2GtQGHxy5USaN6PV1n2Qt8Ou6ZKllPJ/MQ4PN0CzXrs9i4jS2dIelKMuBse18vd1zdweHZdnC2V3kwDsm0OnYHMDVLtnQICbZ0XuIpqAamaaMjmGbvOAV0Fmqew7XAmXlV0kqButcYhDs5PqYiGA9dDm6atCK7bpbGx5Jknxszlj5pYR5t8QMX8b5gLMSVCZGfw4svdtHsDqZmPooHJxte5NTCnx3twKvKIhgLcaXrSbP0iGBhIK/99aXlnrQst1/7BajDt7Txxl/rrqvuBOaGJY3Szt4GOBuoka2LhQYw/ic1eyww/5eV95x229IDmqHlS1vdrOjkA5iK2BYUhM2zAAAAAElFTkSuQmCC"
string
captcha_format
必填
图片格式
样例 : "png"
string
captcha_id
必填
图片验证码ID
样例 : "f4690fc255e2fb24c10ede079d3802b4cClRimRh67Q"
string

CreateDriveResponse

Create drive response

名称 说明 类型
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string

CreateShareResponse

Create share response

名称 说明 类型
domain_id
可选
domain_id
样例 : "domain-1"
string
share_id
可选
share_id
样例 : "3d336314-63c8-4d96-bce0-17aefb6833b6"
string

DeleteDriveResponse

delete drive response

类型 : object

DriveRelativePathNestedError

DriveRelativePathNestedError 路径嵌套错误

名称 说明 类型
code
必填
样例 : "DriveRelativePathNested" string
message
必填
样例 : "the parameter relative_path nested inside of another relative_path: {path}." string

ForbiddenAccountInDebtError

ForbiddenAccountInDebtError 账号欠费错误

名称 说明 类型
code
必填
样例 : "ForbiddenAccountInDebt" string
message
必填
样例 : "The specified account is in debt." string

ForbiddenAccountNotFoundError

ForbiddenAccountNotFoundError 账号没找到错误

名称 说明 类型
code
必填
样例 : "ForbiddenAccountNotFound" string
message
必填
样例 : "The specified account does not exist." string

ForbiddenError

ForbiddenError 被禁止错误

名称 说明 类型
code
必填
样例 : "Forbidden" string
message
必填
样例 : "User not authorized to operate on the specified APIs." string

ForbiddenNoPermissionError

ForbiddenNoPermissionError 没有权限错误

名称 说明 类型
code
必填
样例 : "ForbiddenNoPermission" string
message
必填
样例 : "No Permission to access resource {resource_name}." string

ForbiddenRiskControlError

ForbiddenRiskControlError 风险控制禁止访问错误

名称 说明 类型
code
必填
样例 : "ForbiddenRiskControl" string
message
必填
样例 : "This operation is forbidden by Alibaba Cloud RiskControl system." string

ForbiddenServiceRoleError

ForbiddenServiceRoleError 服务角色禁止访问错误

名称 说明 类型
code
必填
样例 : "ForbiddenServiceRole" string
message
必填
样例 : "Cannot access specified service role." string

GetDriveResponse

Get drive response

名称 说明 类型
creator
可选
Drive 创建者
样例 : "pds"
string
description
可选
Drive 备注信息
样例 : "pds team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "pdsdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "pds"
string
relative_path
可选
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回
样例 : "/a/b/e/"
string
status
可选
Drive 状态
样例 : "enabled"
string
store_id
可选
存储 ID, domain的PathType为OSSPath时返回
样例 : "123"
string
total_size
可选
Drive 空间总量
样例 : 102400
integer (int64)
used_size
可选
Drive 空间已使用量
样例 : 1024
integer (int64)

GetShareResponse

Get share response

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

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

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

ImageMediaResponse

名称 说明 类型
height
可选
height
默认值 : 0
样例 : 720
integer (int64)
time
可选
time
样例 : "string"
string (date-time)
width
可选
width
默认值 : 0
样例 : 1024
integer (int64)

IncorrectStatusError

IncorrectStatusError 状态不正确错误

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

InternalErrorError

InternalErrorError 内部错误

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

InvalidHeaderError

InvalidHeaderError 请求头不合法错误

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

InvalidParameterEmptyError

InvalidParameterEmptyError 参数为空错误

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

InvalidParameterError

InvalidParameterError 参数非法错误

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

InvalidParameterExpiredError

InvalidParameterExpiredError 参数已经过期错误

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

InvalidParameterMissingError

InvalidParameterMissingError 参数缺失

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

InvalidParameterNotMatchError

InvalidParameterNotMatchError 参数不匹配错误

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

InvalidParameterNotSupportedError

InvalidParameterNotSupportedError 参数不支持错误

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

InvalidParameterOutOfRangeError

InvalidParameterOutOfRangeError 参数超过范围错误

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

InvalidParameterWrongFormatError

InvalidParameterWrongFormatError 参数格式错误

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

InvalidRequestJSONFormatError

InvalidRequestJSONFormatError 请求JSON格式错误

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

InvalidResourceError

InvalidResourceError 非法资源错误

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

InvalidResourceIsEmptyError

InvalidResourceIsEmptyError 资源为空错误

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

InvalidResourceUnsupportedError

InvalidResourceUnsupportedError 资源不支持错误

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

ListDriveResponse

list drive response

名称 说明 类型
items
可选
Drive 列表
样例 : [ "[basedriveresponse](#basedriveresponse)" ]
< BaseDriveResponse > array
next_marker
可选
翻页标记
样例 : "marker"
string

ListFaceGroupImagesRequest

List face group images request

名称 说明 类型
drive_id
必填
Drive ID
样例 : "123"
string
face_group_id
必填
人脸分组 ID
样例 : "abc"
string
image_thumbnail_process
可选
缩略图处理
样例 : "image/resize,m_fill,h_128,w_128,limit_0"
string
image_url_process
可选
图片处理
样例 : "image/resize,m_fill,h_128,w_128,limit_0"
string
limit
可选
每页大小限制
默认值 : 100
最小值 : 1
最大值 : 100
样例 : 10
integer (int64)
marker
可选
翻页标记
样例 : "marker"
string

ListFaceGroupImagesResponse

按照人脸分组展示照片集合

名称 说明 类型
items
可选
样例 : [ "[imageresponse](#imageresponse)" ] < imageResponse > array
next_marker
可选
样例 : "string" string

ListImageFaceGroupsRequest

List image face groups request

名称 说明 类型
drive_id
必填
Drive ID
样例 : "123"
string
limit
可选
每页大小限制
默认值 : 100
最小值 : 1
最大值 : 100
样例 : 10
integer (int64)
marker
可选
翻页标记
样例 : "marker"
string

ListImageFaceGroupsResponse

展示人脸分组集合

名称 说明 类型
items
可选
样例 : [ "[imagefacegroupresponse](#imagefacegroupresponse)" ] < imageFaceGroupResponse > array
next_marker
可选
样例 : "string" string

ListImageTagsRequest

List image tags request

名称 说明 类型
drive_id
必填
Drive ID
样例 : "123"
string
image_thumbnail_process
可选
image_thumbnail_process
type:string
样例 : "image/resize,w_200"
string

ListImageTagsResponse

展示标签集合

名称 说明 类型
tags
可选
样例 : [ "[imagetagresponse](#imagetagresponse)" ] < imageTagResponse > array

ListShareResponse

List share response

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

ListStorageFileResponse

List storage file

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

ListStorageResponse

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

OSSCompleteFileResponse

complete file response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc
可选
crc
样例 : "string"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

OSSCopyFileResponse

文件拷贝 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z-]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
drive_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string

OSSCreateFileResponse

Create file response

名称 说明 类型
domain_id
可选
domain_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "domain"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
part_info_list
可选
part_info_list
样例 : "["
< UploadPartInfo > array
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "1"
string
type
可选
type
样例 : "file"
enum (file, folder)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string

OSSDeleteFileResponse

删除文件 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
share_id
模式 : "[a-z0-9A-Z]+"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string

OSSDeleteFilesResponse

批量删除文件 response

名称 说明 类型
deleted_file_id_list
可选
deleted_file_id_list
样例 : [ ]
< string > array
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "1"
string

OSSGetDownloadUrlResponse

获取download url response

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

OSSGetFileResponse

获取文件元数据response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

OSSGetUploadUrlResponse

Get UploadUrl Response

名称 说明 类型
create_at
可选
created_at
样例 : "2019-09-11T16:34:36.977Z"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
part_info_list
可选
part_info_list
样例 : [ ]
< UploadPartInfo > array
upload_id
可选
upload_id
样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"
string

OSSListFileResponse

List file response

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

OSSListUploadedPartResponse

获取签名 response

名称 说明 类型
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
next_part_number_marker
可选
next_part_number_marker
样例 : "4"
string
upload_id
可选
upload_id
样例 : "F3C25CDFA5C74ECB8DE32672F6211FD4"
string
uploaded_parts
可选
uploaded_parts
样例 : [ ]
< UploadPartInfo > array

OSSMoveFileResponse

文件移动 response

名称 说明 类型
async_task_id
可选
async_task_id
样例 : "000e89fb-cf8f-11e9-8ab4-b6e980803a3b"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z-]+"
样例 : "test001"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_path
可选
file_path
样例 : "/a/b/c.jpg"
string
share_id
可选
drive_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string

OSSSearchFileResponse

search file response

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

OSSUpdateFileMetaResponse

更新文件元数据 response

多态性 : 成分

名称 说明 类型
content_hash
可选
Content Hash
样例 : "EA4942AA8761213890A5C386F88E6464D2C31CA3"
string
content_hash_name
可选
content_hash_name
样例 : "sha1"
enum (sha1)
content_type
可选
content_type
样例 : "application/json"
string
crc64_hash
可选
crc64_hash
样例 : "string"
string
created_at
可选
created_at
样例 : "2019-08-20T06:51:27.292Z"
string
description
可选
description
样例 : "file description"
string
domain_id
可选
domain_id
模式 : "[a-z0-9A-Z]+"
样例 : "test001"
string
download_url
可选
download_url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
drive_id
可选
drive_id
模式 : "[0-9]+"
样例 : "1"
string
file_extension
可选
file_extension
样例 : "jpg"
string
file_path
可选
file_path
样例 : "/a.jpg"
string
name
必填
name
模式 : "[a-zA-Z0-9.-]{1,1024}"
样例 : "pds.jpg"
string
parent_file_path
可选
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "/"
string
share_id
可选
share_id
模式 : "[0-9]+"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
size
可选
Size
最小值 : 0
最大值 : 53687091200
样例 : 1024
integer (int64)
status
可选
status
样例 : "available"
enum (uploading, available)
thumbnail
可选
thumbnail
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string
trashed_at
可选
trashed_at
样例 : "string"
string (date-time)
type
可选
type
样例 : "file"
enum (file, folder)
updated_at
可选
updated_at
样例 : "string"
string (date-time)
upload_id
可选
upload_id
样例 : "C9DCFE5A82644AC7A02DB74C30C934A6"
string
url
可选
url
样例 : "https://pds.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"
string

PreHashCheckSuccessResponse

Pre hash check Response

名称 说明 类型
code
可选
code
样例 : "string"
string
file_name
可选
file_name
样例 : "string"
string
message
可选
message
样例 : "string"
string
parent_file_id
必填
parent_file_id
长度 : 40 - 50
模式 : "[a-z0-9]{1, 50}"
样例 : "5d5b846942cf94fa72324c14a4bda34e81da635d"
string
pre_hash
可选
pre_hash
样例 : "string"
string

QuotaExhaustedError

QuotaExhaustedError 超出配额错误

名称 说明 类型
code
必填
样例 : "QuotaExhausted" string
message
必填
样例 : "The resource {resource_name} has exceeded the limit." string

ReadBodyErrorError

ReadBodyErrorError 读取Body错误

名称 说明 类型
code
必填
样例 : "ReadBodyError" string
message
必填
样例 : "Read body error." string

ServiceUnavailableError

ServiceUnavailableError 服务不可用错误

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

Sha1ConflictError

Sha1ConflictError Sha1冲突错误

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

SignatureDoesNotMatchError

SignatureDoesNotMatchError 签名不匹配错误

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

StateConflictError

StateConflictError 状态冲突错误

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

StoreFile

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

StoreItemResponse

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

ThrottlingError

ThrottlingError 操作被流控错误

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

UpdateDriveResponse

Update drive response

名称 说明 类型
creator
可选
Drive 创建者
样例 : "pds"
string
description
可选
Drive 备注信息
样例 : "pds team drive"
string
domain_id
可选
Domain ID
样例 : "hz999"
string
drive_id
可选
Drive ID
样例 : "123"
string
drive_name
可选
Drive 名称
样例 : "pdsdrive"
string
drive_type
可选
Drive 类型
样例 : "normal"
string
owner
可选
Drive 所有者
样例 : "pds"
string
relative_path
可选
Drive存储基于store的相对路径,domain的PathType为OSSPath时返回
样例 : "/a/b/e/"
string
status
可选
Drive 状态
样例 : "enabled"
string
store_id
可选
存储 ID, domain的PathType为OSSPath时返回
样例 : "123"
string
total_size
可选
Drive 空间总量
样例 : 102400
integer (int64)
used_size
可选
Drive 空间已使用量
样例 : 1024
integer (int64)

UpdateShareResponse

Update share response

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

UploadPartInfo

名称 说明 类型
etag
可选
etag
样例 : "0CC175B9C0F1B6A831C399E269772661"
string
part_number
可选
PartNumber
最小值 : 10000
最大值 : 1
样例 : 1
integer (int64)
part_size
可选
PartSize:
最小值 : 102400
最大值 : 5368709120
样例 : 1024
integer (int64)
upload_url
可选
upload_url
样例 : "https://pds.data.aliyuncs.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661"
string

UserAuthentication

名称 说明 类型
AuthenticationType
必填
认证类型
样例 : "mobile"
string
CreatedAt
必填
创建时间
样例 : 1556163159820
integer (int64)
Detail
必填
详情
样例 : "{name:abc}"
string
DomainID
必填
Domain ID
样例 : "5000"
string
Identity
必填
唯一身份标识
样例 : "15208345000"
string
LastLoginTime
必填
最后登录时间
样例 : 1556163159820
integer (int64)
Status
必填
状态
样例 : "normal"
string
UserID
必填
用户ID
样例 : "00016a587b62b50003deea299a4f5b50"
string

imageFaceGroupResponse

名称 说明 类型
created_at
可选
人脸分组生成时间
样例 : "2019-02-20T09:35:51.057Z"
string
face_count
可选
人脸个数
样例 : 2
integer (int64)
group_cover_url
可选
人脸分组封面头像地址
样例 : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx"
string
group_id
可选
人脸分组 ID
样例 : "abc"
string
group_name
可选
人脸分组名称
样例 : "abc"
string
updated_at
可选
人脸分组修改时间
样例 : "2019-02-20T09:35:51.057Z"
string

imageResponse

名称 说明 类型
created_at
可选
图片生成时间
样例 : "2019-02-20T09:35:51.057Z"
string
download_url
可选
下载地址
样例 : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx"
string
drive_id
可选
Drive ID
样例 : "123"
string
file_id
可选
文件 ID
样例 : "abc"
string
file_name
可选
文件 名称
样例 : "test.jpg"
string
image_time
可选
图片拍摄时间
样例 : "2019-02-20T09:35:51.057Z"
string
thumbnail
可选
缩略图地址
样例 : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx"
string
url
可选
原图地址
样例 : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx"
string

imageTagResponse

名称 说明 类型
count
可选
标签计数
样例 : 1
integer (int64)
cover_url
可选
封面图片地址
样例 : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx"
string
name
可选
标签名称
样例 : "篮球"
string