查询桌面安装agent详情
功能介绍
展示桌面安装agent详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/desktops/agents
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
企业项目ID。 |
|
desktop_id |
否 |
String |
桌面ID。 |
|
desktop_name |
否 |
String |
桌面名称。 |
|
status |
否 |
String |
桌面状态。 |
|
ip_address |
否 |
String |
ip地址。 |
|
is_installed |
否 |
Boolean |
插件是否已安装。 |
|
desktop_pool_id |
否 |
String |
桌面池id。 |
|
limit |
否 |
Integer |
每页显示的数量。 |
|
offset |
否 |
Integer |
用于分页查询，查询的起始记录序号，从0开始。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agents_condition |
Array of AgentsCondition objects |
桌面agent安装情况。 |
|
total_count |
Integer |
总共条数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
desktop_id |
String |
桌面的desktopId。 |
|
desktop_name |
String |
桌面名称。 |
|
desktop_pool_id |
String |
桌面池id。 |
|
status |
String |
桌面运行状态。 |
|
task_status |
String |
桌面的任务状态。 |
|
ip_address |
String |
ip地址。 |
|
enterprise_project_id |
String |
企业项目ID。 |
|
process |
Integer |
桌面任务进度， 取值范围0-100以及null，null表示该桌面无任务，0-100表明该任务进度的百分比。 |
|
agent_info |
Array of AgentInfo objects |
单个桌面内的agent安装情况。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
agent_name |
String |
插件名称。 |
|
agent_version |
String |
插件版本。 |
|
is_installed |
Boolean |
是否安装插件（是否）。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
/v2/9c53a566cb3443ab910cf0daebca90c4/desktops/agents
响应示例
状态码：200
查询桌面安装agent详情列表返回体。
{
"agents_condition" : [ {
"desktop_id" : "string",
"desktop_name" : "string",
"desktop_pool_id" : "string",
"status" : "string",
"task_status" : "string",
"ip_address" : "string",
"enterprise_project_id" : "string",
"process" : 0,
"agent_info" : [ {
"agent_name" : "string",
"agent_version" : "string",
"is_installed" : true
} ]
} ],
"total_count" : 2147483647
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询桌面安装agent详情列表返回体。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
500 |
服务器内部错误。 |
错误码
请参见错误码。
