全部产品

图像操作API

更新时间:2021-02-18 13:57

概览

Image API

版本信息

版本 : 2.0.0

URI scheme

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

基础路径 : /v2

方案 : HTTP, HTTPS

请求

  • application/json

返回

  • application/json

API

1.标签

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/list_tags
请求 body
  1. {
  2. "drive_id" : "123",
  3. "image_thumbnail_process" : "image/resize,w_200",
  4. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  5. }

HTTP响应示例

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

2.人脸

2.1 列举人脸分组

  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

标签

  • image

HTTP请求示例

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

HTTP响应示例

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

2.2 更新人脸分组信息

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/update_facegroup_info
请求 body
  1. {
  2. "drive_id" : "\"101\"",
  3. "group_id" : "\"group-asdasdasdeop\"",
  4. "group_name" : "\"张XX\""
  5. }

HTTP响应示例

响应 200
  1. {
  2. "drive_id" : "\"101\"",
  3. "group_id" : "\"group-aas11002ddeac\""
  4. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

3.地点

3.1列举地点分组

  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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/list_address_groups
请求 body
  1. {
  2. "drive_id" : "123",
  3. "image_thumbnail_process" : "image/resize,w_200",
  4. "limit" : 10,
  5. "marker" : "marker",
  6. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  7. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "address_detail" : {
  4. "city" : "string",
  5. "country" : "string",
  6. "district" : "string",
  7. "province" : "string",
  8. "township" : "string"
  9. },
  10. "count" : 1,
  11. "cover_file_id" : "string",
  12. "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
  13. "location" : "39.21211,101.32111",
  14. "name" : "杭州"
  15. } ],
  16. "next_marker" : "string"
  17. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

3.2 查询地点分组信息

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/search_address_groups
请求 body
  1. {
  2. "address_level" : "city",
  3. "address_names" : [ "杭州市", "北京市" ],
  4. "br_geo_point" : "39.121,101.2121",
  5. "drive_id" : "123",
  6. "image_thumbnail_process" : "image/resize,w_200",
  7. "tl_geo_point" : "39.121,101.2121",
  8. "video_thumbnail_process" : "video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast"
  9. }

HTTP响应示例

响应 200
  1. {
  2. "items" : [ {
  3. "address_detail" : {
  4. "city" : "string",
  5. "country" : "string",
  6. "district" : "string",
  7. "province" : "string",
  8. "township" : "string"
  9. },
  10. "count" : 1,
  11. "cover_file_id" : "string",
  12. "cover_url" : "http://imm-dev-wmt/tags/05.jpg?x-oss-process=xxx",
  13. "location" : "39.21211,101.32111",
  14. "name" : "杭州"
  15. } ]
  16. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

4.故事

4.1 创建故事

  1. POST /v2/image/create_story

说明

该接口将会创建故事,系统默认模版

Body参数

创建故事请求参数

名称 : create_story标志 : 必填类型 : CreateStoryRequest

响应

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/create_story
请求 body
  1. {
  2. "drive_id" : "\"101\""
  3. }

HTTP响应示例

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

4.2 获取故事详情

  1. POST /v2/image/get_story_detail

说明

该接口将会获取故事详情

Body参数

获取故事详情请求参数

名称 : get_story_detail标志 : 必填类型 : GetStoryDetailRequest

响应

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/get_story_detail
请求 body
  1. {
  2. "drive_id" : "\"101\"",
  3. "story_id" : "\"story112312\"",
  4. "video_url_expire_sec" : 900
  5. }

HTTP响应示例

响应 200
  1. {
  2. "cover_file_id" : "string",
  3. "created_at" : "string",
  4. "items" : [ {
  5. "category" : "doc",
  6. "characteristic_hash" : "string",
  7. "content_hash" : "EA4942AA8761213890A5C386F88E6464D2C31CA3",
  8. "content_hash_name" : "sha1",
  9. "content_type" : "application/json",
  10. "crc64_hash" : "string",
  11. "created_at" : "2019-08-20T06:51:27.292Z",
  12. "description" : "file description",
  13. "domain_id" : "test001",
  14. "download_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  15. "drive_id" : "1",
  16. "encrypt_mode" : "pin",
  17. "file_extension" : "jpg",
  18. "file_id" : "5d5b846942cf94fa72324c14a4bda34e81da635d",
  19. "hidden" : false,
  20. "image_media_metadata" : {
  21. "address_line" : "北京市昌平区白各庄新村路",
  22. "city" : "杭州",
  23. "country" : "中国",
  24. "cropping_suggestion" : [ {
  25. "aspect_ratio" : "string",
  26. "cropping_boundary" : {
  27. "height" : 0,
  28. "left" : 0,
  29. "top" : 0,
  30. "width" : 0
  31. },
  32. "score" : 0.0
  33. } ],
  34. "district" : "余杭区",
  35. "exif" : "string",
  36. "faces" : "string",
  37. "height" : 720,
  38. "image_quality" : {
  39. "clarity" : 0.0,
  40. "clarity_score" : 0.0,
  41. "color" : 0.0,
  42. "color_score" : 0.0,
  43. "composition_score" : 0.0,
  44. "contrast" : 0.0,
  45. "contrast_score" : 0.0,
  46. "exposure" : 0.0,
  47. "exposure_score" : 0.0,
  48. "overall_score" : 0.0
  49. },
  50. "image_tags" : [ {
  51. "confidence" : 0.0,
  52. "en_name" : "string",
  53. "name" : "string",
  54. "parent_en_name" : "string",
  55. "parent_name" : "string",
  56. "selected" : true,
  57. "source" : "string",
  58. "tag_level" : 0
  59. } ],
  60. "location" : "40.110333,116.349311",
  61. "province" : "浙江省",
  62. "story_image_score" : 0.0,
  63. "time" : "string",
  64. "township" : "沙河镇",
  65. "width" : 1024
  66. },
  67. "labels" : [ "label1:1", "label2:2" ],
  68. "meta" : "string",
  69. "name" : "ccp.jpg",
  70. "parent_file_id" : "root",
  71. "punish_flag" : "[punishflagtype](#punishflagtype)",
  72. "size" : 1024,
  73. "starred" : false,
  74. "status" : "available",
  75. "streams_info" : {
  76. "string" : "[streaminfo](#streaminfo)"
  77. },
  78. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  79. "trashed_at" : "string",
  80. "type" : "file",
  81. "updated_at" : "string",
  82. "upload_id" : "C9DCFE5A82644AC7A02DB74C30C934A6",
  83. "url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  84. "user_meta" : "user_meta",
  85. "video_media_metadata" : {
  86. "address_line" : "北京市昌平区白各庄新村路",
  87. "city" : "杭州",
  88. "country" : "中国",
  89. "district" : "余杭区",
  90. "duration" : "\"7704.573000\"",
  91. "height" : 720,
  92. "image_tags" : [ {
  93. "confidence" : 0.0,
  94. "en_name" : "string",
  95. "name" : "string",
  96. "parent_en_name" : "string",
  97. "parent_name" : "string",
  98. "selected" : true,
  99. "source" : "string",
  100. "tag_level" : 0
  101. } ],
  102. "location" : "40.110333,116.349311",
  103. "province" : "浙江省",
  104. "time" : "string",
  105. "township" : "沙河镇",
  106. "video_media_audio_stream" : [ {
  107. "bit_rate" : "\"129280\"",
  108. "channel_layout" : "\"5.1\", \"stereo\"",
  109. "channels" : 2,
  110. "code_name" : "\"aac\"",
  111. "duration" : "\"7704.573000\"",
  112. "sample_rate" : "\"48000\""
  113. } ],
  114. "video_media_video_stream" : [ {
  115. "bitrate" : "\"108420\"",
  116. "clarity" : "\"1080P\"",
  117. "code_name" : "\"h264\"",
  118. "duration" : "\"7704.573000\"",
  119. "fps" : "\"25/1\""
  120. } ],
  121. "width" : 1024
  122. },
  123. "video_preview_metadata" : {
  124. "audio_channels" : 2,
  125. "audio_format" : "\"AAC\"",
  126. "audio_meta" : {
  127. "bitrate" : 349461.0,
  128. "channels" : 2,
  129. "duration" : 18.2,
  130. "sample_rate" : 18.2
  131. },
  132. "audio_music_meta" : {
  133. "album" : "\"范特西\"",
  134. "artist" : "\"周杰伦\"",
  135. "cover_url" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  136. "title" : "\"爱在西元前\""
  137. },
  138. "audio_sample_rate" : "\"44100\"",
  139. "audio_template_list" : [ {
  140. "status" : "finished",
  141. "template_id" : "\"Original\""
  142. } ],
  143. "bitrate" : "\"39101896\"",
  144. "duration" : "\"8053\"",
  145. "frame_rate" : "\"239.877\"",
  146. "height" : 1280,
  147. "sprite_info" : {
  148. "col" : 10,
  149. "count" : 4,
  150. "frame_count" : 333,
  151. "frame_height" : 90,
  152. "frame_width" : 160,
  153. "row" : 10,
  154. "status" : "finished"
  155. },
  156. "template_list" : [ {
  157. "status" : "finished",
  158. "template_id" : "\"Original\""
  159. } ],
  160. "thumbnail" : "https://ccp.data.aliyuncs.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
  161. "video_format" : "\"H264\"",
  162. "width" : 720
  163. }
  164. } ],
  165. "score" : 50.5,
  166. "story_id" : "\"abc\"",
  167. "story_images_date_range" : [ 0 ],
  168. "sub_title" : "\"2020\"",
  169. "title" : "\"历史的今天\"",
  170. "updated_at" : "string",
  171. "video_status" : "string",
  172. "video_url" : "\"https://abc.xxx\""
  173. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

4.3 获取故事列表

  1. POST /v2/image/list_story

说明

该接口将会获取故事列表

Body参数

获取故事列表请求参数

名称 : list_story标志 : 必填类型 : ListStoryRequest

响应

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/list_story

HTTP响应示例

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

4.4 移除故事中的照片

  1. POST /v2/image/remove_story_images

说明

该接口将会移除故事中的照片

Body参数

移除故事中的照片请求参数

名称 : remove_story_images标志 : 必填类型 : RemoveStoryImagesRequest

响应

HTTP代码 说明 类型
200 Success RemoveStoryImagesResponse
400 1. InvalidParameter.DriveId 2. InvalidRequestJSONFormatError 请求JSON格式错误 3. InvalidParameter.StoryID InvalidParameterError
401 AccessTokenInvalid AccessTokenInvalidError
403 1.ForbiddenNoPermissionError 没有获取故事详情接口权限 ForbiddenNoPermissionError
404 资源没找到 NotFoundError
500 服务内部故障 InternalErrorError
503 服务临时不可用 ServiceUnavailableError

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/remove_story_images
请求 body
  1. {
  2. "drive_id" : "string",
  3. "file_ids" : [ "string" ],
  4. "story_id" : "string"
  5. }

HTTP响应示例

响应 200
  1. {
  2. "drive_id" : "string",
  3. "file_ids" : [ "a", "b", "c" ],
  4. "results" : [ {
  5. "code" : "string",
  6. "file_id" : "string",
  7. "is_succeed" : true,
  8. "message" : "string"
  9. } ],
  10. "story_id" : "string",
  11. "success_file_ids" : [ "string" ]
  12. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 404
  1. {
  2. "code" : "NotFound",
  3. "message" : "The resource {resource_name} cannot be found. Please check."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

5.AI语义解析

5.1 语义解析出标签,地点,时间

  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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/parse_keywords
请求 body
  1. {
  2. "keywords" : "string"
  3. }

HTTP响应示例

响应 200
  1. {
  2. "address_line" : "string",
  3. "tags" : [ {
  4. "confidence" : 0.0,
  5. "en_name" : "string",
  6. "name" : "string",
  7. "parent_en_name" : "string",
  8. "parent_name" : "string",
  9. "selected" : true,
  10. "source" : "string",
  11. "tag_level" : 0
  12. } ],
  13. "time_range" : {
  14. "end" : "string",
  15. "start" : "string"
  16. }
  17. }
响应 400
  1. {
  2. "code" : "InvalidParameter",
  3. "message" : "The input parameter {parameter_name} is not valid."
  4. }
响应 401
  1. {
  2. "code" : "AccessTokenInvalid",
  3. "message" : "AccessToken is invalid. {message}"
  4. }
响应 403
  1. {
  2. "code" : "ForbiddenNoPermission",
  3. "message" : "No Permission to access resource {resource_name}."
  4. }
响应 500
  1. {
  2. "code" : "InternalError",
  3. "message" : "The request has been failed due to some unknown error."
  4. }
响应 503
  1. {
  2. "code" : "ServiceUnavailable",
  3. "message" : "The request has failed due to a temporary failure of the server."
  4. }

6.查询云照片个数

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

标签

  • image

HTTP请求示例

请求 path
  1. /v2/image/get_photo_count
请求 body
  1. {
  2. "drive_id" : "1"
  3. }

HTTP响应示例

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

定义

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)

CreateStoryRequest

Create story request

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

CreateStoryResponse

生成故事

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

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)

GetStoryDetailRequest

Get story detail request

名称 说明 类型
drive_id
必填
drive_id
模式 : "[0-9]+"
样例 : "\"101\""
string
story_id
必填
story_id
样例 : "\"story112312\""
string
video_url_expire_sec
可选
url_expire_sec
默认值 : 900
最小值 : 10
最大值 : 14400
样例 : 900
integer (int64)

GetStoryDetailResponse

故事详情

名称 说明 类型
cover_file_id
可选
cover_file_id
样例 : "string"
string
created_at
可选
created_at
样例 : "string"
string
items
可选
items
样例 : [ "[baseccpfileresponse](#baseccpfileresponse)" ]
< BaseCCPFileResponse > array
score
可选
score
样例 : 50.5
number (double)
story_id
可选
story_id
样例 : "\"abc\""
string
story_images_date_range
可选
story_images_date_range
样例 : [ 0 ]
< integer (int64) > array
sub_title
可选
sub_title
样例 : "\"2020\""
string
title
可选
title
样例 : "\"历史的今天\""
string
updated_at
可选
updated_at
样例 : "string"
string
video_status
可选
video_status
样例 : "string"
enum (creating, available)
video_url
可选
video_url
样例 : "\"https://abc.xxx\""
string

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

RemoveStoryImagesRequest

Remove story images request

名称 说明 类型
drive_id
可选
样例 : "string" string
file_ids
可选
样例 : [ "string" ] < string > array
story_id
可选
样例 : "string" string

RemoveStoryImagesResponse

Remove story images response

名称 说明 类型
drive_id
可选
drive_id
样例 : "string"
string
file_ids
可选
file_ids
样例 : [ "a", "b", "c" ]
< string > array
results
可选
样例 : [ "[removestoryimagesresultitem](#removestoryimagesresultitem)" ] < RemoveStoryImagesResultItem > array
story_id
可选
story_id
样例 : "string"
string
success_file_ids
可选
success_file_ids
样例 : [ "string" ]
< string > array

RemoveStoryImagesResultItem

名称 说明 类型
code
可选
code
样例 : "string"
string
file_id
可选
file_id
样例 : "string"
string
is_succeed
可选
is_succeed
样例 : true
boolean
message
可选
message
样例 : "string"
string

RobotTestingError

RobotTesting 人机验证

名称 说明 类型
code
必填
样例 : "RobotTesting" string
message
必填
样例 : "100" 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

StoryResponse

名称 说明 类型
cover_file_id
可选
cover_file_id
样例 : "string"
string
created_at
可选
created_at
样例 : "string"
string
score
可选
score
样例 : 50.5
number (double)
story_id
可选
story_id
样例 : "\"abc\""
string
story_images_date_range
可选
story_images_date_range
样例 : [ 0 ]
< integer (int64) > array
sub_title
可选
sub_title
样例 : "\"2020\""
string
title
可选
title
样例 : "\"历史的今天\""
string
updated_at
可选
updated_at
样例 : "string"
string
video_status
可选
video_status
样例 : "string"
enum (creating, available)
video_url
可选
video_url
样例 : "\"https://abc.xxx\""
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