文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公主机/ 更新云办公主机信息 - UpdateHosts
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

更新云办公主机信息 - UpdateHosts

功能介绍

通过云办公主机的id更新云办公主机的信息，提供给console、赞齐使用。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:wdh:update

    Write

    wdh *

    g:EnterpriseProjectId

    -

    -

URI

PUT /v2/{project_id}/hosts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

hosts

是

Array of UpdateHostParam objects

云办公主机。
表3 UpdateHostParam

参数

是否必选

参数类型

描述

auto_placement

否

String

自动放置，off-取消自动放置，on-打开自动放置。

name

否

String

云办公主机名称。

host_id

否

String

云办公主机id。

响应参数

状态码：200

成功。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

{
  "hosts" : [ {
    "auto_placement" : "string",
    "name" : "string",
    "host_id" : "string"
  } ]
}

响应示例

无

状态码

状态码

描述

200

成功。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务器内部错误。

错误码

请参见错误码。

父主题： 云办公主机

相关文档