文档首页/云桌面 Workspace/API参考/云桌面API/桌面池/修改桌面池属性 - UpdateDesktopPool
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

修改桌面池属性 - UpdateDesktopPool

功能介绍

修改桌面池属性。

调试

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

授权信息

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

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

URI

PUT /v2/{project_id}/desktop-pools/{pool_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

pool_id

是

String

桌面池ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

桌面池名称，桌面池名称必须保证唯一。桌面名称只允许输入中文、大写字母、小写字母、数字、中划线，长度范围为1~255。

description

否

String

桌面池描述。

ou_name

否

String

OU名称，在对接AD时使用，需提前在AD中创建OU。

tags

否

Array of Tag objects

标签列表。

disconnected_retention_period

否

Integer

桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。

enable_autoscale

否

Boolean

桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。

autoscale_policy

否

AutoscalePolicy object

弹性伸缩策略。

in_maintenance_mode

否

Boolean

是否处于管理员维护模式。

desktop_name_policy_id

否

String

策略id，用于指定生成桌面名称策略。

availability_zone

否

String

桌面池的可用区。

root_volume

否

DesktopPoolVolumeInfo object

系统盘。

data_volumes

否

Array of DesktopPoolVolumeInfo objects

数据盘列表。

vpc_id

否

String

VPC ID

subnet_ids

否

Array of strings

桌面池子网ID列表

security_groups

否

Array of SecurityGroupIdInfo objects

桌面使用的安全组，如果不指定则默认使用桌面代理中指定的安全组

enterprise_project_id

否

String

企业项目ID

表3 Tag

参数

是否必选

参数类型

描述

key

是

String

标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

否

String

标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

表4 AutoscalePolicy

参数

是否必选

参数类型

描述

autoscale_type

否

String

弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。

max_auto_created

否

Integer

最大自动创建桌面数。

min_idle

否

Integer

预留空闲桌面数。

once_auto_created

否

Integer

一次自动创建桌面的数量(已弃用)。

min_retention

否

Integer

最小桌面数。

idle_retention_duration

否

Integer

空闲桌面保留时长（分钟）。

表5 DesktopPoolVolumeInfo

参数

是否必选

参数类型

描述

id

是

String

批量操作磁盘的磁盘集合id。

type

是

String

桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。

  • SAS：高IO。

  • SSD：超高IO。

iops

否

Integer

iops，磁盘每秒进行读写的操作次数。

throughput

否

Integer

吞吐量，磁盘每秒成功传送的数据量，即读取和写入的数据量。

kms_id

否

String

kms密钥id。变更密钥时传入密钥id；如需删除密钥则传入空字符串；默认null，不变更密钥。

表6 SecurityGroupIdInfo

参数

是否必选

参数类型

描述

id

是

String

安全组ID。

响应参数

状态码：204

正常响应，无内容。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表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/desktop-pools/9f16d997-7e6a-46b6-9b3b-b1e1d5b98703

{
  "name" : "string",
  "description" : "string",
  "ou_name" : "string",
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  } ],
  "disconnected_retention_period" : 43200,
  "enable_autoscale" : true,
  "autoscale_policy" : {
    "autoscale_type" : "string",
    "max_auto_created" : 1000,
    "min_idle" : 100,
    "once_auto_created" : 10
  },
  "in_maintenance_mode" : true,
  "desktop_name_policy_id" : "string",
  "availability_zone" : "string"
}

响应示例

无

状态码

状态码

描述

204

正常响应，无内容。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

错误码

请参见错误码。

父主题：桌面池