数据治理中心 DATAARTS STUDIO-通过API工具调用IAM认证方式的API:调用API

时间:2024-12-04 08:59:39

调用API

  1. 打开Postman工具,新增一个API请求。
  2. API请求配置如下。

    • 请求方法和调用地址:参考获取API信息获取,注意如果入参中包含Path和Query参数,则需要将调用地址中的{path}变量修改为Path参数具体取值,Query参数取值可以通过“?Query参数名=Query参数值”的形式添加到调用地址的最后,如本例中为“?query=1”。
      图4 请求方法和调用地址
    • Params:如果Query参数已经以“?Query参数名=Query参数值”的形式添加到调用地址的最后,则此处会自动生成Query Params的值,否则就需要手动输入。
      图5 Params
      如果您需要对调用结果进行自定义调整,则还可以配置如下Query参数:
      • (可选)分页配置:默认情况下,对于配置方式和默认分页的脚本/MyBatis方式API,系统将默认赋值返回量。如果需要获取特定分页数据,您可以修改如下参数设置分页,其中pageSize表示分页后的页面大小,pageNum表示页码。
        图6 分页参数设置

        自定义分页的脚本/MyBatis方式API是在创建API时将分页逻辑写到取数SQL中,因此不支持在调用时修改分页设置。

      • (可选)排序配置:默认情况下,系统会根据排序参数信息给出默认排序情况,自定义排序默认为升序。如果需要修改排序情况,您可以修改pre_order_by参数。其中排序参数描述pre_order_by的值填写形式为“排序参数参数名:ASC”或“排序参数参数名:DESC”,其中ASC表示升序,DESC表示降序,多个排序参数描述以“英文分号”进行分隔。
        图7 排序参数设置
        对于pre_order_by的值,您可以进行如下修改:
        • 删掉某可选的排序参数,则此排序参数不再参与排序。
        • 修改自定义排序方式的排序参数为升序或降序方式,则此排序参数按照修改后的排序方式排序。
        pre_order_by的值,不支持进行如下修改,否则会修改不生效或导致调用报错。
        • 删掉某必选的排序参数,则此排序参数依然会正常参与排序,删除不生效。
        • 调整排序参数的前后顺序,则排序依然以配置方式API配置排序参数时的排序参数顺序或脚本/MyBatis方式API SQL中的排序参数顺序为准,调整不生效。
        • 修改升序或降序的排序参数为其他排序方式,则会调用失败,不允许修改。
      • (可选)“返回总条数”配置:在创建API时,如果已打开“返回总条数”开关,则当API对应的数据表数据量较大时,获取数据总条数将会比较耗时。此时,如果需要在调用时不计算并返回数据总条数,可以修改use_total_num参数。use_total_num参数用于控制是否计算并返回数据总条数,值为1返回数据总条数,值非1不返回数据总条数。
        图8 “返回总条数”参数配置
    • Headers:将 获取Token 中保存的x-subject-token值填入X-Auth-Token的值中,并将Header参数的参数名和参数值填入其中。

      默认情况下,Postman工具会自动勾选Host并从URI中生成Host值,无需手动填写。

      图9 Headers
    • Body:选择raw格式,使用大括号{}将“"Body参数名":Body参数值”形式的字符串包围在内,如本例中为“{"body":4}”。
      图10 Body

  3. API请求配置完成后,单击“Send”发送请求到服务端,然后查看返回结果。返回"errCode":"DLM.0"即表示API调用成功。如果失败,则请根据报错信息进行修复。

    如调用失败提示“Could not get any response”,可根据提示在Postman设置中关闭“SSL certificate verification”选项或关闭Proxy代理,然后再次尝试运行。

    图11 调用API

support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_0357.html