API标准及多语言预置SDK
本产品(ImageSearch/2020-12-14)的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概述 |
| AddImage | 新增图片 | 本文为您介绍AddImage接口的语法及示例,用于向图像搜索实例中添加图片信息。 |
| DeleteImage | 删除图片 | 本文为您介绍DeleteImage接口的语法及示例,用于向图像搜索实例中删除图片信息。 |
| SearchImageByName | 通过名称搜索图像 | 本文为您介绍SearchByName接口的语法及示例,用于根据名称查询图像搜索实例中的图片信息。 |
| SearchImageByPic | 根据图片查询图片 | 本文为您介绍SearchByPic的语法及示例,用于根据图片查询图像搜索实例中的图片信息。 |
| SearchImageByText | 根据文本查询图片 | 本文为您介绍SearchImageByText的语法及示例,用于根据文字查询图像搜索实例中的图片信息。 |
| Detail | 查询实例状态 | 本文为您介绍Detail接口的语法及示例,用于根据名称查询图像搜索实例的相关信息。 |
| DumpMeta | 元数据导出 | 本文为您介绍DumpMeta接口的语法及示例,用于根据名称新建图像搜索元数据导出任务。 |
| DumpMetaList | 查询元信息导出任务 | 本文为您介绍DumpMetaList接口的语法及示例,用于向图像搜索实例中查看元信息导出任务列表。 |
| IncreaseInstance | 批量操作 | 本文为您介绍IncreaseInstance接口的语法及示例,用于根据名称新建图像搜索实例批量任务。 |
| IncreaseList | 查询批量任务 | 本文为您介绍IncreaseList接口的语法及示例,用于向图像搜索实例中查看批量任务列表。 |
| UpdateImage | 修改图片 | 本文为您介绍UpdateImage接口的语法及示例,用于向图像搜索实例中修改图片信息。 |
| CompareSimilarByImage | 相似度比较 | 本接口用于对比两张图片相似值。 |
| CheckImageExists | 检查图片 | CheckImageExists |
| SearchImageByFilter | 根据过滤条件查询图片 | 本文为您介绍SearchImageByFilter的语法及示例,用于根据过滤条件查询图像搜索实例中的图片信息。 |