概览

Image API

版本信息

版本 : 2.0.0

URI scheme

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

基础路径 : /v2

方案 : HTTP, HTTPS

请求

application/json

application/json

API

1.标签

1.1 列举场景标记

POST /v2/image/list_tags

说明

该接口将会展示场景标记

Body参数

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

名称 : list_tags标志 : 必填类型 : ListImageTagsRequest

响应

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

HTTP请求示例

请求 path

/v2/image/list_tags

请求 body

{
  "drive_id" : "123",
  "image_thumbnail_process" : "image/resize,w_200",
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "tags" : [ {
    "count" : 1,
    "cover_file_id" : "string",
    "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
    "name" : "篮球"
  } ]
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

2.人脸

2.1 列举人脸分组

POST /v2/image/list_facegroups

说明

该接口将会列举人脸分组

Body参数

人脸分组列表请求参数

名称 : list_facegroups标志 : 必填类型 : ListImageFaceGroupsRequest

响应

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

HTTP请求示例

请求 path

/v2/image/list_facegroups

请求 body

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

HTTP响应示例

响应 200

{
  "items" : [ {
    "cover_file_id" : "string",
    "created_at" : "2019-02-20T09:35:51.057Z",
    "face_count" : 2,
    "group_cover_url" : "http://imm-dev-wmt/facegroup/05.jpg?x-oss-process=xxx",
    "group_id" : "abc",
    "group_name" : "abc",
    "image_count" : 2,
    "updated_at" : "2019-02-20T09:35:51.057Z"
  } ],
  "next_marker" : "string"
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

2.2 更新人脸分组信息

POST /v2/image/update_facegroup_info

说明

该接口将会更新人脸分组信息

Body参数

更新人脸分组信息请求参数

名称 : update_facegroup_info标志 : 必填类型 : UpdateFaceGroupInfoRequest

响应

HTTP代码	说明	类型
200	Success	UpdateFaceGroupInfoResponse
400	1. InvalidParameter.DriveId 2. InvalidParameter.GroupID 3. InvalidRequestJSONFormatError 请求JSON格式错误	InvalidParameterError
401	AccessTokenInvalid	AccessTokenInvalidError
403	1.ForbiddenNoPermissionError 没有更新人脸分组信息接口权限	ForbiddenNoPermissionError
404	drive 没找到	NotFoundError
500	服务内部故障	InternalErrorError
503	服务临时不可用	ServiceUnavailableError

HTTP请求示例

请求 path

/v2/image/update_facegroup_info

请求 body

{
  "drive_id" : "\"101\"",
  "group_id" : "\"group-asdasdasdeop\"",
  "group_name" : "\"张XX\""
}

HTTP响应示例

响应 200

{
  "drive_id" : "\"101\"",
  "group_id" : "\"group-aas11002ddeac\""
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

3.地点

3.1列举地点分组

POST /v2/image/list_address_groups

说明

该接口将会展示用户图片的地点分组

Body参数

获取图片地点分组列表的请求参数

名称 : list_address_groups标志 : 必填类型 : ListImageAddressGroupsRequest

响应

HTTP代码	说明	类型
200	获取图片地点分组列表成功	ListImageAddressGroupsResponse
400	1. InvalidParameter.DriveId 2. InvalidParameter.Limit 3. InvalidRequestJSONFormatError 请求JSON格式错误	InvalidParameterError
401	AccessTokenInvalid	AccessTokenInvalidError
403	1.ForbiddenNoPermissionError 没有图片地点分组接口权限	ForbiddenNoPermissionError
404	drive 没找到	NotFoundError
500	服务内部故障	InternalErrorError
503	服务临时不可用	ServiceUnavailableError

HTTP请求示例

请求 path

/v2/image/list_address_groups

请求 body

{
  "drive_id" : "123",
  "image_thumbnail_process" : "image/resize,w_200",
  "limit" : 10,
  "marker" : "marker",
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "items" : [ {
    "address_detail" : {
      "city" : "string",
      "country" : "string",
      "district" : "string",
      "province" : "string",
      "township" : "string"
    },
    "count" : 1,
    "cover_file_id" : "string",
    "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
    "location" : "39.21211,101.32111",
    "name" : "杭州"
  } ],
  "next_marker" : "string"
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

3.2 查询地点分组信息

POST /v2/image/search_address_groups

说明

该接口将会展示用户图片的地点分组

Body参数

获取图片地点分组信息的请求参数

名称 : search_address_groups标志 : 必填类型 : SearchImageAddressGroupsRequest

响应

HTTP代码	说明	类型
200	获取图片地点分组信息成功	SearchImageAddressGroupsResponse
400	1. InvalidParameter.DriveID 2. InvalidParameter.AddressNames 3. InvalidParameter.AddressLevel 4. InvalidRequestJSONFormatError 请求JSON格式错误	InvalidParameterError
401	AccessTokenInvalid	AccessTokenInvalidError
403	1.ForbiddenNoPermissionError 没有查询图片地点分组信息接口权限	ForbiddenNoPermissionError
404	drive 没找到	NotFoundError
500	服务内部故障	InternalErrorError
503	服务临时不可用	ServiceUnavailableError

HTTP请求示例

请求 path

/v2/image/search_address_groups

请求 body

{
  "address_level" : "city",
  "address_names" : [ "杭州市", "北京市" ],
  "br_geo_point" : "39.121,101.2121",
  "drive_id" : "123",
  "image_thumbnail_process" : "image/resize,w_200",
  "tl_geo_point" : "39.121,101.2121",
  "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
}

HTTP响应示例

响应 200

{
  "items" : [ {
    "address_detail" : {
      "city" : "string",
      "country" : "string",
      "district" : "string",
      "province" : "string",
      "township" : "string"
    },
    "count" : 1,
    "cover_file_id" : "string",
    "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
    "location" : "39.21211,101.32111",
    "name" : "杭州"
  } ]
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

4.AI语义解析

4.1 语义解析出标签，地点，时间

POST /v2/image/parse_keywords

说明

该接口将会对用户输入内容语义解析出标签，地点，时间

Body参数

语义解析请求参数

名称 : parse_keywords标志 : 必填类型 : ParseKeywordsRequest

响应

HTTP代码	说明	类型
200	Success	ParseKeywordsResponse
400	1. InvalidRequestJSONFormatError 请求JSON格式错误	InvalidParameterError
401	AccessTokenInvalid	AccessTokenInvalidError
403	1.ForbiddenNoPermissionError 没有语义解析接口权限	ForbiddenNoPermissionError
500	服务内部故障	InternalErrorError
503	服务临时不可用	ServiceUnavailableError

HTTP请求示例

请求 path

/v2/image/parse_keywords

请求 body

{
  "keywords" : "string"
}

HTTP响应示例

响应 200

{
  "address_line" : "string",
  "tags" : [ {
    "confidence" : 0.0,
    "en_name" : "string",
    "name" : "string",
    "parent_en_name" : "string",
    "parent_name" : "string",
    "selected" : true,
    "source" : "string",
    "tag_level" : 0
  } ],
  "time_range" : {
    "end" : "string",
    "start" : "string"
  }
}

响应 400

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

响应 401

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

响应 403

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

响应 500

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

响应 503

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

5.查询云照片个数

POST /v2/image/get_photo_count

说明

该接口将返回用户Drive下的云照片个数

Body参数

获取用户Drive下的云照片个数的请求参数

名称 : get_photo_count标志 : 必填类型 : GetImageCountRequest

响应

HTTP代码	说明	类型
200	获取用户Drive下的云照片个数成功	GetImageCountResponse
400	1. InvalidParameter.DriveId 2. InvalidRequestJSONFormatError 请求JSON格式错误	InvalidParameterError
401	AccessTokenInvalid	AccessTokenInvalidError
403	1.ForbiddenNoPermissionError 没有/image/get_photo_count接口权限	ForbiddenNoPermissionError
404	drive 没找到	NotFoundError
500	服务内部故障	InternalErrorError
503	服务临时不可用	ServiceUnavailableError

HTTP请求示例

请求 path

/v2/image/get_photo_count

请求 body

{
  "drive_id" : "1"
}

HTTP响应示例

响应 200

{
  "image_count" : 1
}

响应 400

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

响应 401

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

响应 403

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

响应 404

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

响应 500

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

响应 503

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

定义

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

Address

名称	说明	类型
city 可选	样例 : `"string"`	string
country 可选	样例 : `"string"`	string
district 可选	样例 : `"string"`	string
province 可选	样例 : `"string"`	string
township 可选	样例 : `"string"`	string

AlreadyExistError

AlreadyExistError 已经存在错误

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

AuthKeyInvalidError

AuthKeyInvalidError AuthKey无效

名称	说明	类型
code 必填	样例 : `"AuthKeyInvalid"`	string
message 必填	样例 : `"AuthKey is invalid. {message}"`	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)
characteristic_hash 可选	CharacteristicHash 样例 : `"string"`	string
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
punish_flag 可选	样例 : `"[punishflagtype](#punishflagtype)"`	PunishFlagType
size 可选	Size 最小值 : `0` 最大值 : `53687091200` 样例 : `1024`	integer (int64)
starred 可选	starred type: boolean 样例 : `false`	boolean
status 可选	status 样例 : `"available"`	enum (uploading, available)
streams_info 可选	@Deprecated streams url info 样例 : `{<br> "string" : "[streaminfo](#streaminfo)"<br>}`	< string, StreamInfo > 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
video_preview_metadata 可选	样例 : `"[videopreviewresponse](#videopreviewresponse)"`	VideoPreviewResponse

BaseFileAnonymousResponse

list_file_by_anonymous base response

名称	说明	类型
file_id 可选	file_id 长度 : `40 - 50` 模式 : `"[a-z0-9]{1,50}"` 样例 : `"5d5b846942cf94fa72324c14a4bda34e81da635d"`	string
name 可选	name 模式 : `"[a-zA-Z0-9.-]{1,1000}"` 样例 : `"ccp.jpg"`	string
size 可选	size, type=file时才有效最小值 : `0` 最大值 : `53687091200` 样例 : `1024`	integer (int64)
thumbnail 可选	thumbnail 样例 : `"https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"`	string
type 可选	type 样例 : `"file"`	enum (file, folder)
updated_at 可选	updated_at 样例 : `"string"`	string (date-time)

CroppingBoundary

名称	说明	类型
height 可选	样例 : `0`	integer (int64)
left 可选	样例 : `0`	integer (int64)
top 可选	样例 : `0`	integer (int64)
width 可选	样例 : `0`	integer (int64)

CroppingSuggestionItem

名称	说明	类型
aspect_ratio 可选	样例 : `"string"`	string
cropping_boundary 可选	样例 : `"[croppingboundary](#croppingboundary)"`	CroppingBoundary
score 可选	样例 : `0.0`	number (double)

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

GetImageCountRequest

Get photo count request

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

GetImageCountResponse

获取云照片个数结果

名称	说明	类型
image_count 可选	image_count 样例 : `1`	integer (int64)

HTTPMethodNotAllowedError

HTTPMethodNotAllowedError 内部错误

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

ImageAddressResponse

名称	说明	类型
address_detail 可选	样例 : `"[address](#address)"`	Address
count 可选	聚类地点计数样例 : `1`	integer (int64)
cover_file_id 可选	cover_file_id 样例 : `"string"`	string
cover_url 可选	聚类地点封面图片地址样例 : `"http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx"`	string
location 可选	经纬度样例 : `"39.21211,101.32111"`	string
name 可选	聚类地点名称样例 : `"杭州"`	string

ImageFaceGroupResponse

名称	说明	类型
cover_file_id 可选	cover_file_id 样例 : `"string"`	string
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
image_count 可选	照片个数样例 : `2`	integer (int64)
updated_at 可选	人脸分组修改时间样例 : `"2019-02-20T09:35:51.057Z"`	string

ImageMediaResponse

名称	说明	类型
address_line 可选	address_line 样例 : `"北京市昌平区白各庄新村路"`	string
city 可选	city 样例 : `"杭州"`	string
country 可选	country 样例 : `"中国"`	string
cropping_suggestion 可选	cropping_suggestion 样例 : `[ "[croppingsuggestionitem](#croppingsuggestionitem)" ]`	< CroppingSuggestionItem > array
district 可选	district 样例 : `"余杭区"`	string
exif 可选	exif json string 样例 : `"string"`	string
faces 可选	faces json string 样例 : `"string"`	string
height 可选	height 默认值 : `0` 样例 : `720`	integer (int64)
image_quality 可选	样例 : `"[imagequality](#imagequality)"`	ImageQuality
image_tags 可选	system_tags 样例 : `[ "[systemtag](#systemtag)" ]`	< SystemTag > array
location 可选	location 样例 : `"40.110333,116.349311"`	string
province 可选	province 样例 : `"浙江省"`	string
story_image_score 可选	story_image_score 样例 : `0.0`	number (double)
time 可选	time 样例 : `"string"`	string (date-time)
township 可选	township 样例 : `"沙河镇"`	string
width 可选	width 默认值 : `0` 样例 : `1024`	integer (int64)

ImageQuality

名称	说明	类型
clarity 可选	样例 : `0.0`	number (double)
clarity_score 可选	样例 : `0.0`	number (double)
color 可选	样例 : `0.0`	number (double)
color_score 可选	样例 : `0.0`	number (double)
composition_score 可选	样例 : `0.0`	number (double)
contrast 可选	样例 : `0.0`	number (double)
contrast_score 可选	样例 : `0.0`	number (double)
exposure 可选	样例 : `0.0`	number (double)
exposure_score 可选	样例 : `0.0`	number (double)
overall_score 可选	样例 : `0.0`	number (double)

ImageTagResponse

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

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

ListImageAddressGroupsRequest

List image address groups request

名称	说明	类型
drive_id 必填	Drive ID 样例 : `"123"`	string
image_thumbnail_process 可选	image_thumbnail_process 样例 : `"image/resize,w_200"`	string
limit 可选	每页大小限制默认值 : `100` 最小值 : `1` 最大值 : `100` 样例 : `10`	integer (int32)
marker 可选	翻页标记样例 : `"marker"`	string
video_thumbnail_process 可选	video_thumbnail_process 样例 : `"video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"`	string

ListImageAddressGroupsResponse

展示地点分组集合

名称	说明	类型
items 可选	样例 : `[ "[imageaddressresponse](#imageaddressresponse)" ]`	< ImageAddressResponse > 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 样例 : `"image/resize,w_200"`	string
video_thumbnail_process 可选	video_thumbnail_process type:string 样例 : `"video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"`	string

ListImageTagsResponse

展示标签集合

名称	说明	类型
tags 可选	样例 : `[ "[imagetagresponse](#imagetagresponse)" ]`	< ImageTagResponse > 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

OperationDeniedError

OperationDeniedError 拒绝此操作

名称	说明	类型
code 必填	样例 : `"OperationDenied"`	string
message 必填	样例 : `"Operation not permitted. {message}"`	string

OperationNotSupportError

OperationNotSupportError 不允许此操作

名称	说明	类型
code 必填	样例 : `"OperationNotSupport"`	string
message 必填	样例 : `"This operation is not supported. {message}"`	string

ParseKeywordsRequest

Parse keywords request

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

ParseKeywordsResponse

Parse keywords response

名称	说明	类型
address_line 可选	AddressLine 样例 : `"string"`	string
tags 可选	样例 : `[ "[systemtag](#systemtag)" ]`	< SystemTag > array
time_range 可选	样例 : `"[timerange](#timerange)"`	TimeRange

QuotaExhaustedError

QuotaExhaustedError 超出配额错误

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

RateLimit

下载限速配置

名称	说明	类型
part_size 可选	样例 : `0`	integer (int64)
part_speed 可选	样例 : `0`	integer (int64)

ReadBodyErrorError

ReadBodyErrorError 读取Body错误

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

SearchImageAddressGroupsRequest

Search image address groups request

名称	说明	类型
address_level 可选	查询的地点级别默认值 : `"city"` 样例 : `"city"`	string
address_names 可选	查询的地点数组样例 : `[ "杭州市", "北京市" ]`	< string > array
br_geo_point 可选	br_geo_point 样例 : `"39.121,101.2121"`	string
drive_id 必填	Drive ID 样例 : `"123"`	string
image_thumbnail_process 可选	image_thumbnail_process 样例 : `"image/resize,w_200"`	string
tl_geo_point 可选	tl_geo_point 样例 : `"39.121,101.2121"`	string
video_thumbnail_process 可选	video_thumbnail_process 样例 : `"video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"`	string

SearchImageAddressGroupsResponse

展示地点分组列表

名称	说明	类型
items 可选	样例 : `[ "[imageaddressresponse](#imageaddressresponse)" ]`	< ImageAddressResponse > array

ServerIsProcessingError

ServerIsProcessingError 服务器正在处理中

名称	说明	类型
code 必填	样例 : `"ServerIsProcessing"`	string
message 必填	样例 : `"Server is processing"`	string

ServiceUnavailableError

ServiceUnavailableError 服务不可用错误

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

SignatureDoesNotMatchError

SignatureDoesNotMatchError 签名不匹配错误

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

StateConflictError

StateConflictError 状态冲突错误

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

StreamInfo

名称	说明	类型
crc64_hash 可选	crc64_hash 样例 : `"string"`	string
download_url 可选	download_url 样例 : `"https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"`	string
size 可选	样例 : `0`	integer (int64)
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

StreamUploadInfo

名称	说明	类型
location 可选	location 样例 : `"string"`	string
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

SystemTag

名称	说明	类型
confidence 可选	样例 : `0.0`	number (double)
en_name 可选	样例 : `"string"`	string
name 可选	样例 : `"string"`	string
parent_en_name 可选	样例 : `"string"`	string
parent_name 可选	样例 : `"string"`	string
selected 可选	样例 : `true`	boolean
source 可选	样例 : `"string"`	string
tag_level 可选	样例 : `0`	integer (int64)

ThrottlingError

ThrottlingError 操作被流控错误

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

TimeRange

名称	说明	类型
end 可选	样例 : `"string"`	string
start 可选	样例 : `"string"`	string

TooManyRequestsError

TooManyRequestsError 请求过多，服务起繁忙

名称	说明	类型
code 必填	样例 : `"TooManyRequests"`	string
message 必填	样例 : `"Too many requests"`	string

UnSupportVideoFormatError

UnSupportVideoFormatError 不支持的视频格式

名称	说明	类型
code 必填	样例 : `"UnSupportVideoFormat"`	string
message 必填	样例 : `"UnSupport video format."`	string

UpdateFaceGroupInfoRequest

Update face group info request

名称	说明	类型
drive_id 必填	drive_id 模式 : `"[0-9]+"` 样例 : `"\"101\""`	string
group_id 必填	group_id 列举人脸分组接口中获取样例 : `"\"group-asdasdasdeop\""`	string
group_name 可选	group_name 样例 : `"\"张XX\""`	string

UpdateFaceGroupInfoResponse

更新人脸分组信息结果

名称	说明	类型
drive_id 可选	drive_id 样例 : `"\"101\""`	string
group_id 可选	group_id 样例 : `"\"group-aas11002ddeac\""`	string

VideoMediaAudioStream

名称	说明	类型
bit_rate 可选	bit_rate 音频比特率单位：bps 样例 : `"\"129280\""`	string
channel_layout 可选	channel_layout 声道布局样例 : `"\"5.1\", \"stereo\""`	string
channels 可选	channels 音频数/声道数样例 : `2`	integer (int64)
code_name 可选	code_name 音频编码模式样例 : `"\"aac\""`	string
duration 可选	duration 单位秒样例 : `"\"7704.573000\""`	string
sample_rate 可选	sample_rate 音频采样率样例 : `"\"48000\""`	string

VideoMediaResponse

名称	说明	类型
address_line 可选	address_line 样例 : `"北京市昌平区白各庄新村路"`	string
city 可选	city 样例 : `"杭州"`	string
country 可选	country 样例 : `"中国"`	string
district 可选	district 样例 : `"余杭区"`	string
duration 可选	duration 单位秒样例 : `"\"7704.573000\""`	string
height 可选	height 默认值 : `0` 样例 : `720`	integer (int64)
image_tags 可选	system_tags 样例 : `[ "[systemtag](#systemtag)" ]`	< SystemTag > array
location 可选	location 样例 : `"40.110333,116.349311"`	string
province 可选	province 样例 : `"浙江省"`	string
time 可选	time 样例 : `"string"`	string (date-time)
township 可选	township 样例 : `"沙河镇"`	string
video_media_audio_stream 可选	样例 : `[ "[videomediaaudiostream](#videomediaaudiostream)" ]`	< VideoMediaAudioStream > array
video_media_video_stream 可选	样例 : `[ "[videomediavideostream](#videomediavideostream)" ]`	< VideoMediaVideoStream > array
width 可选	width 默认值 : `0` 样例 : `1024`	integer (int64)

VideoMediaVideoStream

名称	说明	类型
bitrate 可选	bitrate 视频比特率单位：bps 样例 : `"\"108420\""`	string
clarity 可选	clarity 清晰度（扫描）样例 : `"\"1080P\""`	string
code_name 可选	code_name 视频编码模式样例 : `"\"h264\""`	string
duration 可选	duration 单位秒样例 : `"\"7704.573000\""`	string
fps 可选	fps 视频平均帧率样例 : `"\"25/1\""`	string

VideoPreviewAudioMeta

名称	说明	类型
bitrate 可选	bitrate 样例 : `349461.0`	number (double)
channels 可选	channels 样例 : `2`	integer (int64)
duration 可选	duration 样例 : `18.2`	number (double)
sample_rate 可选	sample_rate 样例 : `18.2`	number (double)

VideoPreviewAudioMusicMeta

名称	说明	类型
album 可选	album 样例 : `"\"范特西\""`	string
artist 可选	artist 样例 : `"\"周杰伦\""`	string
cover_url 可选	cover_url 样例 : `"https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"`	string
title 可选	title 样例 : `"\"爱在西元前\""`	string

VideoPreviewResponse

名称	说明	类型
audio_channels 可选	audio_channels 样例 : `2`	integer (int64)
audio_format 可选	audio_format 样例 : `"\"AAC\""`	string
audio_meta 可选	样例 : `"[videopreviewaudiometa](#videopreviewaudiometa)"`	VideoPreviewAudioMeta
audio_music_meta 可选	样例 : `"[videopreviewaudiomusicmeta](#videopreviewaudiomusicmeta)"`	VideoPreviewAudioMusicMeta
audio_sample_rate 可选	audio_sample_rate 样例 : `"\"44100\""`	string
audio_template_list 可选	audio_template_list 样例 : `[ "[videopreviewtranscode](#videopreviewtranscode)" ]`	< VideoPreviewTranscode > array
bitrate 可选	bitrate 样例 : `"\"39101896\""`	string
duration 可选	duration 样例 : `"\"8053\""`	string
frame_rate 可选	frame_rate 样例 : `"\"239.877\""`	string
height 可选	height 样例 : `1280`	integer (int64)
sprite_info 可选	样例 : `"[videopreviewsprite](#videopreviewsprite)"`	VideoPreviewSprite
template_list 可选	template_list 样例 : `[ "[videopreviewtranscode](#videopreviewtranscode)" ]`	< VideoPreviewTranscode > array
thumbnail 可选	thumbnail 样例 : `"https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx"`	string
video_format 可选	video_format 样例 : `"\"H264\""`	string
width 可选	width 样例 : `720`	integer (int64)

VideoPreviewSprite

名称	说明	类型
col 可选	col 样例 : `10`	integer (int64)
count 可选	count 样例 : `4`	integer (int64)
frame_count 可选	frame_count 样例 : `333`	integer (int64)
frame_height 可选	frame_height 样例 : `90`	integer (int64)
frame_width 可选	frame_width 样例 : `160`	integer (int64)
row 可选	row 样例 : `10`	integer (int64)
status 可选	status 样例 : `"finished"`	string

VideoPreviewTranscode

名称	说明	类型
status 可选	status 样例 : `"finished"`	string
template_id 可选	template_id 样例 : `"\"Original\""`	string

VideoQualityNotFoundError

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

名称	说明	类型
code 必填	样例 : `"VideoQualityNotFoundError"`	string
message 必填	样例 : `"Video definition not found."`	string

图像操作API

概览

版本信息

URI scheme

请求

返回

API

1.标签

1.1 列举场景标记

说明

Body参数

响应

标签

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

响应 400

响应 401

响应 403

响应 404

响应 500

响应 503

2.人脸

2.1 列举人脸分组

说明

Body参数

响应

标签

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

响应 400

响应 401

响应 403

响应 404

响应 500

响应 503

2.2 更新人脸分组信息

说明

Body参数

响应

标签

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

响应 400

响应 401

响应 403

响应 404

响应 500

响应 503

3.地点

3.1列举地点分组

说明

Body参数

响应

标签

HTTP请求示例

请求 path

请求 body

HTTP响应示例

响应 200

响应 400

响应 401

响应 403

响应 404

响应 500

响应 503

3.2 查询地点分组信息

说明

Body参数

响应

标签

HTTP请求示例