Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Application Group Management/ Querying Application Groups
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Application Groups

Function

Queries created application groups by name or authorization type.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:appGroup:list

    List

    appGroup *

    -

    -

    -

URI

GET /v1/{project_id}/app-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of records for each query ranges from 1 to 100. The default value is 10.

offset

No

Integer

Query offset. The default value is 0.

app_server_group_id

No

String

Application server group ID.

app_group_id

No

String

Application group ID.

name

No

String

Application group name.

authorization_type

No

String

Permissions granted to:

APP: applications

APP_GROUP: application groups

app_type

No

String

Application group type:

SESSION_DESKTOP_APP: session desktop application

COMMON_APP: common application

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total.

items

Array of AppGroup objects

Application group list.
Table 5 AppGroup

Parameter

Type

Description

id

String

Application group ID.

name

String

Application group name.

app_server_group_id

String

Application server group ID.

app_server_group_name

String

Application server group name.

description

String

Application group description.

authorization_type

String

Authorization type.

  • APP (not supported): Application-based authorization.

  • APP_GROUP (default): Application group-based authorization.

tenant_id

String

Tenant ID.

app_type

String

Server group application type:

SESSION_DESKTOP_APP: Session desktop application.

COMMON_APP: Common application.

create_at

String

Publish time.

app_count

Integer

Number of applications.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/a4da8115c9d8464ead3a38309130523f/app-groups?limit=10&offset=0

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 3,
  "items" : [ {
    "id" : "575772274859184145",
    "name" : "Open Test for the API for Creating an Application Group",
    "app_server_group_id" : "",
    "description" : "Open test for APIs.",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-06-06T14:14:02.246Z",
    "app_count" : 0
  }, {
    "id" : "573743978327834676",
    "name" : "lmn",
    "app_server_group_id" : "cb5a5079-67cb-45f6-9e4a-e489f3d821d6",
    "app_server_group_name" : "lmn-530test-Do not delete.",
    "description" : "",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-06-05T03:43:24.806Z",
    "app_count" : 1
  }, {
    "id" : "561707361090142208",
    "name" : "tmp",
    "app_server_group_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e",
    "app_server_group_name" : "Nas",
    "description" : "",
    "authorization_type" : "APP_GROUP",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "app_type" : "COMMON_APP",
    "create_at" : "2023-04-28T07:17:03.085Z",
    "app_count" : 14
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.