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.

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.
mac	No	String	MAC address.
offset	Yes	Integer	Start number.
limit	Yes	Integer	Quantity.
count_only	No	Boolean	Whether to query only the total number of results.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body.
X-Auth-Token	Yes	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 4** Response body parameters
Parameter	Type	Description
bind_list	Array of TerminalsBindingDesktopsInfo objects	VMs bound to MAC addresses.
total_num	Integer	Total number of returned results.

**Table 5** TerminalsBindingDesktopsInfo
Parameter	Type	Description
id	String	ID of the MAC address binding policy.
mac	String	Terminal's MAC address.
desktop_name	String	VM name.
description	String	Description.

Status code: 400

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

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.

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 resource found.
500	An internal service error occurred. For details about the error code, see the error code description.