API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(imm/2017-09-06)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

API目录

API

标题

API概述

CompareImageFaces 比较两个人脸的相似度 调用CompareImageFaces接口比较两个人脸的相似度。
ConvertOfficeFormat 文档(例如OFFICE文档)格式的转换 采用同步请求方式进行文档(例如Office文档)格式的转换,执行完毕返回转换成功的页数。
CreateGrabFrameTask 创建一个视频截帧任务 调用CreateGrabFrameTask接口创建一个视频截帧任务,执行完成后返回TaskId。
CreateGroupFacesJob 人脸聚类 按照人物将人脸分组。
CreateMergeFaceGroupsJob 合并媒体集中的两个人脸分组 调用CreateMergeFaceGroupsJob接口合并媒体集中的两个人脸分组。
CreateOfficeConversionTask 创建单个文档的转换任务 采用异步请求方式进行文档(例如Office文档)格式的转换,执行完成后返回TaskId。
CreateSet 创建媒体集 调用CreateSet接口创建媒体集。
CreateVideoCompressTask 创建一个视频压缩存储的任务 调用CreateVideoCompressTask接口创建一个视频压缩存储任务,执行完成后返回TaskId。
DecodeBlindWatermark 解析图片盲水印 解析由IMM添加的盲水印。
DeleteImage 删除图片 删除媒体集中指定的图片。
DeleteOfficeConversionTask 删除异步文档格式转换任务 调用DeleteOfficeConversionTask接口删除异步文档格式转换任务。
DeleteProject 删除一个项目 调用DeleteProject接口删除一个项目。
DeleteSet 删除媒体集 调用DeleteSet接口删除媒体集。
DeleteVideo 删除一个视频的信息 调用DeleteVideo接口删除媒体集中的一个视频的信息。
DeleteVideoTask 删除视频异步任务 调用DeleteVideoTask接口删除一个视频任务。
DetectImageBodies 检测图片中的人体 检测图片中的人体信息。
DetectImageFaces 检测图片中的人脸及人脸信息 调用DetectImageFaces接口检测图片中的人脸及人脸信息。
DetectImageQRCodes 检测图片中二维码 检测图片中二维码的位置和内容。
DetectImageTags 检测图片中的标签场景 检测图片中的标签信息。
DetectQRCodes 二维码检测 二维码检测,建议换用DetectImageQRCodes。
EncodeBlindWatermark 添加图片盲水印 在图片中不能直接看到该水印,但可以通过DecodeBlindWatermark恢复图中隐藏的水印。
FindImages 搜索媒体集中图片 调用FindImages接口根据指定条件,例如时间、地点、标签、人物特征等,搜索媒体集中图片。并可以按照给定要求进行排序。
FindSimilarFaces 查找和指定人脸相似的人脸 从媒体集中搜索与指定图片或人脸ID最相似的前N张图片,并返回相应人脸ID及边界框,返回结果按照相似度降序排列。
GetImage 从媒体集中获取一张图片的信息 调用GetImage接口从媒体集中获取一张图片的信息。
GetImageCroppingSuggestions 获取图片裁剪建议(裁剪框位置) 获取图片裁剪建议。
GetImageQuality 获取图片综合质量分数 获取图片质量分数。
GetMediaMeta 获取多媒体文件信息 获取多媒体文件信息,如编码、码率、分辨率、流信息等。
GetOfficeConversionTask 查询异步文档格式转换任务的状态信息 调用GetOfficeConversionTask接口查询异步文档格式转换任务的状态信息。
GetOfficePreviewURL 获取文档预览URL 获取文档预览的URLAccessToken。
GetProject 获取项目的信息 调用GetProject接口获取项目的信息。
GetSet 获取媒体集信息 调用GetSet接口获取媒体集信息。
GetVideo 获取一个视频的信息 调用GetVideo获取媒体集中一个视频的信息。
GetVideoTask 查询视频类任务 调用GetVideoTask接口查询视频任务的执行状态和结果。
GetWebofficeURL 获取Weboffice的访问凭证 获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能,包括预览、编辑、协作等。
IndexImage 将图片加入媒体集 将图片加入媒体集,并进行AI检测。
IndexVideo 对视频进行自动截帧、分组、识别操作 调用IndexVideo接口将视频添加到媒体集中,并对视频进行自动截帧、分组、识别等操作。
ListFaceGroups 获取一个媒体集中的人脸分组列表 调用ListFaceGroups接口获取一个媒体集中的人脸分组列表。
ListImages 获取媒体集中的图片列表 获取媒体集中的图片列表,返回结果以图片加入媒体集的时间升序排序。
ListOfficeConversionTask 列出项目中已创建的文档格式转换任务 调用ListOfficeConversionTask接口列出项目中已创建的文档格式转换任务。
ListProjects 列出已创建的所有项目信息 调用ListProjects接口列出已创建的所有项目信息。
ListSetTags 统计媒体集内标签 获取媒体集中Top 100的标签信息列表,返回结果按标签出现次数降序排列。
ListSets 获取媒体集列表 调用ListSets接口获取媒体集列表。
ListVideoTasks 列出视频类异步任务 调用ListVideoTasks接口列出视频任务信息。
ListVideos 获取多个视频的信息 调用ListVideos接口获取媒体集中的视频信息列表,返回结果以视频加入媒体集的时间升序排序。
OpenImmService 开通智能媒体管理服务 调用OpenImmService接口开通智能媒体管理服务。
PutProject 创建一个项目 目前支持创建文档标准型、图片标准型和视频标准型项目,请根据需要处理的内容类型创建相应项目。
RefreshOfficePreviewToken 刷新文档预览凭证 刷新文档预览凭证AccessToken。
RefreshWebofficeToken 刷新Weboffice的访问凭证 调用RefreshWebofficeToken接口刷新Weboffice的访问凭证。
UpdateFaceGroup 更新媒体集中人脸分组 更新媒体集中人脸分组的名称、封面图、标签等信息。
UpdateImage 更新媒体集中用户自定义的图片信息 调用UpdateImage接口更新媒体集中用户自定义的图片信息。
UpdateProject 更新项目的CU或服务角色信息 调用UpdateProject接口更新项目的CU或服务角色信息。
UpdateSet 更新媒体集的显示名称 调用UpdateSet接口更新媒体集的显示名称。