Stopping a Flow Task
Function
Stops a flow task.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
Action | Access Level | Resource Type (*: required) | Condition Key | Alias | Dependencies |
|---|---|---|---|---|---|
live:ott:updateFlowStatusStop | Write | - | - | - | - |
URI
PUT /v1/{project_id}/flows/stop
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain the project ID, see "Obtaining a Project ID". |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
flow_id | Yes | String | Flow ID |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | No | String | User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Authorization | No | String | Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date | No | String | Request time. This parameter is mandatory for AK/SK authentication. |
X-Project-Id | No | String | Project ID. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
status | String | Status. The value can be ACTIVE (running) or STANDBY (not started). |
flow_id | String | Flow ID |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Example Requests
None
Example Responses
Status code: 200
Response indicating a successful flow status change
{
"flow_id" : "ec897482-d24b-4d64-aa39-407980902b1d",
"status" : "STANDBY"
} Status code: 400
Response indicating a failure
{
"error_code" : "LIVE.100011001",
"error_msg" : "flow task is in standby status"
} Status Codes
Status Code | Description |
|---|---|
200 | Response indicating a successful flow status change |
400 | Response indicating a failure |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
