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

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

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

tc_bind_switch

String

绑定开关,只取值ON或OFF

tc_auto_bind_switch

String

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

tc_auto_bind_max

Integer

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

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 404

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

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

请求示例

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

{
  "tc_bind_switch" : "ON"
}

响应示例

状态码

状态码

描述

200

正常

400

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

404

找不到资源。

500

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

错误码

请参见错误码

相关文档