{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BaseResp":{"description":"API响应基类。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00139901","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","readOnly":true,"type":"string"}}},"ListSessionsRsp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"企业的会话列表。","items":{"$ref":"#/definitions/SessionInfo"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询企业的会话列表返回值。"},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"SessionInfo":{"description":"会话信息。","properties":{"agent_version":{"description":"agent版本。","example":"","readOnly":true,"type":"string"},"app_name":{"description":"会话中的应用名称。","example":"","readOnly":true,"type":"string"},"app_server_group_id":{"description":"AppServer组ID。","example":"","readOnly":true,"type":"string"},"app_server_group_name":{"description":"AppServer组名称。","example":"","readOnly":true,"type":"string"},"client_ip":{"description":"客户端IP。","example":"","readOnly":true,"type":"string"},"client_mac":{"description":"客户端Mac地址。","example":"","readOnly":true,"type":"string"},"client_name":{"description":"客户端名称。","example":"","readOnly":true,"type":"string"},"client_type":{"description":"客户端类型。","example":"","readOnly":true,"type":"string"},"client_version":{"description":"客户端版本。","example":"","readOnly":true,"type":"string"},"end_time":{"description":"会话结束时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"failed_code":{"description":"错误原因码。","example":"","readOnly":true,"type":"string"},"failed_reason":{"description":"错误原因消息。","example":"","readOnly":true,"type":"string"},"id":{"description":"主键ID。","example":"","readOnly":true,"type":"string"},"last_update_status_time":{"description":"状态最后变化时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"login_user":{"description":"当前会话的登录用户。","example":"","readOnly":true,"type":"string"},"machine_name":{"description":"服务器名称。","example":"","readOnly":true,"type":"string"},"machine_sid":{"description":"服务器SID。","example":"","readOnly":true,"type":"string"},"os_session_id":{"description":"会话在hda的os中会话id。","example":"","readOnly":true,"type":"string"},"pre_conn_time":{"description":"预连接时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"primary_server_group_id":{"description":"主服务器组ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"protocol_type":{"description":"协议类型。","example":"","readOnly":true,"type":"string"},"public_ip":{"description":"客户端出口ip。","example":"0.0.0.0","readOnly":true,"type":"string"},"secondary_server_group_id":{"description":"备服务器组ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"session_stamp":{"description":"会话标识。","example":"","readOnly":true,"type":"string"},"session_state":{"description":"会话状态。","example":"","readOnly":true,"type":"string"},"session_type":{"description":"会话类型,1表示共享桌面,2表示应用。","example":"","readOnly":true,"type":"string"},"start_time":{"description":"会话开始时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"status_continue_time":{"description":"状态持续时间。","example":"","readOnly":true,"type":"string"},"tenant_id":{"description":"租户ID。","example":"","readOnly":true,"type":"string"},"vm_ip":{"description":"服务器IP。","example":"","readOnly":true,"type":"string"}},"type":"object"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"f92f72989d4b4799bdbd3953d9902991","info_version":"v1","method":"get","name":"ListSessions","parameters":{},"paths":{"/v1/{project_id}/session/list-sessions":{"get":{"description":"查询用户会话列表。","operationId":"ListSessions","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目ID。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"default":10,"description":"单次查询的大小[1-100],默认值10。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":"10"},{"default":0,"description":"查询的偏移量,默认值0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":"0"},{"description":"用户名。","in":"query","maxLength":64,"minLength":1,"name":"user_name","required":false,"type":"string","x-example":"user005"},{"description":"搜索开始时间,以会话开始时间为条件查询,格式2024-02-27T03:47:51.182Z。","in":"query","maxLength":32,"minLength":0,"name":"query_begin_time","required":true,"type":"string"},{"description":"搜索结束时间,以会话开始时间为条件查询,格式2024-02-27T03:47:51.182Z。","in":"query","maxLength":32,"minLength":0,"name":"query_end_time","required":true,"type":"string"},{"description":"AppServer组ID。","in":"query","maxLength":64,"minLength":0,"name":"app_server_group_id","required":false,"type":"string","x-example":"xxxxxxxxxyyyyyyyyaaaaaaabbbbbbbb"},{"description":"服务器IP。","in":"query","maxLength":64,"minLength":0,"name":"vm_ip","required":false,"type":"string","x-example":"10.0.0.1"},{"description":"客户端出口IP。","in":"query","maxLength":64,"minLength":0,"name":"public_ip","required":false,"type":"string","x-example":"10.0.0.1"},{"description":"应用服务器名称。","in":"query","maxLength":128,"minLength":0,"name":"machine_name","required":false,"type":"string"},{"description":"应用状态,支持查询多个,中间用英文逗号分隔:\n* `Active` - 会话当前处于活动状态,有用户登录并且正在使用。\n* `Disconnected` - 用户已经登录但会话处于断开连接状态。\n* `AppcInit` - 会话正在初始化。\n* `SignedOut` - 会话已注销。\n* `InitFail` - 会话初始化失败。","in":"query","maxLength":256,"minLength":0,"name":"session_state","required":false,"type":"string","x-example":""},{"description":"会话是否创建成功,默认不填则查询全部\n* 'true' - 会话创建成功\n* 'false' - 会话创建失败","in":"query","name":"is_success","pattern":"(true|false)","required":false,"type":"string","x-example":true}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":20,"items":[{"agent_version":"23.5.0.0606","app_server_group_id":"e75fef51-bbb7-489c-b4bd-63e0587faa41","app_server_group_name":"TEST-勿动","failed_code":"","failed_reason":"","id":"0a0666f634a54131826bf688058d0bc6","login_user":"XXX@wksapp.huawei.com","machine_name":"APS-CUY5MR45XX","machine_sid":"S-1-5-21-1908276142-124560728-768171367-3204","pre_conn_time":"2024-03-13T03:12:47Z","protocol_type":"HDP","session_stamp":"S-1-5-21-1908276142-124560728-768171367-3204-XXXXX@wksapp.huawei.com-HDP-2","session_state":"AppcInit","session_type":"2","start_time":"2024-03-13T03:12:47Z","tenant_id":"26a0420e9e284569a23f1b2f7d9b5011","vm_ip":"172.*.*.218"}]}},"schema":{"$ref":"#/definitions/ListSessionsRsp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/BaseResp"}},"415":{"description":"请求中提交的资源格式不支持。","schema":{"$ref":"#/definitions/BaseResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/BaseResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询用户会话列表","tags":["Session"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"wks-appmanager-lb","path":"/v1/{project_id}/session/list-sessions","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"","in":"query","name":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"},{"description":"","in":"query","name":"user_name","origin":"request","value":"user_name"},{"description":"","in":"query","name":"query_begin_time","origin":"request","value":"query_begin_time"},{"description":"","in":"query","name":"query_end_time","origin":"request","value":"query_end_time"},{"description":"","in":"query","name":"app_server_group_id","origin":"request","value":"app_server_group_id"},{"description":"","in":"query","name":"vm_ip","origin":"request","value":"vm_ip"},{"description":"","in":"query","name":"machine_name","origin":"request","value":"machine_name"},{"description":"","in":"query","name":"session_state","origin":"request","value":"session_state"},{"description":"","in":"query","name":"is_success","origin":"request","value":"is_success"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/session/list-sessions?limit=10&offset=0&query_end_time=2024-02-28T17:47:51.182Z&query_begin_time=2024-02-26T03:47:51.182Z","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"查询用户会话列表","tags":"使用记录","uri":null,"version":"2.0"}