1. 接口说明
调用已在管理后台发布的数据服务 API。
请求方法:POST
请求路径:/api/open/v1/data-service/{apiName}/query
2. 认证
需要 HMAC 签名,详见 API 使用说明。
3. 请求参数
3.1 路径参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
apiName | string | 是 | 数据服务 API 名称(唯一标识) |
3.3 请求体(JSON)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
params | object | 否 | 业务参数,key 对应 API 配置的 paramName |
pagination.page | int | 否 | 页码,默认 1 |
pagination.pageSize | int | 否 | 每页条数,默认 20,受 maxRows 限制 |
4. 响应参数
4.2 返回字段(data)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
total | long | - | 总记录数 |
page | int | - | 当前页 |
pageSize | int | - | 每页条数 |
rows | array | - | 数据行 |
columns | array | - | 列定义 [{name, type}] |
5. 补充说明
apiName 对应开放平台「数据服务」中已发布 API 的名称。