TestPlan数据接入Board看板-查询数据 - ShowTestCaseUris
功能介绍
此接口用于通过指定条件查询数据库指定表的内容(需要联系技术支持,添加白名单后才能调用)
调用方法
请参见如何调用API。
URI
POST /v4/testhub/etl/query-data
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 是 | Integer | 分页偏移量 |
| limit | 是 | Integer | 分页大小,最大值1000 |
| table_name | 是 | String | 需要同步的表名称 |
| is_bak | 否 | String | 是否是bak表数据 |
| start_time | 是 | String | 查询时间段起始时间 |
| end_time | 是 | String | 查询时间段截止时间 |
| filter_time_field | 是 | String | 用于时间段过滤的字段 |
| sort_field | 否 | String | 用于时间排序的字段,不传默认按照更新时间排序 |
| schema_no | 是 | String | 分库编号(数字类型) |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of ResultValueString objects | 请求的返回的数据对象 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
| value | String | 实际的数据类型:单个对象,集合 或 NULL |
| reason | String | 业务失败的提示内容 |
| page_size | Integer | 分页大小 |
| page_no | Integer | 分页编码 |
| has_more | Boolean | 是否有更多 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
查询指定表的内容
post https://{endpoint}/v4/testhub/etl/query-data
{
"table_name" : "TestItemData",
"is_bak" : false,
"start_time" : "2019-05-09T10:35:00+08:00",
"end_time" : "2019-05-09T10:35:00+08:00",
"filter_time_field" : "tmssUpdateTime",
"sort_field" : "LASTMODIFIED",
"offset" : 0,
"limit" : 100,
"schema_no" : "1"
} 响应示例
状态码:200
OK
{
"total" : 0,
"value" : "string",
"reason" : "string",
"page_size" : 0,
"page_no" : 0,
"has_more" : true
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。