更新时间:2024-04-19 GMT+08:00
分享

调用API实现功能

本章节通过Postman软件,调用通用图像搜索服务实例的添加数据API,帮助您快速熟悉API的使用方法,具体流程如下:

步骤一:开通服务

步骤二:创建实例

步骤三:配置环境

步骤四:Token认证鉴权

步骤五:调用服务

步骤六:删除实例

准备工作

已注册华为账号,并完成实名认证,账号不能处于欠费或冻结状态。

步骤一:开通服务

服务申请开通您可以按照以下步骤进行操作:

  1. 登录华为云图像搜索服务管理控制台。

    控制台左上角默认显示服务部署在“华北-北京四”区域,请您根据业务需要选择对应区域,各服务部署的区域具体请参见终端节点

  2. 单击页面右上角的“开通服务”按钮,开通图像搜索服务。
    图1 开通服务
  • 服务只需要开通一次即可,后面使用时无需再开通。
  • 整体开通图像搜索服务后,具体的搜索服务实例需要单独创建。

步骤二:创建实例

以创建“通用图像搜索”服务实例为例,具体操作步骤如下:

  1. 在控制台,单击左侧导航栏“实例管理->实例创建”,进入到实例创建页面。
  2. 按图中所示填写参数,其余选项保持默认。

  3. 填写完成后,单击“立即创建”,弹出窗口提示创建成功后,您可以前往“实例概况”查看创建的实例。

如果没有特殊需求,高级设置中的配置项均保持默认值即可。

步骤三:配置环境

下载并安装Postman,Postman建议使用7.24.0版本。

步骤四:Token认证鉴权

Token是用户的访问令牌,承载了用户的身份、权限等信息,用户调用API接口时,需要使用Token进行鉴权。

  1. 在Postman界面,选择New > Collection,设置相应的名称并单击“Create”完成创建。

  2. 选择创建的Collection,单击鼠标右键,选择“Add Request”,设置Request name并单击“Save”

  3. 请求方式修改为"POST",输入URL。

    例如,以cn-north-4为例,URL为“https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens”

  4. 在“Headers”列表中添加“KEY”“Content-Type”“VALUE”“application/json”

  5. 选中“Body”的配置项,选中“raw”,在空白处添加以下代码。
    图2 Token认证鉴权

    图中代码红框内加粗的蓝色字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,project name为服务的部署区域,获取方法请登录我的凭证获取。

    图像搜索服务部署的区域必须与调用的服务所在区域一致,本示例中为cn-north-4。

    { 
         "auth": { 
             "identity": { 
                 "methods": [ 
                     "password" 
                 ], 
                 "password": { 
                     "user": { 
                         "name": "username", 
                         "password": "**********", 
                         "domain": { 
                             "name": "domainname" 
                         } 
                     } 
                 } 
             }, 
             "scope": { 
                 "project": { 
                     "name": "cn-north-4" 
                 } 
             } 
         } 
     }
  6. 单击右上角“Send”按钮发送请求。获取返回结果中的Token值(Token有效期为24小时)。

步骤五:调用服务

向已创建的“通用图像搜索”服务实例中添加数据,可以调用添加数据API实现,搜索数据、检查数据、更新数据、删除数据等操作。具体操作如下:

  1. 新建请求,请求方式为修改“POST”,按要求填写URL。

    例如:服务部署在“华北-北京四”,添加数据API的请求URL为“https://mms.cn-north-4.myhuaweicloud.com/v2/{project_id}/mms/{service_name}/data/add”。

  2. 选中“Headers”配置项,复制Token值到“X-Auth-Token”
  3. 登录我的凭证,查询属于“华北-北京四”的项目ID,替换URI中的{project_id}。
  4. 使用已创建的通用图像搜索服务实例名称“imagesearch_test”,替换URI中的{service_name}。

  5. 单击“Body”配置项,按照如下图中所示内容填写参数。关于body体中其他参数说明,请参考添加数据API
    图3 body参数
  6. 单击右上角“Send”按钮发送请求,查看添加数据结果。

步骤六:删除实例

实例运行完成后,如果不再需要本实例,可以将它删除,以免浪费资源或占用配额。

实例删除后无法恢复,请谨慎操作。

具体步骤如下:

  1. 在图像搜索管理控制台的左侧导航栏中,单击”实例管理->实例概况“,进入”实例概况“页面“。
  2. 在”实例概况“页面中,选择需要删除的实例,单击“删除”。
  3. 在弹出的确认对话框中,单击“是”完成操作。

相关文档