华为云首页用户手册

数据治理中心 DATAARTS STUDIO-通过浏览器调用无认证方式的API:调用API

时间：2024-09-09 17:46:35

数据治理中心 DATAARTS STUDIO

调用API

打开Chrome浏览器，新建一个空白页签。
参考获取API信息，在浏览器中输入API调用地址并直接访问。注意如果入参中包含Path和Query参数，则需要将调用地址中的{path}变量修改为Path参数具体取值，Query参数取值可以通过“?Query参数名=Query参数值”的形式添加到调用地址的最后，如本例中为“?query=1”。
```
https://xx.xx.xx.xx/getContestantInfo/2?query=1
```
如果您需要对调用结果进行自定义调整，则还可以配置如下Query参数，通过“&”连接多个参数：
- （可选）分页配置：默认情况下，对于配置方式和默认分页的脚本/MyBatis方式API，系统将默认赋值返回量。如果需要获取特定分页数据，您可以添加如下参数设置分页，其中pageSize表示分页后的页面大小，pageNum表示页码。
```
https://xx.xx.xx.xx/getContestantInfo/2?query=1&pageSize=100&pageNum=1
```
  自定义分页的脚本/MyBatis方式API是在创建API时将分页逻辑写到取数SQL中，因此不支持在调用时修改分页设置。
- （可选）排序配置：默认情况下，系统会根据排序参数信息给出默认排序情况，自定义排序默认为升序。如果需要修改排序情况，您可以修改pre_order_by参数。其中排序参数描述pre_order_by的值填写形式为“排序参数参数名:ASC”或“排序参数参数名:DESC”，其中ASC表示升序，DESC表示降序，多个排序参数描述以“英文分号”进行分隔。
```
https://xx.xx.xx.xx/getContestantInfo/2?query=1&pre_order_by=id:ASC;age:ASC;score:DESC
```
  对于pre_order_by的值，您可以进行如下修改：
  - 删掉某可选的排序参数，则此排序参数不再参与排序。
  - 修改自定义排序方式的排序参数为升序或降序方式，则此排序参数按照修改后的排序方式排序。
  pre_order_by的值，不支持进行如下修改，否则会修改不生效或导致调用报错。
  
  删掉某必选的排序参数，则此排序参数依然会正常参与排序，删除不生效。
  
  调整排序参数的前后顺序，则排序依然以配置方式API配置排序参数时的排序参数顺序或脚本/MyBatis方式API SQL中的排序参数顺序为准，调整不生效。
  
  修改升序或降序的排序参数为其他排序方式，则会调用失败，不允许修改。
- （可选）“返回总条数”配置：在创建API时，如果已打开“返回总条数”开关，则当API对应的数据表数据量较大时，获取数据总条数将会比较耗时。此时，如果需要在调用时不计算并返回数据总条数，可以修改use_total_num参数。use_total_num参数用于控制是否计算并返回数据总条数，值为1返回数据总条数，值非1不返回数据总条数。
```
https://xx.xx.xx.xx/getContestantInfo/2?query=1&use_total_num=0
```
浏览器访问后可查看返回结果。返回"errCode":"DLM.0"即表示API调用成功。如果失败，则请根据保错信息进行修复。

图2 使用浏览器调用API