Submit Data Deletion Job¶

Submit a data deletion job to delete the historical data of specified assets stored in TSDB.

Operation Permissions¶

Required Authorization	Required Operation Permission
Asset	Write

For more information about resources and required permission, see Policies, Roles and Permissions>>

Request Format¶

POST https://{apigw-address}/tsdb-service/v2.1/data/tsdb-delete

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get organization ID>>

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
modelId	Mandatory	String	Specify the model to which the data belongs. How to get model Id>>
pointId	Optional	String	Specify the measurement point to which the data belongs. If no point is specified, all the measurement point data of the specified model and assets will be deleted. How to get measurement point ID>>
assetIds	Mandatory	String	The asset ID. Supports deleting the historical data of multiple assets, separated by commas. How to get asset ID>>
startTime	Mandatory	String	Specify the time range of the data to be deleted (start time), for example: 1615444301240
endTime	Mandatory	String	Specify the time range of the data to be deleted (end time), for example: 1615530701240

Response Parameters¶

Name	Data Type	Description
data	Number	Return the data deletion job ID.

Error Code¶

For the description of error codes, see Common Error Codes.

Sample¶

Request Sample¶

url: https://{apigw-address}/tsdb-service/v2.1/data/tsdb-delete?orgId=yourOrgId

method: POST

requestBody:
{
  "pointId": "yourPointId",
  "modelId": "yourModelId",
  "assetIds": "yourAssetIds",
  "startTime": "1615444301240",
  "endTime": "1615530701240"
}

Return Sample¶

{
  "msg": "OK",
  "code": 0,
  "data": 302037106667073536,
  "submsg": "success"
}

SDK Samples¶

You can access the Java SDK Samples for TSDB data service on Github.