Cancels an ongoing image copy task.
Operation description
When you call this operation, take note of the following items:
- After you cancel an image copy task, the image copy created in the destination region is deleted, and the copied image remains unchanged.
- If the image copy task is complete, the CancelCopyImage operation fails, and an error is returned.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:CancelCopyImage | update | *Image acs:ecs:{#regionId}:{#accountId}:image/{#imageId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the image copy. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ImageId | string | Yes | The ID of the image that is being copied. | m-bp1caf3yicx5jlfl**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | ImageCreatedNotFromCopy | The specified image is not the target image of a copy action. | The specified image ID is not the ID of the image that is being copied. |
| 400 | InvalidDescription.Malformed | The specified description is wrongly formed. | The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://. |
| 400 | IncorrectImageStatus | The specified snapshot is not coping. | The specified snapshot is not being copied. |
| 400 | IncorrectImageStatus | The specified image is not coping. | The specified image is not being copied. |
| 400 | IncorrectImageStatus | The Image copy has been failed. | The image cannot be copied. |
| 400 | CancelNotSupported | The specified image coping can not be cancelled. | The copy task cannot be canceled. |
| 400 | IncorrectImageStatus | The image copy has completed. | The image copy has completed. |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | The specified region ID does not exist. |
| 404 | InvalidImageId.NotFound | The specified ImageId does not exist. | The specified image does not exist in this account. Check whether the image ID is correct. |
| 500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-17 | API Description Update. The Error code has changed | View Change Details |
| 2023-07-12 | The Error code has changed | View Change Details |