Delete application instances using DeleteAppInstances - App Streaming - Alibaba Cloud - App Streaming

Operation description

Only instances in the init or idle state can be deleted. This operation is available only to specific customers.

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

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductType	string	Yes	The product type. Valid values: CloudApp : WUYING Workspace.	CloudApp
AppInstanceGroupId	string	Yes	The delivery group ID. You can call ListAppInstanceGroup to obtain this parameter.	aig-9ciijz60n4xsv****
AppInstanceIds	array	Yes	The list of application instance IDs.
	string	Yes	The application instance ID. Note Only specific customers can obtain this parameter.	ai-gbuea*****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DeleteAppInstanceModels	array<object>	The list of instance deletion results.
	object	The instance deletion result.
AppInstanceId	string	The application instance ID.	ai-gbuea*****
Success	boolean	Indicates whether the deletion is triggered. Valid values: true : The deletion is triggered. false : The deletion failed to be triggered.	true
Code	string	The error code returned when an error occurs.	InvalidParameter.ProductType
Message	string	The error message returned when an error occurs.	The parameter ProductType is invalid.

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "DeleteAppInstanceModels": [
    {
      "AppInstanceId": "ai-gbuea*****\n",
      "Success": true,
      "Code": "InvalidParameter.ProductType",
      "Message": "The parameter ProductType is invalid."
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.