Adds a terminal-desktop binding configuration

Function

Adds a terminal-desktop binding configuration.

Debugging

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

URI

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

**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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
bind_list	No	Array of CreateTerminalsBindingDesktopsInfo objects	Policies to be added for binding MAC addresses to VMs.

**Table 4** CreateTerminalsBindingDesktopsInfo
Parameter	Mandatory	Type	Description
line	No	Integer	Line number, which is used for batch import.
mac	No	String	MAC address of the terminal.
desktop_name	No	String	Desktop name, which is used for batch import.
description	No	String	Description.

Response Parameters

Status code: 200

Normal.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
bind_result_list	Array of CreateTerminalsBindingDesktopsResult objects	Binding policy creation result.
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.

**Table 6** CreateTerminalsBindingDesktopsResult
Parameter	Type	Description
line	Integer	Line number, which is used for batch import.
mac	String	MAC address of the terminal.
sid	String	VM ID.
desktop_name	String	Desktop name, which is used for batch import.
validation_result_code	String	Code of binding policy verification result.
validation_result_msg	String	Binding policy verification result, which is used for identification during batch import.
description	String	Description.

Status code: 404

**Table 7** 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 8** 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

post /v2/fb2e5ec048384c8f9469d22db0037908/terminals/binding-desktops

{
  "bind_list" : [ {
    "line" : 0,
    "mac" : "AA-BB-CC-DD-EE-FF",
    "desktop_name" : "test01",
    "description" : "test"
  } ]
}

Example Responses

None

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.