Queries terminal-desktop binding configurations

Function

Queries the configuration list of terminal-desktop binding.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:bindingPolicies:get	Read	-	-	-	-

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
computer_name	No	String	Desktop name.
computer_names	No	Array of strings	List of desktop names.
mac	No	String	MAC address.
mac_list	No	Array of strings	List of MAC addresses.
offset	Yes	Integer	Start number.
limit	Yes	Integer	Quantity.
count_only	No	Boolean	Whether to query only the total number of results.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
bind_list	Array of TerminalsBindingDesktopsInfo objects	Information about binding between VMs and MAC addresses.
total_num	Integer	Total number of returned results.

**Table 4** TerminalsBindingDesktopsInfo
Parameter	Type	Description
id	String	ID of the MAC address binding policy.
mac	String	MAC address of the terminal.
desktop_name	String	VM name.
description	String	Description.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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

Example Responses

Status code: 200

Normal.

{
  "bind_list" : [ {
    "id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "mac" : "AA-BB-CC-DD-EE-FF",
    "desktop_name" : "test01",
    "description" : "test"
  } ],
  "total_num" : 1
}

Status Codes

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