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

Modifying a Server Group

Function

Modifies a server group.

  • Modifying the image, system disk size, and OU of a server group takes effect only on new servers. Modifying the max. number of sessions resets the routing calculation for new server group accesses from users.

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

    Write

    serverGroup *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    ims:images:list

URI

PATCH /v1/{project_id}/app-server-groups/{server_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

server_group_id

Yes

String

Unique ID of a server group.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Server group name. Requirements:

  1. Contains letters, digits, underscores (_), and hyphens (-). Spaces are not allowed.

  2. Contains 1 to 64 characters.

description

No

String

Server group description.

route_policy

No

RoutePolicy object

Routing.

storage_mount_policy

No

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

image_id

No

String

Image ID associated with a server group. Updating the ID takes effect only on the cloud server of the group.

image_product_id

No

String

Image product ID of a server group.

image_type

No

String

Image Type

  • gold - Marketplace image

  • public - Public image

  • private - Private image

  • shared - Shared image

  • other - Others.

system_disk_type

No

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

No

Integer

Disk capacity (GB).

ou_name

No

String

Default organization name.

app_type

No

String

Server Group Application Type

  • SESSION_DESKTOP_APP - Session desktop app

  • COMMON_APP - Common app.

server_group_status

No

Boolean

Whether the server is disabled.

  • true: enabled

  • false: disabled
Table 4 RoutePolicy

Parameter

Mandatory

Type

Description

max_session

No

Integer

Maximum number of sessions on a single server.

cpu_threshold

No

Integer

CPU usage threshold, in percentage.

gpu_threshold

No

Integer

GPU usage threshold, in percentage.

mem_threshold

No

Integer

Memory usage threshold, in percentage.

Response Parameters

Status code: 200

Successful.

Status code: 400

Table 5 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 6 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 7 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 8 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 9 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 10 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 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups/bc05da52-89df-45ba-8146-13fe3ce7c45a

{
  "name" : "TEST"
}

Example Responses

Status code: 200

Successful.

null

Status Codes

Status Code

Description

200

Successful.

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