SetDesktopMaintenance - 设置云电脑维护模式

更新时间:
复制 MD 格式

设置云电脑维护模式。

接口说明

如果您需要对云电脑进行一些维护操作,并希望在此期间禁止终端用户连接和使用该云电脑,您可以将其切换为维护模式。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:SetDesktopMaintenance

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

Mode

string

进入或退出云电脑维护模式。

枚举值:

  • ENTER :

    进入维护模式

  • EXIT :

    退出维护模式

enter

DesktopIds

array

要设置维护模式的云电脑 ID 列表。最多支持 100 个云电脑 ID。

string

要设置维护模式的云电脑 ID。

ecd-dzeotbgawdnfo****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

BA6A1853-3EA9-5EEB-86C8-3D14A3E01905

示例

正常返回示例

JSON格式

{
  "RequestId": "BA6A1853-3EA9-5EEB-86C8-3D14A3E01905"
}

错误码

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

变更历史

更多信息,参考变更详情