API中心 API Hub-易用性:API响应报文使用分页，避免超长列表数据返回

时间：2025-01-14 15:42:03

API中心 API Hub

本条规则是Should类型的扩展规则，可提升API调用者的使用体验。

获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。
不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(offset)。查询资源列表需要返回符合查询条件的资源总数(count)、查询数量(limit)、位移量(offset)。

举例：查询虚拟机从第10条开始，查询后100条。

请求

GET /ecs/v1/projects/xxxxx/servers?offset=10&limit=100

响应

{"resources":[   {     "id":"xxx",},…   {     "id":"xxx",   }],  "offset":10,  "limit":100,  "count":1540}

新客秒杀 2核2G 3M L实例

68元/年

普惠上云领千元上云礼券

立即前往

企业专享 X实例 4核8G 5M

888元/年

热门域名 1元随心购

1元/年起

API中心 API Hub-易用性:API响应报文使用分页，避免超长列表数据返回

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

7*24