Get Data Deletion Details¶
通过指定模型ID或者测点ID,获取数据清理任务运行详情。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产 |
Read |
有关各资源及其对应的权限,参考 策略,角色,与权限>>
请求格式¶
GET https://{apigw-address}/tsdb-service/v2.1/data/delete-detail
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
queryId |
Query |
可选 |
String |
模型ID或者测点ID。如不指定,则返回组织内所有已提交的数据清理任务运行详情。 |
pageNo |
Query |
可选 |
Integer |
请求页数,从1开始。 |
pageSize |
Query |
可选 |
Integer |
每页返回记录数,必须大于0。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
total |
Integer |
返回查询结果的总记录数。 |
pageNum |
Integer |
当前页数。 |
pageSize |
Integer |
每页返回记录数。 |
list |
List<JSONObject> |
数据清理任务运行结果。详见 list |
list¶
示例¶
{
"id": "290537323067711488",
"status": 2,
"modelId": "yourModelId",
"assetIds": "yourAssetIds",
"measurement": "yourPointId",
"startTime": "1615444301240",
"endTime": "1615444301240",
"launchTime": "2021-03-12T09:32:16.442+0000",
"finishTime": "2021-03-12T09:32:46.418+0000",
"operator": "user.name"
}
参数¶
名称 |
数据类型 |
描述 |
---|---|---|
id |
String |
数据清理任务ID。 |
status |
Integer |
数据清理任务运行状态。0:任务已提交;1:任务执行中;2:任务已完成;3:任务已暂停;4:任务已取消;5:任务执行失败。 |
modelId |
String |
删除数据所属的模型。 |
assetIds |
String |
删除数据所属的资产。 |
measurement |
String |
删除数据所属的测点。 |
startTime |
String |
指定的删除数据的时间范围(起始时间)。 |
endTime |
String |
指定的删除数据的时间范围(结束时间)。 |
launchTime |
Long |
数据清理任务开始运行的时间。 |
finishTime |
Long |
数据清理任务结束运行的时间。 |
operator |
String |
数据清理任务的操作人。 |
错误码¶
有关错误码的描述,参见 通用错误码。
示例¶
请求示例¶
url: https://{apigw-address}/tsdb-service/v2.1/data/delete-detail?orgId=yourOrgId&queryId=yourModelID&pageSize=10&pageNo=1
method: GET
返回示例¶
{
"msg": "OK",
"code": 0,
"data": {
"list": [
{
"id": "302037106667073536",
"status": 2,
"endTime": " 1615530701240",
"modelId": "yourModelId",
"assetIds": "yourAssetIds",
"operator": "user.name",
"startTime": "1615444301240",
"finishTime": "2021-03-12T10:37:46.353+0000",
"launchTime": "2021-03-12T10:37:16.383+0000",
"measurement": "yourPointIds"
}
],
"total": 2,
"pageNum": 1,
"pageSize": 10
},
"submsg": "success"
}
SDK 示例¶
你可以在 Github 上获取 TSDB 数据服务的 Java SDK 示例。