查询版本列表 - ListTenantVersionConfig_租户版本配置管理服务_云桌面API_API参考

功能介绍

查询版本列表，支持按版本类型、版本号、操作系统类型、发布时间段、版本状态、版本说明条件查询。版本说明模糊查询会同时搜索SRE配置的版本说明和租户自定义的版本说明。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:versionConfig:list

List

-

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:versionConfig:list	List	-	-	-	-

URI

GET /v2/{project_id}/version-config

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

表2 Query参数
参数	是否必选	参数类型	描述
version_type	是	Integer	版本类型：0-服务端 1-客户端（必传）
version	否	String	版本号（支持模糊查询）
os_type	否	Integer	操作系统类型：0-windows 1-android 2-mac 3-linux_UOS 4-linux_ubuntu 5-linux_Kylin 6-linux
version_status	否	String	版本状态：PREVIEW-预览 RELEASED-已发布 OFFLINE-已下线 OBSOLETE-已废弃
publish_time_begin	否	String	发布时间开始（格式：yyyy-MM-dd HH:mm:ss）
publish_time_end	否	String	发布时间结束（格式：yyyy-MM-dd HH:mm:ss）
release_note	否	String	版本说明（支持模糊查询，会同时搜索SRE配置的版本说明和租户自定义的版本说明）
offset	否	Integer	偏移量，默认0
limit	否	Integer	每页数量，默认10，最大20000

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total_count	Integer	总记录数
records	Array of TenantVersionInfo objects	版本列表

表4 TenantVersionInfo
参数	参数类型	描述
id	String	版本ID
version	String	版本号
version_type	Integer	版本类型：0-服务端 1-客户端
os_type	Integer	操作系统类型：0-windows 1-android 2-mac 3-linux_UOS 4-linux_ubuntu 5-linux_Kylin 6-linux 7-linux_ubuntu_soft 8-linux_kylin_v10
release_note	String	更新说明
custom_release_note	String	租户自定义更新说明
version_download_url	String	版本下载地址
description	String	描述
version_status	String	版本状态：PREVIEW-预览 RELEASED-已发布 OFFLINE-已下线 OBSOLETE-已废弃
publish_time	String	发布时间
stop_time	String	停止服务时间

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	业务错误码
error_msg	String	业务错误描述

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_code	String	业务错误码
error_msg	String	业务错误描述

请求示例

GET /v2/tenant001/version-config?version_type=0&version=24.6.3&os_type=0&version_status=RELEASED&offset=0&limit=10

响应示例

状态码：200

ok

{
  "total_count" : 100,
  "records" : [ {
    "id" : "123456",
    "version" : "24.6.3",
    "version_type" : 0,
    "os_type" : 0,
    "release_note" : "{\n  \"zh-CN\": {\n    \"added\": [\"新增登录方式\"],\n    \"optimized\": [\"优化页面加载速度\"]\n  }\n}",
    "custom_release_note" : "{\n  \"zh-CN\": {\n    \"added\": [\"新增登录方式\"],\n    \"optimized\": [\"优化页面加载速度\"]\n  }\n}",
    "version_download_url" : "https://download-package.com",
    "description" : "测试版本",
    "version_status" : "RELEASED",
    "publish_time" : "2024-01-01T00:00:00",
    "stop_time" : "2028-01-01T00:00:00"
  } ]
}

状态码

状态码	描述
200	ok
400	请求参数错误
500	服务器内部错误

错误码

请参见错误码。

查询版本列表 - ListTenantVersionConfig