CancelTask

更新时间:
复制 MD 格式

Cancels a running task. You can cancel the running tasks generated by the ImportImage or ExportImage operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:CancelTask

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The ID of the task. You can call the DescribeTasks operation to query the list of task IDs.

cn-hangzhou

TaskId

string

Yes

The ID of the request.

t-bp198jigq7l0h5ac****

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error response

JSON format

{
    "RequestId": "4BE2C7FE-C7A4-4675-A153-174E032AABFB"
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter An input parameter "RegionId" that is mandatory for processing the request is not supplied.
400 InvalidRegionId.NotFound The specified RegionId does not exist.
400 InvalidTaskId.NotFound The specified "TaskId" is not found. The specified task does not exist
403 InvalidTaskId.TaskActionNotSupport The specified task action not support. The specified task action is not supported.
403 InvalidTaskId.IncorrectTaskStatus The specified task status is invalid. The task state is invalid.
403 CancelTaskFailed The task is failed to cancel, Please contact the administrator.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.