查询终端与桌面绑定配置列表 - ListTerminalsBindingDesktops

功能介绍

查询终端与桌面绑定配置列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
computer_name	否	String	桌面名。
computer_names	否	Array of strings	桌面名列表。
mac	否	String	mac地址。
mac_list	否	Array of strings	mac地址列表。
offset	是	Integer	起始数。
limit	是	Integer	数量。
count_only	否	Boolean	是否只查询结果总条数。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
bind_list	Array of TerminalsBindingDesktopsInfo objects	MAC绑定VM信息列表。
total_num	Integer	返回结果总条数。

表4 TerminalsBindingDesktopsInfo
参数	参数类型	描述
id	String	MAC绑定策略ID。
mac	String	终端MAC地址。
desktop_name	String	虚拟机名称。
description	String	描述。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

get /v2/fb2e5ec048384c8f9469d22db0037908/terminals/binding-desktops

响应示例

状态码：200

正常。

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

状态码

状态码	描述
200	正常。
400	由于包含语法错误，当前请求无法被服务器理解。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。