All Products
Search
Document Center

App Streaming:DeleteAppInstances

Last Updated:Dec 17, 2025

Deletes an application instance.

Operation description

Only application instances that are in the Initializing or Idle state can be deleted. The operation can be called only by specific customers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
appstreaming:DeleteAppInstancesdelete
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductTypestringYes

The product type.

Valid value:

  • CloudApp: App Streaming
CloudApp
AppInstanceGroupIdstringYes

The ID of the delivery group. You can call the listAppInstanceGroup operation to obtain the ID.

aig-9ciijz60n4xsv****
AppInstanceIdsarrayYes

The IDs of application instances.

stringYes

The ID of the application instance.

Note This parameter is available only for specific customers.
ai-gbuea*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DeleteAppInstanceModelsarray<object>

The data returned.

dataobject
AppInstanceIdstring

The ID of the application instance.

ai-gbuea*****
Successboolean

Specifies whether the application instance is deleted.

Valid values:

  • true
  • false
true
Codestring

The error code.

InvalidParameter.ProductType
Messagestring

The error message.

The parameter ProductType is invalid.

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history