华为云首页用户手册

数据治理中心 DATAARTS STUDIO-配置方式生成API:测试API

时间：2024-09-27 17:58:46

数据治理中心 DATAARTS STUDIO

测试API

填写入参取值。
如果单个参数需要传多个值时，写法如下：
- 字符串：'a','b','c'
- 数值：1,2
- 字段：a,b,c
图6 填写入参取值
（可选）调整排序参数描述pre_order_by的值。
系统根据5中已配置的所有排序参数已给出pre_order_by的默认值，自定义排序默认为升序。排序参数描述pre_order_by的值填写形式为“排序参数参数名:ASC”或“排序参数参数名:DESC”，其中ASC表示升序，DESC表示降序，多个排序参数描述以“英文分号”进行分隔。勾选“是否传值”后，测试结果将按照pre_order_by的值排序。
对于pre_order_by的值，您可以进行如下修改：
- 删掉某可选的排序参数，则此排序参数不再参与排序。
- 修改自定义排序方式的排序参数为升序或降序方式，则此排序参数按照修改后的排序方式排序。
pre_order_by的值，不支持进行如下修改，否则会修改不生效或导致调用报错。
- 删掉某必选的排序参数，则此排序参数依然会正常参与排序，删除不生效。
- 调整排序参数的前后顺序，则排序依然以配置排序参数时的排序参数顺序为准。调整不生效。
- 修改升序或降序的排序参数为其他排序方式，则会调用失败，不允许修改。
图7 调整排序参数描述pre_order_by的值
（可选）调整分页参数值。
系统会对返回数据进行分页，pageSize表示分页后的页面大小，pageNum表示页码。API调试时默认按100的大小分页，返回第1页数据。

API调试时，page_size (系统默认) 最大为100，当page_size值大于100时，默认查出的数据仍为100条。

图8 调整分页参数值
完成API参数的配置并保存后，单击左下角的“开始测试”，可进入API测试环节。
填写参数值，单击“开始测试”，即可在线发送API请求，在右侧可以看到API请求详情及返回内容。
- 测试过程中，如果数据服务API查询及返回数据的总时长超过默认60秒，会报超时错误。
- 如果测试失败，请查看错误提示并做相应的修改重新测试。