文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 升级策略管理服务/ 查询升级策略列表 - ListTenantUpgradeStrategies
更新时间:2026-07-24 GMT+08:00

查询升级策略列表 - ListTenantUpgradeStrategies

功能介绍

分页查询升级策略列表。

  • 支持按策略名称(模糊/精确)、策略类型、是否强制升级、启用状态、优先级条件查询

  • 默认按优先级升序排序

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:upgradeStrategy:list

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/upgrade-strategies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

is_accurate_name

Boolean

是否精确匹配名称

strategy_name

String

策略名称(支持模糊查询)

strategy_type

Integer

策略类型:0-服务端 1-客户端

is_force_upgrade

Integer

是否强制升级:0-否 1-是

status

Integer

启用状态:0-禁用 1-启用

strategy_priority

Integer

协议策略优先级

offset

Integer

偏移量,默认0

limit

Integer

每页数量,默认10,最大100

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

总数量

strategies

Array of TenantUpgradeStrategyDetailRsp objects

策略列表

表4 TenantUpgradeStrategyDetailRsp

参数

参数类型

描述

id

String

策略ID

project_id

String

项目ID

strategy_type

Integer

策略类型:0-服务端 1-客户端

strategy_name

String

策略名称

is_force_upgrade

Integer

是否强制升级:0-否 1-是

min_version

String

低于此版本升级

target_version

String

升级目标版本

strategy_desc

String

策略描述

strategy_priority

Integer

优先级(数值越小优先级越高)

status

Integer

状态:0-禁用 1-启用

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

请求示例

响应示例

状态码:200

ok

{
  "total_count" : 100,
  "strategies" : [ {
    "id" : "strategy-001",
    "project_id" : "project-001",
    "strategy_type" : 0,
    "strategy_name" : "vgpu 策略",
    "is_force_upgrade" : 1,
    "min_version" : "1.0.0",
    "target_version" : "2.0.0",
    "strategy_desc" : "升级到最新版本",
    "strategy_priority" : 1,
    "status" : 1
  } ]
}

状态码

状态码

描述

200

ok

400

请求参数错误

500

服务器内部错误

错误码

请参见错误码