文档首页/云桌面 Workspace/API参考/云桌面API/磁盘/批量增加桌面磁盘 - AddVolumes
更新时间:2026-03-17 GMT+08:00

批量增加桌面磁盘 - AddVolumes

功能介绍

批量增加桌面磁盘。

调试

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

授权信息

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

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

URI

POST /v2/{project_id}/volumes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

desktop_volumes

Array of AddDesktopVolumesReq objects

新增磁盘参数。

表3 AddDesktopVolumesReq

参数

是否必选

参数类型

描述

desktop_id

String

桌面Id。

volumes

Array of Volume objects

待新增的磁盘信息,每个桌面的数据盘数量不超过10个。

表4 Volume

参数

是否必选

参数类型

描述

type

String

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

-SAS:高IO。

-SSD:超高IO。

-GPSSD:通用型SSD。

size

Integer

磁盘容量,单位GB。系统盘大小范围[80-32760],数据盘范围[10-32760],大小为10的倍数。

iops

Integer

iops,云硬盘每秒进行读写的操作次数。

throughput

Integer

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

kms_id

String

kms密钥id,对创建的磁盘进行加密。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

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/9565be6e740941c493b38a1f46ecae6f/volumes

{
  "desktop_volumes" : [ {
    "desktop_id" : "string",
    "volumes" : [ {
      "type" : "SAS",
      "size" : 80
    } ]
  } ]
}

响应示例

状态码:200

正常。

{
  "job_id" : "1792d3eb-35c6-4e99-8381-abfc8e02126b"
}

状态码

状态码

描述

200

正常。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

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

错误码

请参见错误码