DocsICP FilingConsole
Documentation

ListAuthorizedAppInstanceGroupByUser

Updated at:
Copy as MD
Product
My Favorites

Queries the delivery groups for which a specified user has obtained access permissions through delivery group-level authorization by paging, with support for fuzzy filtering by delivery group ID, delivery group name, application ID, or application name.

Operation description

Operation description

This operation queries the list of delivery groups for which a specified user (EndUserId) has been granted delivery group-level authorization. The response includes basic information about each delivery group (ID, name, status, region, creation time, expiration time, and more) and the list of applications deployed in the delivery group.

Scope of returned results:

  • Only delivery groups that are authorized to the user as a whole through the AuthorizeInstanceGroup operation are returned. Records authorized on a per-application basis through the AuthorizeUsersForApp operation are not included.

  • Only delivery groups whose product type matches the ProductType parameter and that have not been deleted are returned. A delivery group is not returned if its image contains no deployed applications.

  • Results are sorted in reverse chronological order by the update time of the authorization record. The most recently authorized or modified delivery groups appear first.

Before you begin

Parameter description

  • ProductType and EndUserId are required. If ProductType is not specified, the error code InvalidParameter.ProductType is returned. If EndUserId is not specified, the error code InvalidParameter.UserId is returned.

  • EndUserId performs an exact match on the username. AppInstanceGroupId, AppInstanceGroupName, AppId, and AppName all perform fuzzy matching (a hit occurs if the value is contained). When multiple filter conditions are specified, all conditions must be met simultaneously.

  • PageNumber starts from 1. Valid values of PageSize: 1 to 100.

  • If the user has no authorized delivery groups that match the conditions, the operation returns normally: AppInstanceGroupModels is an empty list and TotalCount is 0.

Call sequence

  1. Call the ListAppInstanceGroup operation to obtain the delivery group ID, and then call the AuthorizeInstanceGroup operation to authorize the delivery group to the user.

  2. Call this operation to query the delivery groups authorized to the user and the applications deployed in each delivery group.

  3. To obtain an application connection ticket for the user, call the GetConnectionTicket operation with the AppInstanceGroupId and the AppId from the Apps list in the response.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
ProductType

string

Yes

The product type. The value must match the product type of the delivery groups to query. Only delivery groups of the specified product type are returned.

Valid values:

  • CloudApp: WUYING Cloud Application.

  • CloudBrowser: cloud browser.

  • WuyingServer: Enterprise Edition workstation.

  • WuyingWorkstation: Personal Edition Lingjun container workstation.

  • WuyingWorkstationTeam: Team Edition Lingjun container workstation.

  • WuyingWorkstationBusiness: Dedicated Edition Lingjun container workstation.

  • AndroidCloud: cloud phone.

  • AIAgent: AgentBay (AI agent).

Valid values:

  • WuyingWorkstation :

    Personal Edition Lingjun container workstation.

  • WuyingWorkstationTeam :

    Team Edition Lingjun container workstation.

  • CloudApp :

    WUYING Cloud Application.

  • CloudBrowser :

    cloud browser.

  • AIAgent :

    AgentBay (AI agent)

  • AndroidCloud :

    cloud phone.

  • WuyingWorkstationBusiness :

    Dedicated Edition Lingjun container workstation.

  • WuyingServer :

    Enterprise Edition workstation.

CloudApp
PageNumber

integer

Yes

The page number. Pages start from page 1.

1
PageSize

integer

Yes

The number of delivery groups to return per page. Valid values: 1 to 100.

10
AppInstanceGroupId

string

No

The delivery group ID. Fuzzy matching is supported: delivery groups whose IDs contain the specified string are returned. You can call the ListAppInstanceGroup operation to obtain the delivery group ID.

If this parameter is not specified, no filtering by delivery group ID is applied.

aig-9ciijz60n4xsv****
AppId

string

No

The application ID. Fuzzy matching is supported: delivery groups that contain a deployed application whose ID includes the specified string are returned. You can obtain the application ID from the Apps list returned by this operation.

If this parameter is not specified, no filtering by application ID is applied.

ca-i87mycyn419nu****
EndUserId

string

Yes

The username. An exact match is performed on the username to query the delivery groups for which the user has been granted delivery group-level authorization.

Note

This parameter is required. If this parameter is not specified, the error code InvalidParameter.UserId is returned.

alice
AppInstanceGroupName

string

No

The delivery group name. Fuzzy matching is supported. For example, if you set this parameter to Office App, delivery groups whose names contain Office App (such as My Office App or Office App A) are returned.

If this parameter is not specified, no filtering by delivery group name is applied.

Office App
AppName

string

No

The application name. Fuzzy matching is supported: delivery groups that contain a deployed application whose name includes the specified string are returned.

If this parameter is not specified, no filtering by application name is applied.

Office App

Response elements

Element

Type

Description

Example

object

Schema of Response

AppInstanceGroupModels

array<object>

The list of authorized delivery groups on the current page. This is an empty list if the user has no authorized delivery groups that match the conditions.

array<object>

AppCenterImageId

string

The ID of the application image used by the delivery group.

img-8z4nztpaqvay4****
AppInstanceGroupId

string

The delivery group ID. You can pass this value to the GetConnectionTicket operation to specify the delivery group to connect to.

aig-9ciijz60n4xsv****
AppInstanceGroupName

string

The delivery group name.

Office App
AppInstanceType

string

The specification type of the delivery group.

__dynamic__
Apps

array<object>

The list of applications deployed in the delivery group. This list includes all deployed applications in the delivery group image and is not affected by the AppId or AppName request parameters.

object

AppIcon

string

The URL of the application icon.

https://app-center-icon-****.png
AppId

string

The application ID. Pass this value to the GetConnectionTicket operation to obtain a connection ticket for the application.

ca-i87mycyn419nu****
AppName

string

The application name.

Office App
AppVersion

string

The application version number.

1.0.0
AppVersionName

string

The application version name.

Initial version
ExpiredTime

string

The expiration time of the delivery group. The value is in the ISO 8601 datetime format with milliseconds and a time zone offset. The returned time zone offset is +00:00. Format: yyyy-MM-ddTHH:mm:ss.SSS+HH:mm.

2022-04-27T16:00:00.000+00:00
GmtCreate

string

The creation time of the delivery group. The value is in the ISO 8601 datetime format with milliseconds and a time zone offset. The returned time zone offset is +00:00. Format: yyyy-MM-ddTHH:mm:ss.SSS+HH:mm.

2022-04-26T15:06:16.000+00:00
RegionId

string

The region ID of the delivery group. For more information about supported regions, see Limits.

cn-hangzhou
Status

string

The delivery group status. Valid values:

  • DEPLOYING: The delivery group is being created or starting resources and is not yet connectable.

  • DEPLOYED: The delivery group is deployed. Resources are ready but the delivery group has not been listed for service.

  • PUBLISHED: The delivery group is published and listed. Users can connect to and use the delivery group.

  • STOPPING: The delivery group is being delisted and is stopping service.

  • STOPPED: The delivery group is delisted and has stopped service. Users cannot connect.

  • MAINTAINING: The delivery group is being maintained or updated.

  • FAILED: The delivery group failed to publish. Resource initialization failed.

  • MAINTAIN_FAILED: The update failed. Maintenance or changes were not successful.

  • DELETING: The delivery group is being deleted.

Note

Deleted delivery groups are not returned.

Valid values:

  • DEPLOYED :

    deployed (pending listing)

  • PUBLISHED :

    published.

  • FAILED :

    publish failed.

  • MAINTAIN_FAILED :

    update failed.

  • STOPPED :

    delisted.

  • MAINTAINING :

    updating.

  • DELETING :

    deleting.

  • STOPPING :

    delisting.

  • DEPLOYING :

    deploying.

PUBLISHED
PageNumber

integer

The current page number. This value is the same as the PageNumber request parameter.

1
PageSize

integer

The number of delivery groups returned per page. This value is the same as the PageSize request parameter.

10
RequestId

string

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount

integer

The total number of authorized delivery groups that match the filter conditions.

3

Examples

Success response

JSON format

{
  "AppInstanceGroupModels": [
    {
      "AppCenterImageId": "img-8z4nztpaqvay4****",
      "AppInstanceGroupId": "aig-9ciijz60n4xsv****",
      "AppInstanceGroupName": "办公应用",
      "AppInstanceType": "__dynamic__",
      "Apps": [
        {
          "AppIcon": "https://app-center-icon-****.png",
          "AppId": "ca-i87mycyn419nu****",
          "AppName": "办公应用",
          "AppVersion": "1.0.0",
          "AppVersionName": "初始版本"
        }
      ],
      "ExpiredTime": "2022-04-27T16:00:00.000+00:00",
      "GmtCreate": "2022-04-26T15:06:16.000+00:00",
      "RegionId": "cn-hangzhou",
      "Status": "PUBLISHED"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 3
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.