Updated on 2024-06-28 GMT+08:00

Terminating a Task

Function

This API is used to terminate a task that is being executed. You can specify a workflow ID and execution ID. The termination status will be returned.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/terminate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Minimum: 32

Maximum: 32

workflow_id

Yes

String

Task ID, which is the workflow ID obtained from the workflow command list.

Minimum: 1

Maximum: 64

execution_id

Yes

String

Task execution ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Minimum: 1

Maximum: 40960

Content-Type

Yes

String

Content type, which is application/json.

Minimum: 1

Maximum: 32

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Response code.

Minimum: 1

Maximum: 64

error_msg

String

Error message.

Minimum: 1

Maximum: 1024

http_code

Integer

HTTP response code.

Minimum: 0

Maximum: 999

Example Requests

Specify workflow_id and execution_id to terminate a task that is being executed.

https://{Endpoint}/v1/{project_id}/cms/workflow/{workflow_id}/executions/{execution_id}/terminate

Example Responses

Status code: 200

The task is terminated successfully.

{
  "result" : "success"
}

Status code: 400

Bad Request: Invalid request. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.31001418",
  "error_msg" : "The task does not support the current operation.",
  "http_code" : 400
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "AOM.31009004",
  "error_msg" : "auth failed.",
  "http_code" : 401
}

Status code: 404

The task to be terminated does not exist.

{
  "error_code" : "AOM.31001306",
  "error_msg" : "Execution not exist. recordInfo is not exist.",
  "http_code" : 404
}

Status code: 500

Internal server error.

{
  "error_code" : "AOM.31001405",
  "error_msg" : "workflow internal server error.",
  "http_code" : 500
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v1.region.AomRegion;
import com.huaweicloud.sdk.aom.v1.*;
import com.huaweicloud.sdk.aom.v1.model.*;


public class StopExecutionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        StopExecutionRequest request = new StopExecutionRequest();
        try {
            StopExecutionResponse response = client.stopExecution(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v1.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = StopExecutionRequest()
        response = client.stop_execution(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.StopExecutionRequest{}
	response, err := client.StopExecution(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The task is terminated successfully.

400

Bad Request: Invalid request. The client should not repeat the request without modifications.

401

Unauthorized: The authentication information is incorrect or invalid.

404

The task to be terminated does not exist.

500

Internal server error.

Error Codes

See Error Codes.