Control Session Limits by Modifying Delivery Group Policies - App Streaming - Alibaba Cloud - App Streaming

Modifies the General Policy of a delivery group, including the number of concurrent sessions and the session retention duration after disconnection.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductType	string	Yes	The product type. Valid values: CloudApp : WUYING Cloud Application.	CloudApp
AppInstanceGroupId	string	Yes	The delivery group ID.	aig-9ciijz60n4xsv****
AppInstanceGroupName	string	No	The delivery group name.	办公应用
SessionTimeout	integer	No	The session retention duration after disconnection, in minutes. After an end user session is disconnected, the session is retained for the specified duration before being logged off. Set this parameter to `-1` to retain the session indefinitely. Valid values: -1 and 3 to 300. Default value: `15`.	15
NodePool	object	No	The resource group object.
NodePoolId	string	No	The resource group ID.	rg-ew7va2g1wl3vm****
NodeCapacity	integer	No	The number of concurrent sessions, which is the number of sessions that can be simultaneously connected to a single resource. Too many simultaneous sessions may degrade the application experience. The valid value range varies by resource specification. You can call the ListNodeInstanceType operation to query the valid value range for each resource specification.	2
StoragePolicy	object	No	The storage policy.
StorageTypeList	array	No	The list of storage types.
	string	No	The storage type. Valid values: OFF : disabled. PDS : Drive and Photo Service.	PDS
UserProfileFollow	object	No
ProfileFollowSwitch	boolean	No
FileSystemId	string	No
UserProfile	object	No	The user data roaming configuration.
UserProfileSwitch	boolean	No	Specifies whether to enable user data roaming. Valid values: true : Enabled. false : Disabled.	false
FileSystemId	string	No	The ID of the user data storage system (NAS ID).	06ae94****
SecurityPolicy	object	No	The security policy.
SkipUserAuthCheck	boolean	No	Specifies whether to skip user authorization verification. Valid values: true : Skip verification. false : Perform verification. [Default].	false
ResetAfterUnbind	boolean	No	Specifies whether to reset after unbinding. Valid values: true : Reset. false : Do not reset.	true
PreOpenMode	string	No	The pre-open mode. Valid values: SINGLE_APP : pre-open a single application. OFF : disable pre-open [Default].	OFF
PreOpenAppId	string	No	The AppId of the pre-open application. If the PreOpenMode parameter is set to `SINGLE_APP`, PreOpenAppId cannot be an empty string.	ca-b2ronxxd****
PerSessionPerApp	boolean	No	Specifies whether to allow only one application per session. If enabled, opening multiple applications within a delivery group allocates a separate session for each application, consuming more sessions. Valid values: true : Enabled. false : Disabled.	false
Network	object	No	The network configuration. Note To use this parameter, submit a ticket.
DomainRules	array<object>	No	The domain name rule configurations.
	object	No	The domain name rule.
Domain	string	No	The domain name.	www.example.com
Policy	string	No	The policy value. Valid values: allow : Allow access. block : Block access.	block

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Code	string	The error code returned if the request failed.	InvalidParameter.ProductType
Message	string	The error message returned if the request failed.	The parameter ProductType is invalid.

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "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.