Stop Pipeline¶
Stop a specific stream processing pipeline.
Prerequisites¶
Status of the stream processing pipeline is RUNNING or PAUSED, and the pipeline ID is available.
Request Format¶
POST https://{apigw-address}/streaming/v2.0/streaming/pipeline/{pipelineId}?action=stop
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|---|
pipelineId |
Path |
Mandatory |
String |
The stream processing pipeline ID, which can be found on the EnOS Management Console > Stream Processing > Stream Operation page. |
orgId |
Query |
Mandatory |
String |
The organization ID. How to get the orgId>> |
Response Parameters¶
Name |
Data Type |
Description |
|---|---|---|
data |
String |
Returns an empty string upon success. |
Error Code¶
Code |
Error Information |
Description |
|---|---|---|
61108 |
stream processing pipeline does not exit. |
Stream processing pipeline does not exist. Please check the pipeline ID. |
61122 |
Failed to stop the stream processing pipeline. |
Failed to stop the stream processing pipeline. |
61152 |
Status of the stream processing job cannot be changed from [XX] to Stopped. |
The stream processing job cannot be stopped in current state. |
Sample¶
Request Sample¶
url: https://{apigw-address}/streaming/v2.0/streaming/pipeline/{pipelineId}?action=stop
method: POST
Return Sample¶
{
"code": 0,
"msg": "OK",
}