ResetDesktops - 重置共享型云电脑

更新时间:
复制 MD 格式

重置共享型云电脑内的云电脑。

接口说明

说明

本接口仅适用于重置共享型云电脑(即共享型云电脑内的云电脑),不支持重置普通云电脑。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ResetDesktops

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

DesktopGroupId

string

共享型云电脑 ID。

  • 如果传入了DesktopId,则忽略该DesktopGroupId

  • 如果DesktopId为空,则会根据DesktopGroupId去获取该共享型云电脑内所有云电脑的DesktopId

dg-07if7qsxoxkb6****

PayType

string

付费类型。

说明

仅对重置共享型云电脑有效,为空则重置共享型云电脑下所有付费类型的云电脑。

枚举值:

  • PostPaid :

    按量付费

  • PrePaid :

    包年包月

PrePaid

ResetType

string

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

枚举值:

  • 0 :

    不重置

  • 1 :

    仅重置系统盘

  • 2 :

    仅重置用户磁盘

  • 3 :

    重置系统盘和用户磁盘

1

ImageId

string

镜像 ID。

m-4zfb6zj728hhr****

DesktopId

array

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

string

云电脑 ID。

ecd-07if7qsxoxkb3****

DesktopGroupIds

array

共享型云电脑 ID 列表。

string

共享型云电脑 ID。

dg-kadkdfaf****

ResetScope

string

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

枚举值:

  • ALL :

    重置镜像及云电脑 [默认值]

  • IMAGE :

    仅重置镜像

ALL

LastRetryTime

integer

上次重试的时间戳。单位:毫秒。

1699960800000

返回参数

名称

类型

描述

示例值

object

返回信息集合。

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情