CancelImagePipelineExecution-阿里云帮助中心

Operation description

Before you call the CancelImagePipelineExecution operation, make sure that the image building task to be canceled is in the BUILDING, PREPARING, or REPAIRING state.

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:CancelImagePipelineExecution

update

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
TemplateTag	array<object>	No	Note This parameter is not publicly available.
	object	No	Note This parameter is not publicly available.
Key	string	No	Note This parameter is not publicly available.	null
Value	string	No	Note This parameter is not publicly available.	null
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ExecutionId	string	Yes	The ID of the image building task.	exec-5fb8facb8ed7427c****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStatus.CancelFailed	Failed to cancel execution,status is success, failed or cancelled.
403	InvalidStatus.ImagePipelineExecution	%s
404	InvalidImagePipelineExecution.NotFound	The specified image pipeline execution does not exist!
404	InvalidImagePipelineExecutionId.NotFound	The specified ImagePipelineExecutionId does not exist.	The specified ImagePipelineExecutionId resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.