Help Center/ Workspace/ API Reference/ Workspace APIs/ Binds a terminal to a desktop/ Queries the configuration of the switch for binding a terminal to a desktop

Updated on 2025-07-14 GMT+08:00

View PDF

Queries the configuration of the switch for binding a terminal to a desktop

Function

Queries the configuration of the switch for binding a terminal to a desktop.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body.
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tc_bind_switch	String	Binding switch. The value can only be on or off.
tc_auto_bind_switch	String	Automatic binding switch. The value can only be on or off.
tc_auto_bind_max	Integer	Maximum number of bindings. The default value is 1.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

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

Example Responses

Status code: 200

Normal.

{
  "tc_bind_switch" : "ON"
}

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
404	No resource found.
500	An internal service error occurred. For details about the error code, see the error code description.