Updated on 2026-07-24 GMT+08:00

Listing Versions

Function

Lists versions. You can query versions by version type, version number, operating system type, release time, version status, and version description. Fuzzy search of version description will search for the version description configured by SRE and the version description customized by the tenant.

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:versionConfig:list

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/version-config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

version_type

Yes

Integer

(Mandatory) Version type. The value can be 0 (server) or 1 (client).

version

No

String

Version number. (Fuzzy search is supported.)

os_type

No

Integer

OS type. The value can be 0 (Windows), 1 (Android), 2 (macOS), 3 (Linux UOS), 4 (Linux Ubuntu), 5 (Linux Kylin), or 6 (Linux).

version_status

No

String

Version status. The value can be PREVIEW, RELEASED, OFFLINE, or OBSOLETE.

publish_time_begin

No

String

Start time of the release time segment (format: yyyy-MM-dd HH:mm:ss).

publish_time_end

No

String

End time of the release time segment (format: yyyy-MM-dd HH:mm:ss).

release_note

No

String

Version description. (Fuzzy search is supported. The version description configured by SRE and the version description customized by the tenant are searched at the same time.)

offset

No

Integer

Offset. The default value is 0.

limit

No

Integer

Number of records on each page. The default value is 10, and the maximum value is 20000.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of records.

records

Array of TenantVersionInfo objects

Version list.

Table 4 TenantVersionInfo

Parameter

Type

Description

id

String

Version ID.

version

String

Version number.

version_type

Integer

Version type. The value can be 0 (server) or 1 (client).

os_type

Integer

OS type. The value can be 0 (Windows), 1 (Android), 2 (macOS), 3 (Linux UOS), 4 (Linux Ubuntu), 5 (Linux Kylin), 6 (Linux), 7 (Linux Ubuntu soft), or 8 (Linux Kylin V10).

release_note

String

Update description.

custom_release_note

String

Custom update description of the tenant.

version_download_url

String

Version download address.

description

String

Description.

version_status

String

Version status. The value can be PREVIEW, RELEASED, OFFLINE, or OBSOLETE.

publish_time

String

Release time.

stop_time

String

Service end time.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Service error code.

error_msg

String

Service error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Service error code.

error_msg

String

Service error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

ok

400

Invalid request parameter.

500

Internal server error.

Error Codes

See Error Codes.