文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 查询桌面版本统计信息 - ListDesktopStatisticsByVersion
更新时间:2026-07-24 GMT+08:00

查询桌面版本统计信息 - ListDesktopStatisticsByVersion

功能介绍

查询每个桌面版本下的桌面数量统计信息,支持按版本号过滤。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:desktops:listVersionStatistics

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/desktops/statistics/by-version

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

versions

Array of strings

桌面版本号列表,用于过滤指定版本的桌面统计。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

version_statistics

Array of DesktopVersionStatistic objects

按版本分组的桌面统计信息列表。

表4 DesktopVersionStatistic

参数

参数类型

描述

version

String

桌面版本号。

os_type

String

操作系统。

desktop_count

Integer

该版本下的桌面数量。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

响应示例

状态码:200

按版本统计的桌面数量列表。

{
  "version_statistics" : [ {
    "version" : "1.0.0",
    "desktop_count" : 100
  }, {
    "version" : "2.0.0",
    "desktop_count" : 200
  } ]
}

状态码

状态码

描述

200

按版本统计的桌面数量列表。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码