Updated on 2024-01-12 GMT+08:00

Stopping a Flow

Function

This API is used to stop a flow.

URI

POST /v2/{project_id}/fgs/workflows/{workflow_id}/executions/{execution_id}/terminate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Minimum: 1

Maximum: 64

workflow_id

Yes

String

Flow ID.

Minimum: 1

Maximum: 512

execution_id

Yes

String

Flow instance ID.

Minimum: 1

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 400

Table 2 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 36

error_msg

String

Error description.

Minimum: 2

Maximum: 512

request_id

String

Request ID.

Minimum: 2

Maximum: 512

Status code: 404

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 36

error_msg

String

Error description.

Minimum: 2

Maximum: 512

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 36

error_msg

String

Error description.

Minimum: 2

Maximum: 512

request_id

String

Request ID.

Minimum: 2

Maximum: 512

Example Requests

Stop executing instance {execution_id} of a function.

POST /v2/{project_id}/fgs/workflows/{workflow_id}/executions/{execution_id}/terminate

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Bad Request

500

Internal Server Error

Error Codes

See Error Codes.