文档首页/云桌面 Workspace/API参考/云应用API/使用记录/查询应用使用记录 - ListAppConnection
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询应用使用记录 - ListAppConnection

功能介绍

查询应用使用记录。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:session:listAppConnection

    Write

    -

    -

    -

    -

URI

POST /v1/{project_id}/session/app-connection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

单次查询的大小[1-100]，默认值10。

offset

否

Integer

查询的偏移量，默认值0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表4 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

主键。

sid

否

String

应用服务器sid。

machine_name

否

String

应用服务器名称。

user_name

否

String

登录用户，模糊查询。

app_group_name

否

String

应用组名称。

app_group_id

否

String

应用组id。

app_name

否

String

应用名称，模糊查询。

failed_code

否

String

连接失败状态码。

connection_failure_reason

否

String

连接失败原因。

client_name

否

String

客户端名称。

client_version

否

String

客户端版本。

client_type

否

String

客户端操作系统类型。

agent_version

否

String

aps hda版本。

vm_ip

否

String

应用服务器ip。

wi_ip

否

String

连接IP。

public_ip

否

String

客户端出口ip。

tenant_id

否

String

租户id。

brokering_start_time

否

String

登录应用开始时间，只支持导出30天内数据，格式 2022-10-31T08:07:39Z，参数中brokering_start_time与brokering_end_time必须同时存在或都不存在，都不存在时导出近一个月的数据。

brokering_end_time

否

String

登录应用结束时间，只支持导出30天内数据，格式 2022-10-31T08:07:39Z，参数中brokering_start_time与brokering_end_time必须同时存在或都不存在，都不存在时导出近一个月的数据。

virtual_ip

否

String

会话虚拟ip。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of AppConnectionInfo objects

应用使用记录列表。

表6 AppConnectionInfo

参数

参数类型

描述

id

String

应用连接唯一标识ID。

sid

String

应用服务器sid。

machine_name

String

应用服务器名称。

user_name

String

登录用户。

app_group_name

String

应用组名称。

app_group_id

String

应用组ID。

app_name

String

应用名称。

brokering_time

String

登录应用时间。

failed_code

String

连接失败状态码。

connection_failure_reason

String

连接失败原因。

client_mac

String

客户端Mac。

client_name

String

客户端名称。

client_ip

String

客户端ip。

client_version

String

客户端版本。

client_type

String

客户端操作系统类型。

agent_version

String

aps hda版本。

vm_ip

String

应用服务器ip。

wi_ip

String

连接IP。

tenant_id

String

租户id。

virtual_ip

String

会话虚拟ip。

public_ip

String

客户端出口ip。

transaction_id

String

事务id。

end_time

String

登录应用结束时间。

aps_instance_id

String

aps服务器ID。

aps_instance_name

String

aps服务器名称。

aps_host_id

String

wdh专属主机ID。

primary_server_group_id

String

主服务器组ID。

secondary_server_group_id

String

主服务器组ID。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：415

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

POST /v1/a4da8115c9d8464ead3a38309130523f/session/app-connection?limit=10&offset=0

{
  "brokering_start_time" : "2025-04-24T16:00:00Z",
  "brokering_end_time" : "2025-05-24T10:22:55Z"
}

响应示例

状态码：200

成功响应。

{
  "count" : 2,
  "items" : [ {
    "id" : "5af4a8c1047411ee9f75fa163e289e5a",
    "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418",
    "machine_name" : "APS-XS1QJ3TA7T",
    "user_name" : "user001@wksapp***.huawei.com",
    "app_group_name" : "云存储",
    "app_group_id" : "573743978327834675",
    "app_name" : "云存储-Notepad++",
    "brokering_time" : "2023-06-06T14:13:48Z",
    "failed_code" : "",
    "connection_failure_reason" : "",
    "client_mac" : "00-e0-***-58-08-33",
    "client_name" : "DESKTOP-KDB5TN1",
    "client_ip" : "10.*73.109.160",
    "client_version" : "23.5.0.0",
    "client_type" : "Windows 10",
    "agent_version" : "23.5.0.0529",
    "vm_ip" : "10.*.248.130",
    "wi_ip" : "192.**.10.*00\\#192.**.10.23",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "virtual_ip" : ""
  }, {
    "id" : "b5442cb1047211ee9f75fa163e289e5a",
    "sid" : "S-1-5-21-1213649063-4191095369-2401105760-1418",
    "machine_name" : "APS-XS1QJ3TA7T",
    "user_name" : "user001@wksapp***.huawei.com",
    "app_group_name" : "云存储",
    "app_group_id" : "573743978327834675",
    "app_name" : "云存储-Notepad++",
    "brokering_time" : "2023-06-06T14:02:00Z",
    "failed_code" : "",
    "connection_failure_reason" : "",
    "client_mac" : "00-e0-**-58-08-33",
    "client_name" : "DESKTOP-KDB5TN1",
    "client_ip" : "10.*73.109.160",
    "client_version" : "23.5.0.0",
    "client_type" : "Windows 10",
    "agent_version" : "23.5.0.0529",
    "vm_ip" : "10.*.248.130",
    "wi_ip" : "192.**.10.*00\\#192.**.10.23",
    "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
    "virtual_ip" : ""
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

415

请求中提交的资源格式不支持。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题：使用记录

相关文档