Delete Stage State

Delete the intermediate state data of a specified operator (stage) in a stream processing pipeline.

Prerequisites

  • Stream data processing pipelines have been created with the calculator library of the Stream Processing service.

  • Before calling this API, ensure that the target stream processing pipeline is paused.

Request Format

POST https://{apigw-address}/streaming/v2.0/stage-state?action=delete

Request Parameters (URI)

Name

Location (Path/Query)

Mandatory/Optional

Data Type

Description

orgId

Query

Mandatory

String

The organization ID. How to get the orgId>>

Request Parameters (Body)

Name

Mandatory/Optional

Data Type

Description

pipelineId

Mandatory

String

The stream processing pipeline ID, which can be found on the EnOS Management Console > Stream Processing > Stream Operation page.

stageInstanceName

Mandatory

String

The stage instance name, which can be found on the Stream Development page. Click the stream processing pipeline name, select the target operator, and copy the stage instance name on the Info page.

assetIds

Mandatory

String

The asset ID. Supports the query of multiple asset IDs, separated by commas.

pointIds

Mandatory

String

The measurement point ID. Supports the query of multiple measurement point IDs, separated by commas. The upper limit of the number of measurement points that can be queried is 100,000.

Response Parameters

Name

Data Type

Description

data

Boolean

  • true = data is deleted

  • false = failed to delete data

Error Code

Code

Error Information

Description

61102

Missing param xx

The parameter format or value is not valid.

61105

Too many points

The number of requested measurement points exceeds the limit.

61106

Wrong pipelineId or OU has no privilege

The provided pipeline ID is not valid, or the pipeline ID and organization ID do not match.

61107

Not supported stage type

The specified stage type is not supported.

61199

Other errors.

Samples

Request Sample

url: https://{apigw-address}/streaming/v2.0/stage-state?action=delete&orgId=yourOrgId

method: POST

requestBody:
{
    "pipelineId":"yourPipelineId",
    "stageInstanceName":"yourStageInstanceName",
    "assetIds":"yourAssetIds",
    "pointIds":"yourPointIds"
}

Return Sample

{
  "code": 0,
  "msg": " OK",
  "data": true
}

SDK Samples


You can access the SDK samples for stream processing service on GitHub: