Queries the details of multiple delivery groups that meet the query conditions.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| appstreaming:ListAppInstanceGroup | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageSize | integer | No | The number of entries per page. The value cannot be greater than | 10 |
| PageNumber | integer | No | The page number. | 1 |
| Status | array | No | The status of the delivery groups. | |
| string | No | The status of the delivery group. Valid values:
| "Status.1":"PUBLISHED","Status.2":"FAILED" | |
| AppInstanceGroupId | string | No | The ID of the delivery group. | aig-9ciijz60n4xsv**** |
| ProductType | string | Yes | The product type. Valid value:
| CloudApp |
| AppInstanceGroupName | string | No | The name of the delivery groups to query. Fuzzy match is used for queries. For example, if you set this parameter to | |
| AppCenterImageId | string | No | The image ID of the app. You can obtain the ID from the Images page in the App Streaming console. | img-8z4nztpaqvay4**** |
RegionIddeprecated | string | No | The region ID | cn-hangzhou |
| BizRegionId | string | No | The ID of the region where the delivery group resides. For information about the supported regions, see Limits . Valid values:
| cn-hangzhou |
| NodeInstanceType | string | No | The ID of the resource specification that you purchase. You can call the ListNodeInstanceType operation to obtain the ID. | appstreaming.vgpu.4c8g.2g |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TotalCount": 15,
"PageSize": 10,
"PageNumber": 1,
"AppInstanceGroupModels": [
{
"Apps": [
{
"AppId": "ca-i87mycyn419nu****",
"AppName": "",
"AppVersion": "1.0.0",
"AppVersionName": "",
"AppIcon": "https://app-center-icon-****.png"
}
],
"AppCenterImageId": "img-8z4nztpaqvay4****",
"RegionId": "cn-hangzhou",
"ProductType": "CloudApp",
"AppInstanceType": "__dynamic__",
"AppInstanceGroupId": "aig-9ciijz60n4xsv****",
"Amount": 1,
"MinAmount": 1,
"MaxAmount": 10,
"ReserveAmountRatio": 20,
"ReserveMinAmount": 1,
"ReserveMaxAmount": 5,
"ScalingStep": 10,
"ScalingUsageThreshold": 85,
"ScalingDownAfterIdleMinutes": 5,
"ChargeType": "PrePaid",
"GmtCreate": "2022-04-26T15:06:16.000+00:00",
"Status": "PUBLISHED",
"NodePool": [
{
"NodePoolId": "rg-g6922kced36hx****",
"NodeInstanceType": "appstreaming.vgpu.4c8g.2g",
"NodeAmount": 1,
"NodeUsed": 1,
"NodeCapacity": 2,
"ScalingNodeAmount": 8,
"ScalingNodeUsed": 4,
"StrategyType": "NODE_FIXED",
"Amount": 2,
"MaxScalingAmount": 8,
"MaxIdleAppInstanceAmount": 3,
"ScalingStep": 2,
"ScalingUsageThreshold": 85,
"ScalingDownAfterIdleMinutes": 5,
"RecurrenceSchedules": [
{
"RecurrenceType": "Weekly",
"RecurrenceValues": [
1
],
"TimerPeriods": [
{
"Amount": 5,
"EndTime": "11:00",
"StartTime": "09:30"
}
]
}
],
"StrategyDisableDate": "2022-09-08",
"StrategyEnableDate": "2022-08-01",
"WarmUp": false,
"NodeTypeName": ""
}
],
"SpecId": "spec-8o18t8uc31qib0****",
"SessionTimeout": 15,
"AppInstanceGroupName": "",
"ExpiredTime": "2022-04-27T16:00:00.000+00:00",
"OtaInfo": {
"OtaVersion": "0.0.1-D-20220615.11****",
"NewOtaVersion": "0.0.1-D-20220630.11****",
"TaskId": "ota-e49929gv8acz5****"
},
"OsType": "Windows",
"ResourceStatus": "AVAILABLE",
"AppPolicyId": "pg-g3k5wa2ms2****",
"ChargeResourceMode": "Node",
"SkipUserAuthCheck": false,
"OfficeSiteId": "cn-beijing+dir-172301****\n",
"AppPolicyVersion": "CENTER",
"AppPolicyImageCheck": false,
"ResourceTags": [
{
"Key": "department",
"Value": "design",
"Scope": "Custom"
}
]
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-27 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2025-03-12 | The response structure of the API has changed | View Change Details |
| 2025-01-15 | The response structure of the API has changed | View Change Details |
| 2024-10-22 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-09-12 | The response structure of the API has changed | View Change Details |
| 2024-07-19 | The request parameters of the API has changed | View Change Details |
| 2023-11-15 | The request parameters of the API has changed | View Change Details |
| 2023-11-15 | The request parameters of the API has changed | View Change Details |
| 2023-05-12 | The response structure of the API has changed | View Change Details |
| 2023-04-28 | The response structure of the API has changed | View Change Details |
| 2023-03-07 | The response structure of the API has changed | View Change Details |