All Products
Search
Document Center

App Streaming:ModifyAppInstanceGroupAttribute

Last Updated:Dec 17, 2025

Modifies the general policies of a delivery group, including the number of concurrent sessions and the retention period of disconnected sessions.

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:ModifyAppInstanceGroupAttributeupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductTypestringYes

The product type.

Valid value:

  • CloudApp: App Streaming
CloudApp
AppInstanceGroupIdstringYes

The ID of the delivery group.

aig-9ciijz60n4xsv****
AppInstanceGroupNamestringNo

The name of the delivery group.

SessionTimeoutintegerNo

The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to -1. Valid values:-1 and 3 to 300. Default value: 15.

15
NodePoolobjectNo

The information about the resource group.

NodePoolIdstringNo

The ID of the resource group.

rg-ew7va2g1wl3vm****
NodeCapacityintegerNo

The maximum number of sessions to which a resource can connect at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource type. The following items describe the value ranges of different resource types:

  • appstreaming.general.4c8g: 1 to 2
  • appstreaming.general.8c16g: 1 to 4
  • appstreaming.vgpu.8c16g.4g: 1 to 4
  • appstreaming.vgpu.8c31g.16g: 1 to 4
  • appstreaming.vgpu.14c93g.12g: 1 to 6
2
StoragePolicyobjectNo

The storage policy.

StorageTypeListarrayNo

The storage types.

stringNo

The storage type.

Valid values:

  • OFF: disabled
  • PDS: Photo and Drive Service
PDS
UserProfileobjectNo

The configurations of user data roaming.

UserProfileSwitchbooleanNo

Specifies whether user data roaming is enabled.

Valid values:

  • true
  • false
false
FileSystemIdstringNo

The ID of the File Storage NAS (NAS) file system used to store user data.

06ae94****
SecurityPolicyobjectNo

The security policy.

SkipUserAuthCheckbooleanNo

Specifies whether to skip user permission verification.

Valid values:

  • true
  • false: This is the default value.
false
ResetAfterUnbindbooleanNo

Specifies whether to reset after unbinding from a delivery group.

Valid values:

  • true
  • false
true
PreOpenModestringNo

The pre-open mode.

Valid values:

  • SINGLE_APP: enables the pre-open mode for a single application.
  • OFF: disables the pre-open mode. This is the default value.
OFF
PreOpenAppIdstringNo

The application ID of the pre-open application. If you set PreOpenMode to SINGLE_APP, you cannot leave this parameter empty.``

ca-b2ronxxd****
PerSessionPerAppbooleanNo

Specifies whether only one application can be opened in a session.

  • After you enable this feature, the system assigns a session to each application if you open multiple applications in a delivery group. This consumes a larger number of sessions.

Valid values:

  • true
  • false
false
NetworkobjectNo

The network settings.

Note If you want to use this parameter, submit a ticket.
DomainRulesarray<object>No

The domain name rules.

objectNo
DomainstringNo

The domain name.

www.example.com
PolicystringNo

The policy used for the domain name.

Valid values:

  • allow
  • block
block

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
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****",
  "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
2025-02-13The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-27The request parameters of the API has changedView Change Details
2023-08-21The request parameters of the API has changedView Change Details
2023-06-08The request parameters of the API has changedView Change Details
2023-04-28The request parameters of the API has changedView Change Details