Call DeleteImage API to Remove Custom Images - App Streaming - Alibaba Cloud - App Streaming

Deletes a custom WUYING image.

Operation description

You can delete only custom images that belong to your account.
For images associated with WUYING Cloud Computer Pool, WUYING Cloud Application, or WUYING Workspace product lines, ensure that no WUYING instances are using the image before you delete it.
If a WUYING Cloud Desktop template references the image, the template is also deleted when the image is deleted.
For images that span multiple regions, deleting the image removes it from all regions.

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

appstreaming:DeleteImage

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The WUYING image ID.	img-bp13mu****

Response elements

Element	Type	Description	Example
	object	The response struct.
Data	boolean	Indicates whether the deletion is successful. Valid values: true: Deletion succeeded. false: Deletion failed. Valid values: true : Deletion succeeded. false : Deletion failed.	true
Success	boolean	Indicates whether the request is successful.	true
Code	string	The status code. Valid values: `200`: Success. `400`: Error.	200
Message	string	The error message returned when an error occurs.	successful
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "Data": true,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	Internal error.
400	Image.NotExist	The image does not exist.	The image does not exist.
400	ImageDeleteFailed.NotAllow	The image is not allowed to be deleted.	The image is not allowed to be deleted.
400	ImageDeleteFailed.NotAllowCommunityParent	The parent image of a community image is not allowed to be deleted.	The parent image of a community image is not allowed to be deleted.
400	ImageDeleteFailed.NotAllowSharedImage	The shared image is not allowed to be deleted.	The shared image is not allowed to be deleted.
400	ImageNotAllowDelete	The image cannot be deleted, because shared cloud computers already exist.	The image cannot be deleted, because shared cloud computers already exist.
400	InvalidImageOperation.ImageIsCreating	Failed to operation the image, it is creating.	Failed to operation the image, it is creating.
400	DeleteTemplate.Failed	Delete template failed.	Failed to delete the template.
400	QueryTemplate.Failed	Query template failed.	Failed to query the template.
400	InvalidTemplate.NotFound	Template not found.	The template is not found.
400	ImageDeleteFailed.HasSharedImage	The shared image is not allowed to be deleted.	The shared image is not allowed to be deleted.
500	ServiceUnavailable	Service unavailable. Please try again later.	Service unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.