# 查询该版本的桌面列表 - ListDesktopVersion
#### 功能介绍
根据agent版本号、操作系统类型、桌面名称、用户名等条件查询桌面版本信息列表，支持分页查询。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListDesktopVersion)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:desktops:listByVersion | List | desktop \*  | -   | -  | -      |
     
  
 
#### URI
GET /v2/{project_id}/desktops/list-by-version
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
表2Query参数 
| 参数            | 是否必选 | 参数类型    | 描述                      |
|:---|:---|:---|:---|
| agent_version | 是    | String  | 桌面agent版本号（精确匹配）。       |
| os_type       | 是    | String  | 桌面操作系统类型。               |
| desktop_id    | 否    | String  | 桌面ID。                   |
| desktop_name  | 否    | String  | 桌面名称（支持模糊匹配）。           |
| username      | 否    | String  | 用户名（支持模糊匹配）。            |
| offset        | 否    | Integer | 用于分页查询，查询的起始记录序号，从0开始。  |
| limit         | 否    | Integer | 用于分页查询，每页数量，默认10，最大100。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                                                    | 描述      |
|:---|:---|:---|
| desktops    | Array of [DesktopVersionInfo] objects | 应用对象列表。 |
| total_count | Integer                                                                                 | 总数。     |
   
 表4DesktopVersionInfo 
| 参数           | 参数类型   | 描述        |
|:---|:---|:---|
| desktop_id   | String | 桌面id。     |
| sid          | String | 桌面sid。    |
| desktop_name | String | 桌面名称。     |
| username     | String | 用户名。      |
| status       | String | 桌面状态。     |
| task_status  | String | 桌面执行任务状态。 |
   
**状态码：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**
升级任务应用对象列表。
```
{
  "desktops" : [ {
    "desktop_id" : "desktop-id-001",
    "sid" : "desktop-001",
    "desktop_name" : "Office-Desktop-01",
    "username" : "user01",
    "status" : "ACTIVE",
    "task_status" : ""
  }, {
    "desktop_id" : "desktop-id-002",
    "sid" : "desktop-001",
    "desktop_name" : "Office-Desktop-02",
    "username" : "user02",
    "status" : "ACTIVE",
    "task_status" : ""
  } ],
  "total_count" : 2
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 升级任务应用对象列表。             |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。