Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Server Group Management/ Querying Basic Information About a Tenant Server Group
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Basic Information About a Tenant Server Group

Function

Queries basic information about a tenant server group (used to bind server groups when creating an application group).

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:serverGroup:listDetail

    List

    serverGroup *

    -

    -

    -

URI

GET /v1/{project_id}/app-server-groups/actions/list

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset. The default value is 0.

limit

No

Integer

Number of records to be queried. The value ranges from 1 to 100. The default value is 10.

sever_group_name

No

String

Server group name.

app_type

No

String

Application group type:

SESSION_DESKTOP_APP: session desktop application

COMMON_APP: common application

is_secondary_server_group

No

String

Whether the server group is a standby one. If this parameter is not specified, all server groups are queried by default.

true: standby server group

false: primary server group (default value)

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 number.

items

Array of ServerGroupDto objects

Server Group List.
Table 5 ServerGroupDto

Parameter

Type

Description

id

String

Unique ID of a server group.

name

String

ECS group name.

description

String

Server Group Description.

image_id

String

Specifies the ID of the image associated with the ECS group, which is used to create ECSs in the corresponding group.

os_type

String

System type. Currently, only Windows is supported.

  • Linux -

  • Windows -

  • Other -

product_id

String

Product ID.

subnet_id

String

Specifies the subnet ID of the NIC.

system_disk_type

String

Disk type. For details about how to obtain available disk types, see parameter ListVolumeType. Options:

ESSD: Extreme SSD

SSD: Ultra-high I/O

GPSSD: General-purpose SSD

SAS: High I/O

SATA: Common I/O

system_disk_size

Integer

Disk capacity in GB.

is_vdi

Boolean

Indicates whether the VDI single-session mode is used.

extra_session_type

String

Paid session type:

GPU: GPU session

CPU: common CPU session

extra_session_size

Integer

Number of Paid Sessions.

app_type

String

Server Group Application Type

  • SESSION_DESKTOP_APP - Session desktop app

  • COMMON_APP - Common app.

create_time

String

Time when the server group is created.

update_time

String

Server Group Update Time.

storage_mount_policy

String

Mounting policy of the NAS directory on the application streaming server when a user accesses applications on the server.

USER: mounts only personal directories

SHARE: mounts only shared directories

ANY: no restriction on the mounted directory (Both personal and shared NAS directories are automatically mounted.)

enterprise_project_id

String

Enterprise project ID. The value 0 indicates the default enterprise project ID.

primary_server_group_ids

Array of strings

Primary server group IDs.

secondary_server_group_ids

Array of strings

Standby server group IDs.

server_group_status

Boolean

Whether the server is enabled. true indicates yes and false indicates no.

site_type

String

Site type. The options are CENTER and IES.

site_id

String

Site ID.

app_group_count

Integer

Total number of associated application groups.

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

None

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "name" : "Server group for process development application",
    "description" : "Software Development Application Server Team of XXX Company",
    "image_id" : "a6ea73e0-9f4b-11ec-b909-0242ac120002",
    "os_type" : "windows",
    "product_id" : "workspace.x86.general.xlarge2",
    "subnet_id" : "0ddf778f-c0fe-4717-9251-001caee7c95e",
    "system_disk_type" : "SSD",
    "system_disk_size" : 10,
    "is_vdi" : false,
    "extra_session_type" : "CPU",
    "extra_session_size" : 1,
    "app_type" : "SESSION_DESKTOP_APP",
    "create_time" : "2022-03-07T10:40:43.858Z",
    "update_time" : "2022-03-07T10:40:43.858Z",
    "storage_mount_policy" : "ANY",
    "enterprise_project_id" : "0",
    "primary_server_group_ids" : [ "string" ],
    "secondary_server_group_ids" : [ "string" ],
    "server_group_status" : false,
    "site_type" : "CENTER",
    "site_id" : "ae985216-83fa-46b6-ab03-a36dcb3dd05a",
    "app_group_count" : "1"
  } ]
}

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.

Parent topic: Server Group Management