Help Center/ CodeArts Deploy/ API Reference/ APIs/ Execution/ Stopping a Deployment Task
Updated on 2025-08-18 GMT+08:00

Stopping a Deployment Task

Function

This API is used to stop a deployment task.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/tasks/{task_id}/records/{record_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

task_id

record_id

Yes

String

record_id

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

EmptyRequestBody

Yes

String

EmptyRequestBody

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

CancelInfo object

Basic task information

status

String

Request status (successful or failed)

Table 5 CancelInfo

Parameter

Type

Description

id

String

Execution record ID

task_id

String

Task ID

Example Requests

{*#^*%@#$%&*%^&@#&&&#%*^}

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "result" : {
    "id" : "2c82ffe8d00d4968a4e5f7a36d87ae17",
    "task_id" : "e700f15965694253940502911220d76b"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.