文档

ResetDesktops - 重置池化云电脑

更新时间:

重置云电脑池内的云电脑。

接口说明

说明 本接口仅适用于重置池化云电脑(即云电脑池内的云电脑),不支持重置普通云电脑。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
DesktopGroupIdstring

云电脑池 ID。

  • 如果传入了DesktopId,则忽略该DesktopGroupId
  • 如果DesktopId为空,则会根据DesktopGroupId去获取该云电脑池内所有云电脑的DesktopId
dg-07if7qsxoxkb6****
PayTypestring

付费类型。

说明 仅对重置云电脑池有效,为空则重置云电脑池下所有付费类型的云电脑。
枚举值:
  • PostPaid按量付费
  • PrePaid包年包月
PrePaid
ResetTypestring

重置类型,决定是否重置,以及要重置的磁盘范围。

枚举值:
  • 0不重置
  • 1仅重置系统盘
  • 2仅重置用户磁盘
  • 3重置系统盘和用户磁盘
1
ImageIdstring

镜像 ID。

m-4zfb6zj728hhr****
DesktopIdarray

云电脑 ID 列表。可设置 1~100 个。

string

云电脑 ID。

ecd-07if7qsxoxkb3****
DesktopGroupIdsarray

云电脑池 ID 列表。

string

云电脑池 ID。

dg-kadkdfaf****
ResetScopestring

重置范围,可以通过配置参数来设置是重置镜像还是重置云电脑。

枚举值:
  • ALL重置镜像及云电脑 [默认值]
  • IMAGE仅重置镜像
ALL

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-13OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DesktopGroupIds
    新增入参:ResetScope
  • 本页导读 (0)
文档反馈