检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
application/json 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为
状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响
图像搜索服务所提供的API为自研API。通过使用服务的自研API,您可以完整的使用如下所有功能。 API说明章节中请求示例均采用Token方式请求消息头,在实际使用过程中可根据情况选择认证方式。 请求样例中的Token值以实际申请服务时所获取的Token值为准。 endpoint、projectId以实际申请的服务所在区域为准。
有哪些途径可以使用图像搜索的API? 共有三种方式可以基于已构建好的请求消息发起请求。 cURL cURL是一个命令行工具,用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端,可以发送HTTP请求给服务端,并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl
调用说明 图像搜索提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用。 同时图像搜索还提供多种编程语言的SDK供您使用,SDK的使用方法请参见:图像搜索SDK。 父主题: 使用前必读
获取账号名和账号ID 在调用接口的时候,部分请求中需要填入账号名(domain name)和账号ID(domain_id)。获取步骤如下: 注册并登录管理控制台。 鼠标移动至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的查看“账号名”和“账号ID”。 图1 查看账号ID
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 图像搜索的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 图像搜索的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四
AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK签名认证通过API网关向下层服务发送请求时,必须使用AK、SK对请求进行签名,参见API签名指南。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。
其中系统级限制,是针对服务整体的约束。除系统级限制外,各种服务子项还有独立的使用限制条件。 系统级约束 服务区域仅支持“华为-北京四”。 请求body使用标准json格式,且大小不超过12M。 默认不保存用户的图像或视频等数据。 实例数量:每个用户默认可创建5个服务实例。如需创建更多服务实例,请联系华为云客服。
获取项目ID和名称 操作场景 在调用接口的时候,部分请求中需要填入项目ID或项目名称,所以需要获取到项目ID和名称。有如下两种获取方式: 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标移动到右上角的用户名上,在下拉列表中选择“我的凭证”。
返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。
limit:XX,time:1 minute. 发送请求,超过服务的默认配置限流 请您稍后重试。在代码里检查返回值,碰到并发错误可以延时一小段时间(如2-5s)重试请求; 后端检查上一个请求结果,上一个请求返回之后再发送下一个请求,避免请求过于频繁。 其他 如若出现其他无法解决的错误码,请联系华为云支持人员。
建的服务实例及其相应配置信息。 获取请求认证 调用图像搜索服务的API有如下两种认证方式,可任选其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。具体操作请参见“Token认证”。 AK/SK认证:通过AK/SK加密调用请求,AK/SK认证安全性更高。具体操作请参见“AK/SK认证”。
单击右上角“Send”按钮发送请求。获取返回结果中的Token值(Token有效期为24小时)。 步骤五:调用服务 向已创建的“通用图像搜索”服务实例中添加数据,可以调用添加数据API实现,搜索数据、检查数据、更新数据、删除数据等操作。具体操作如下: 新建请求,请求方式为修改“POST”,按要求填写URL。
如何调用API 构造请求 认证鉴权 返回结果
用户的项目ID。获取方法请参见获取项目ID和名称。 service_name 是 String 服务实例的名称,用户创建服务实例时指定。 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 item_id 是 String 数据的服务实例级唯一标识,字符长度范围为[1, 256]。
用户的项目ID。获取方法请参见获取项目ID和名称。 service_name 是 String 服务实例的名称,用户创建服务实例时指定。 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否幂等删除数据,默认为false。仅对指定ID删除生效。
the URL failed." } 表示从URL获取图片数据失败。可通过以下几个方面进行排查: 请确保提供的URL支持HTTP/HTTPS请求协议,即格式为http/https url。 请检查存储图片的服务器是否稳定可靠,网络连接是否有异常,是否公网可访问。 请检查下载图片的c
5]。搜索时会直接使用最显著商品进行搜索,同时返回图像中所有商品用于后续精准搜索。 请求高阶参数 通用商品搜索允许用户在调用API接口时传递高阶参数,以满足业务应用的差异化需求。 CATEGORY 针对类目检索的搜索类型,服务实例具有如下高阶请求参数: 添加数据API do_det: 是否进行目标检测,默认为true。
用户的项目ID。获取方法请参见获取项目ID和名称。 service_name 是 String 服务实例的名称,用户创建服务实例时设置的实例名称。 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制添加数据,默认为false。 false: 数据已存在则不进行添加。