Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Server Management/ Updating Virtual Session IP Configurations on the Server in Batches
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Updating Virtual Session IP Configurations on the Server in Batches

Function

Updates virtual session IP configurations on the server in batches, which requires server reboot.

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:server:batchUpdateTsvi

    Write

    server *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -
    • vpc:subnets:get
    • vpc:ports:update

URI

PATCH /v1/{project_id}/app-servers/actions/batch-update-tsvi

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

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

items

Yes

Array of objects

Request for virtual session IP configurations in batches. A batch ranges from 1 to 20.
Table 4 items

Parameter

Mandatory

Type

Description

id

Yes

String

Server ID.

enable

Yes

Boolean

**⚠ This field is reserved. Whether to enable virtual IP addresses must be the same as that configured for the server group.

Specifies whether to enable virtual IP addresses.

This parameter is valid only when the tenant allows enabling virtual IP addresses. Otherwise, ignore the input value and disable this parameter.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Job ID.

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

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

Table 12 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 13 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-servers/actions/batch-update-tsvi

{
  "items" : [ {
    "id" : "3f791197-d166-4c8e-81e4-38c40ffc1989",
    "enable" : true
  }, {
    "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
    "enable" : true
  } ]
}

Example Responses

Status code: 200

Response to a successful request.

{
  "job_id" : "575768277444198400"
}

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.

409

The request fails to be processed because a conflict exists.

500

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

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Server Management