# 变更规格 - ResizeDesktop #### 功能介绍 变更云桌面规格，只支持变更CPU和内存，不支持变更磁盘，不支持同规格互相变更。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ResizeDesktop)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:desktops:resize | Write | desktop \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - vpc:subnets:get - ims:images:list | #### URI POST /v2/{project_id}/desktops/resize 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktops | 是 | Array of [ResizeDesktopData] objects | 桌面数据。支持批量将桌面变更为同一规格。 | | product_id | 是 | String | 套餐id。批量变更时，则变更为同一规格的虚拟机。 | | mode | 是 | String | 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。 | | auto_placement | 否 | String | 是否自动放置，专属主机桌面变更规格时使用，默认是off关闭自动放置，on表示开启自动放置。 | | desktop_pool_id | 否 | String | 桌面池id。 | 表3ResizeDesktopData | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_id | 否 | String | 桌面ID。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | jobs | Array of [ResizeDesktopJobResponse] objects | 桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。 | | job_id | String | 变更规格任务id。 | 表5ResizeDesktopJobResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | desktop_id | String | 桌面ID。 | | job_id | String | 任务ID。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：409** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/resize { "desktops" : [ { "desktop_id" : "538946c2-7ff8-4444-b1bd-e9a1f8137b81" } ], "product_id" : "workspace.k.xlarge.2.linux", "mode" : "STOP_DESKTOP" } ``` #### 响应示例 **状态码：200** 变更规格响应。 ``` { "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx", "jobs" : [ { "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9", "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 变更规格响应。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 409 | 操作冲突。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。