文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 终端与桌面绑定/ 设置终端与桌面绑定的开关配置 - UpdateTerminalsBindingDesktopsConfig
更新时间:2026-01-07 GMT+08:00
分享

设置终端与桌面绑定的开关配置 - UpdateTerminalsBindingDesktopsConfig

功能介绍

设置终端与桌面绑定的开关配置。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    workspace:bindingPolicies:createConfig

    Write

    -

    -

    -

    -

URI

POST /v2/{project_id}/terminals/binding-desktops/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tc_bind_switch

String

绑定开关,只取值ON或OFF。

tc_auto_bind_switch

String

自动绑定开关,只取值ON或OFF。

tc_auto_bind_max

Integer

最大绑定数量,默认值为1。

响应参数

状态码:200

正常。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码:404

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

post /v2/fb2e5ec048384c8f9469d22db0037908/terminals/binding-desktops/config

{
  "tc_bind_switch" : "ON"
}

响应示例

状态码

状态码

描述

200

正常。

400

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

404

找不到资源。

500

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

错误码

请参见错误码

相关文档