huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AppSession":{"description":"根据用户名查询当前会话-会话信息。","properties":{"agent_version":{"description":"agent版本。","example":"","readOnly":true,"type":"string"},"app_group_id":{"description":"App组ID。","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"},"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":"","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":"","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":"","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"},"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":"","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"},"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"}}},"ListSessionByUserNameResp":{"description":"根据用户名查询当前会话返回。","properties":{"session_info_list":{"description":"会话信息列表。","items":{"$ref":"#/definitions/AppSession"},"readOnly":true,"type":"array"}},"type":"object"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"cc45f1b3ea40458c8dba6dc5997cb4a6","info_version":"v1","method":"get","name":"ListSessionByUserName","parameters":{},"paths":{"/v1/{project_id}/session/user-session-info":{"get":{"description":"根据用户名查询当前会话。","operationId":"ListSessionByUserName","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"},{"description":"用户名。","in":"query","maxLength":64,"minLength":1,"name":"user_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"session_info_list":[{"agent_version":"21.12.0.11461","client_ip":"10.**.**.239","client_mac":"3c-7c-3f-**-e4-04","client_name":"proven","client_type":"Windows 10 Enterprise","client_version":"22.4.2.12888","end_time":"0001-01-01 00:00:00","failed_code":"WKS.00000000","failed_reason":"success","id":"a7db732e1ad511edaf56fa163ed8e03f","login_user":"zeng**long@wksapp.****huawei.com","machine_sid":"S-1-5-21-1908276142-**4560728-768171367-1358","pre_conn_time":"2022-08-13 07:00:20","protocol_type":"Hdp","session_stamp":"S-1-5-21-1908276142-124560728-768171367-1358-zeng**long@wksapp.****huawei.com-HDP-_1","session_state":"AppcInit","session_type":"1","start_time":"2022-08-13 07:00:20","tenant_id":"26a0420e9e284569a23f1b2f7d9b5011","vm_ip":"172.**.**.26"},{"agent_version":"23.2.0.0314","app_group_id":"587004825166675968","app_name":"HDTransmission,winlogon,HDTerminalExplorer,slui,HDTerminalAssist,fontdrvhost,TSTheme,ChsIME,ctfmon,csrss,HDTerminalSystem,dwm,ChsIME,sihost,HDTerminalDisplay,TabTip32,svchost,svchost,HDTerminalUser,taskhostw,TabTip","app_server_group_id":"fb8a92be-ebc1-4dac-9a4c-1590518d140a","client_ip":"10.*.97.212","client_mac":"3c-7c-3f-**-e4-04","client_name":"proven","client_type":"Windows 10 Enterprise","client_version":"23.2.2.0","end_time":"0001-01-01 00:00:00","failed_code":"WKS.00000000","failed_reason":"success","id":"9d123d5e0f36419c9b345efcd031a92e","login_user":"zeng**long@wksapp.****huawei.com","machine_name":"APS-6NGU98Y4W4","machine_sid":"S-1-5-21-1908276142-***560728-768171367-3006","os_session_id":"2","pre_conn_time":"2023-07-07 03:04:06","protocol_type":"Hdp","session_stamp":"S-1-5-21-1908276142-124560728-768171367-3006-zeng**long@wksapp.****huawei.com-HDP-2","session_state":"AppcInit","session_type":"2","start_time":"2023-07-07 03:04:06","tenant_id":"26a0420e9e284569a23f1b2f7d9b5011","vm_ip":"172.*.*.41"}]}},"schema":{"$ref":"#/definitions/ListSessionByUserNameResp"}},"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/user-session-info","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":"user_name","origin":"request","value":"user_name"}],"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/user-session-info?user_name=user001","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"}