文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面池/ 桌面池变更规格 - ResizeDesktopPool
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

桌面池变更规格 - ResizeDesktopPool

功能介绍

桌面池变更规格。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/desktop-pools/{pool_id}/resize

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

pool_id

是

String

桌面池ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

product_id

是

String

目标规格产品ID。

flavor_id

否

String

产品规格ID。

mode

否

String

是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。

handle_type

否

String

处理类型

  • ONLY_FOR_EXPAND：仅对新扩容桌面生效

  • FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效

  • FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效

desktop_ids

否

Array of strings

桌面id

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

job_id

String

创建云桌面总任务id。

jobs

Array of ResizeDesktopPoolJobResponse objects

桌面变更规格返回的任务信息
表4 ResizeDesktopPoolJobResponse

参数

参数类型

描述

desktop_id

String

桌面ID。

job_id

String

任务ID。

状态码：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接口进行解密。

状态码：409

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338/resize

{
  "product_id" : "workspace.x86.ultimate.xlarge2"
}

响应示例

状态码：200

正常。

{
  "job_id" : "302baff8-3e19-437e-bab3-a2ba2fd15175",
  "jobs" : [ {
    "desktop_id" : "c76be6ed-cdc9-4d00-887a-e08ffec6fd1e",
    "job_id" : "10fc637a-286a-49d5-81d8-42c0bec3ecbb"
  } ]
}

状态码

状态码

描述

200

正常。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

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

错误码

请参见错误码。

父主题： 桌面池